@pgarbe/cdk-ecr-sync 0.5.24 → 0.5.27
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.
- package/.gitattributes +0 -1
- package/.jsii +149 -6
- package/.projenrc.ts +2 -5
- package/CHANGELOG.md +1 -91
- package/lib/ecr-sync.d.ts +4 -22
- package/lib/ecr-sync.js +3 -10
- package/lib/image.d.ts +5 -8
- package/lib/image.js +1 -1
- package/node_modules/aws-sdk/CHANGELOG.md +337 -1
- package/node_modules/aws-sdk/README.md +1 -1
- package/node_modules/aws-sdk/apis/acm-pca-2017-08-22.min.json +56 -25
- package/node_modules/aws-sdk/apis/amplify-2017-07-25.min.json +68 -50
- package/node_modules/aws-sdk/apis/amplifybackend-2020-08-11.min.json +47 -7
- package/node_modules/aws-sdk/apis/amplifyuibuilder-2021-08-11.min.json +144 -65
- package/node_modules/aws-sdk/apis/amplifyuibuilder-2021-08-11.paginators.json +10 -0
- package/node_modules/aws-sdk/apis/apigateway-2015-07-09.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/appconfig-2019-10-09.min.json +3 -1
- package/node_modules/aws-sdk/apis/appconfigdata-2021-11-11.min.json +11 -11
- package/node_modules/aws-sdk/apis/appflow-2020-08-23.min.json +739 -235
- package/node_modules/aws-sdk/apis/appflow-2020-08-23.paginators.json +7 -1
- package/node_modules/aws-sdk/apis/apprunner-2020-05-15.min.json +350 -32
- package/node_modules/aws-sdk/apis/apprunner-2020-05-15.paginators.json +10 -0
- package/node_modules/aws-sdk/apis/appstream-2016-12-01.min.json +9 -0
- package/node_modules/aws-sdk/apis/athena-2017-05-18.min.json +90 -31
- package/node_modules/aws-sdk/apis/auditmanager-2017-07-25.min.json +5 -1
- package/node_modules/aws-sdk/apis/autoscaling-2011-01-01.examples.json +31 -46
- package/node_modules/aws-sdk/apis/autoscaling-2011-01-01.min.json +113 -90
- package/node_modules/aws-sdk/apis/batch-2016-08-10.min.json +143 -94
- package/node_modules/aws-sdk/apis/billingconductor-2021-07-30.examples.json +5 -0
- package/node_modules/aws-sdk/apis/billingconductor-2021-07-30.min.json +1374 -0
- package/node_modules/aws-sdk/apis/billingconductor-2021-07-30.paginators.json +62 -0
- package/node_modules/aws-sdk/apis/billingconductor-2021-07-30.waiters2.json +4 -0
- package/node_modules/aws-sdk/apis/budgets-2016-10-20.min.json +107 -45
- package/node_modules/aws-sdk/apis/budgets-2016-10-20.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/ce-2017-10-25.min.json +206 -125
- package/node_modules/aws-sdk/apis/chime-2018-05-01.min.json +3 -0
- package/node_modules/aws-sdk/apis/chime-sdk-meetings-2021-07-15.min.json +16 -11
- package/node_modules/aws-sdk/apis/cloudformation-2010-05-15.min.json +86 -25
- package/node_modules/aws-sdk/apis/cloudtrail-2013-11-01.min.json +6 -0
- package/node_modules/aws-sdk/apis/codeguru-reviewer-2019-09-19.waiters2.json +14 -2
- package/node_modules/aws-sdk/apis/cognito-idp-2016-04-18.min.json +119 -118
- package/node_modules/aws-sdk/apis/comprehend-2017-11-27.min.json +308 -79
- package/node_modules/aws-sdk/apis/comprehend-2017-11-27.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/config-2014-11-12.min.json +217 -113
- package/node_modules/aws-sdk/apis/connect-2017-08-08.min.json +679 -139
- package/node_modules/aws-sdk/apis/connect-2017-08-08.paginators.json +24 -0
- package/node_modules/aws-sdk/apis/customer-profiles-2020-08-15.min.json +537 -200
- package/node_modules/aws-sdk/apis/databrew-2017-07-25.min.json +41 -38
- package/node_modules/aws-sdk/apis/dataexchange-2017-07-25.min.json +83 -4
- package/node_modules/aws-sdk/apis/datasync-2018-11-09.min.json +142 -73
- package/node_modules/aws-sdk/apis/devops-guru-2020-12-01.min.json +213 -119
- package/node_modules/aws-sdk/apis/docdb-2014-10-31.min.json +10 -2
- package/node_modules/aws-sdk/apis/dynamodb-2012-08-10.min.json +10 -4
- package/node_modules/aws-sdk/apis/ec2-2016-11-15.min.json +1015 -804
- package/node_modules/aws-sdk/apis/ec2-2016-11-15.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/ec2-instance-connect-2018-04-02.min.json +1 -2
- package/node_modules/aws-sdk/apis/ecr-2015-09-21.min.json +14 -11
- package/node_modules/aws-sdk/apis/ecr-2015-09-21.paginators.json +4 -1
- package/node_modules/aws-sdk/apis/ecs-2014-11-13.min.json +10 -0
- package/node_modules/aws-sdk/apis/elasticfilesystem-2015-02-01.min.json +149 -21
- package/node_modules/aws-sdk/apis/es-2015-01-01.min.json +125 -49
- package/node_modules/aws-sdk/apis/eventbridge-2015-10-07.min.json +262 -19
- package/node_modules/aws-sdk/apis/evidently-2021-02-01.min.json +13 -0
- package/node_modules/aws-sdk/apis/finspace-data-2020-07-13.min.json +454 -7
- package/node_modules/aws-sdk/apis/finspace-data-2020-07-13.paginators.json +12 -0
- package/node_modules/aws-sdk/apis/fis-2020-12-01.min.json +229 -31
- package/node_modules/aws-sdk/apis/fis-2020-12-01.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/fms-2018-01-01.min.json +265 -82
- package/node_modules/aws-sdk/apis/fms-2018-01-01.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/frauddetector-2019-11-15.min.json +212 -6
- package/node_modules/aws-sdk/apis/frauddetector-2019-11-15.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/fsx-2018-03-01.min.json +123 -98
- package/node_modules/aws-sdk/apis/fsx-2018-03-01.paginators.json +4 -2
- package/node_modules/aws-sdk/apis/gamesparks-2021-08-17.examples.json +5 -0
- package/node_modules/aws-sdk/apis/gamesparks-2021-08-17.min.json +1363 -0
- package/node_modules/aws-sdk/apis/gamesparks-2021-08-17.paginators.json +46 -0
- package/node_modules/aws-sdk/apis/glue-2017-03-31.min.json +795 -341
- package/node_modules/aws-sdk/apis/glue-2017-03-31.paginators.json +10 -0
- package/node_modules/aws-sdk/apis/grafana-2020-08-18.min.json +117 -19
- package/node_modules/aws-sdk/apis/guardduty-2017-11-28.min.json +352 -77
- package/node_modules/aws-sdk/apis/imagebuilder-2019-12-02.min.json +107 -73
- package/node_modules/aws-sdk/apis/iot-2015-05-28.min.json +274 -202
- package/node_modules/aws-sdk/apis/iot-2015-05-28.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/iot-data-2015-05-28.min.json +1 -1
- package/node_modules/aws-sdk/apis/iotsitewise-2019-12-02.min.json +516 -168
- package/node_modules/aws-sdk/apis/iotsitewise-2019-12-02.paginators.json +14 -0
- package/node_modules/aws-sdk/apis/iottwinmaker-2021-11-29.min.json +75 -68
- package/node_modules/aws-sdk/apis/kafka-2018-11-14.min.json +114 -94
- package/node_modules/aws-sdk/apis/kafkaconnect-2021-09-14.min.json +95 -48
- package/node_modules/aws-sdk/apis/kendra-2019-02-03.min.json +253 -56
- package/node_modules/aws-sdk/apis/keyspaces-2022-02-10.examples.json +5 -0
- package/node_modules/aws-sdk/apis/keyspaces-2022-02-10.min.json +562 -0
- package/node_modules/aws-sdk/apis/keyspaces-2022-02-10.paginators.json +22 -0
- package/node_modules/aws-sdk/apis/keyspaces-2022-02-10.waiters2.json +5 -0
- package/node_modules/aws-sdk/apis/kms-2014-11-01.examples.json +239 -9
- package/node_modules/aws-sdk/apis/kms-2014-11-01.min.json +80 -12
- package/node_modules/aws-sdk/apis/lakeformation-2017-03-31.min.json +0 -1
- package/node_modules/aws-sdk/apis/lambda-2015-03-31.min.json +418 -149
- package/node_modules/aws-sdk/apis/lambda-2015-03-31.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/lambda-2015-03-31.waiters2.json +54 -2
- package/node_modules/aws-sdk/apis/lightsail-2016-11-28.min.json +73 -53
- package/node_modules/aws-sdk/apis/location-2020-11-19.min.json +11 -8
- package/node_modules/aws-sdk/apis/location-2020-11-19.paginators.json +1 -0
- package/node_modules/aws-sdk/apis/lookoutmetrics-2017-07-25.min.json +123 -0
- package/node_modules/aws-sdk/apis/lookoutvision-2020-11-20.min.json +0 -1
- package/node_modules/aws-sdk/apis/macie2-2020-01-01.min.json +36 -29
- package/node_modules/aws-sdk/apis/mediaconnect-2018-11-14.min.json +83 -27
- package/node_modules/aws-sdk/apis/mediaconvert-2017-08-29.min.json +163 -127
- package/node_modules/aws-sdk/apis/medialive-2017-10-14.min.json +222 -154
- package/node_modules/aws-sdk/apis/mediapackage-vod-2018-11-07.min.json +16 -13
- package/node_modules/aws-sdk/apis/mediatailor-2018-04-23.min.json +416 -139
- package/node_modules/aws-sdk/apis/mediatailor-2018-04-23.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/metadata.json +13 -0
- package/node_modules/aws-sdk/apis/meteringmarketplace-2016-01-14.min.json +2 -1
- package/node_modules/aws-sdk/apis/mgn-2020-02-26.min.json +15 -19
- package/node_modules/aws-sdk/apis/models.lex.v2-2020-08-07.min.json +0 -2
- package/node_modules/aws-sdk/apis/monitoring-2010-08-01.min.json +47 -11
- package/node_modules/aws-sdk/apis/opensearch-2021-01-01.min.json +125 -49
- package/node_modules/aws-sdk/apis/organizations-2016-11-28.min.json +77 -62
- package/node_modules/aws-sdk/apis/outposts-2019-12-03.min.json +18 -0
- package/node_modules/aws-sdk/apis/panorama-2019-07-24.min.json +414 -346
- package/node_modules/aws-sdk/apis/personalize-2018-05-22.min.json +189 -42
- package/node_modules/aws-sdk/apis/pinpoint-2016-12-01.min.json +2 -1
- package/node_modules/aws-sdk/apis/pinpoint-sms-voice-v2-2022-03-31.examples.json +5 -0
- package/node_modules/aws-sdk/apis/pinpoint-sms-voice-v2-2022-03-31.min.json +1681 -0
- package/node_modules/aws-sdk/apis/pinpoint-sms-voice-v2-2022-03-31.paginators.json +70 -0
- package/node_modules/aws-sdk/apis/pinpoint-sms-voice-v2-2022-03-31.waiters2.json +5 -0
- package/node_modules/aws-sdk/apis/proton-2020-07-20.min.json +4 -1
- package/node_modules/aws-sdk/apis/quicksight-2018-04-01.min.json +151 -43
- package/node_modules/aws-sdk/apis/rds-2014-10-31.min.json +269 -406
- package/node_modules/aws-sdk/apis/rds-2014-10-31.paginators.json +0 -12
- package/node_modules/aws-sdk/apis/redshift-2012-12-01.min.json +39 -22
- package/node_modules/aws-sdk/apis/robomaker-2018-06-29.min.json +148 -48
- package/node_modules/aws-sdk/apis/route53-recovery-cluster-2019-12-02.min.json +49 -3
- package/node_modules/aws-sdk/apis/route53-recovery-cluster-2019-12-02.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/s3-2006-03-01.examples.json +145 -145
- package/node_modules/aws-sdk/apis/s3-2006-03-01.min.json +772 -239
- package/node_modules/aws-sdk/apis/s3control-2018-08-20.min.json +154 -53
- package/node_modules/aws-sdk/apis/s3outposts-2017-07-25.min.json +64 -24
- package/node_modules/aws-sdk/apis/s3outposts-2017-07-25.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/sagemaker-2017-07-24.min.json +131 -123
- package/node_modules/aws-sdk/apis/secretsmanager-2017-10-17.examples.json +12 -10
- package/node_modules/aws-sdk/apis/secretsmanager-2017-10-17.min.json +15 -10
- package/node_modules/aws-sdk/apis/securityhub-2018-10-26.min.json +388 -302
- package/node_modules/aws-sdk/apis/servicecatalog-2015-12-10.min.json +16 -8
- package/node_modules/aws-sdk/apis/servicecatalog-appregistry-2020-06-24.min.json +8 -2
- package/node_modules/aws-sdk/apis/ssm-2014-11-06.min.json +303 -285
- package/node_modules/aws-sdk/apis/ssm-incidents-2018-05-10.min.json +12 -12
- package/node_modules/aws-sdk/apis/synthetics-2017-10-11.min.json +44 -36
- package/node_modules/aws-sdk/apis/textract-2018-06-27.min.json +82 -45
- package/node_modules/aws-sdk/apis/transcribe-2017-10-26.min.json +50 -40
- package/node_modules/aws-sdk/apis/transfer-2018-11-05.min.json +57 -47
- package/node_modules/aws-sdk/apis/transfer-2018-11-05.paginators.json +27 -8
- package/node_modules/aws-sdk/apis/transfer-2018-11-05.waiters2.json +45 -0
- package/node_modules/aws-sdk/apis/translate-2017-07-01.min.json +19 -18
- package/node_modules/aws-sdk/apis/wafv2-2019-07-29.min.json +221 -105
- package/node_modules/aws-sdk/apis/wisdom-2020-10-19.min.json +60 -19
- package/node_modules/aws-sdk/apis/worklink-2018-09-25.min.json +99 -33
- package/node_modules/aws-sdk/apis/workspaces-2015-04-08.min.json +195 -27
- package/node_modules/aws-sdk/clients/acmpca.d.ts +72 -36
- package/node_modules/aws-sdk/clients/all.d.ts +4 -0
- package/node_modules/aws-sdk/clients/all.js +5 -1
- package/node_modules/aws-sdk/clients/amplify.d.ts +15 -10
- package/node_modules/aws-sdk/clients/amplifybackend.d.ts +48 -12
- package/node_modules/aws-sdk/clients/amplifyuibuilder.d.ts +142 -18
- package/node_modules/aws-sdk/clients/appconfig.d.ts +13 -13
- package/node_modules/aws-sdk/clients/appconfigdata.d.ts +18 -18
- package/node_modules/aws-sdk/clients/appflow.d.ts +691 -4
- package/node_modules/aws-sdk/clients/apprunner.d.ts +371 -20
- package/node_modules/aws-sdk/clients/appstream.d.ts +13 -1
- package/node_modules/aws-sdk/clients/athena.d.ts +92 -8
- package/node_modules/aws-sdk/clients/auditmanager.d.ts +6 -6
- package/node_modules/aws-sdk/clients/autoscaling.d.ts +62 -34
- package/node_modules/aws-sdk/clients/backup.d.ts +24 -24
- package/node_modules/aws-sdk/clients/batch.d.ts +116 -48
- package/node_modules/aws-sdk/clients/billingconductor.d.ts +1554 -0
- package/node_modules/aws-sdk/clients/billingconductor.js +19 -0
- package/node_modules/aws-sdk/clients/budgets.d.ts +107 -48
- package/node_modules/aws-sdk/clients/chime.d.ts +10 -6
- package/node_modules/aws-sdk/clients/chimesdkmeetings.d.ts +31 -5
- package/node_modules/aws-sdk/clients/cloudcontrol.d.ts +22 -22
- package/node_modules/aws-sdk/clients/cloudformation.d.ts +408 -265
- package/node_modules/aws-sdk/clients/cloudtrail.d.ts +17 -9
- package/node_modules/aws-sdk/clients/cloudwatch.d.ts +44 -12
- package/node_modules/aws-sdk/clients/codegurureviewer.d.ts +6 -5
- package/node_modules/aws-sdk/clients/cognitoidentityserviceprovider.d.ts +299 -294
- package/node_modules/aws-sdk/clients/comprehend.d.ts +337 -5
- package/node_modules/aws-sdk/clients/configservice.d.ts +220 -49
- package/node_modules/aws-sdk/clients/connect.d.ts +675 -19
- package/node_modules/aws-sdk/clients/costexplorer.d.ts +105 -19
- package/node_modules/aws-sdk/clients/customerprofiles.d.ts +365 -2
- package/node_modules/aws-sdk/clients/databrew.d.ts +8 -3
- package/node_modules/aws-sdk/clients/dataexchange.d.ts +117 -0
- package/node_modules/aws-sdk/clients/datasync.d.ts +96 -14
- package/node_modules/aws-sdk/clients/devopsguru.d.ts +109 -3
- package/node_modules/aws-sdk/clients/docdb.d.ts +56 -40
- package/node_modules/aws-sdk/clients/dynamodb.d.ts +15 -7
- package/node_modules/aws-sdk/clients/ebs.d.ts +13 -13
- package/node_modules/aws-sdk/clients/ec2.d.ts +371 -105
- package/node_modules/aws-sdk/clients/ec2instanceconnect.d.ts +1 -1
- package/node_modules/aws-sdk/clients/ecr.d.ts +10 -5
- package/node_modules/aws-sdk/clients/ecs.d.ts +51 -35
- package/node_modules/aws-sdk/clients/efs.d.ts +153 -26
- package/node_modules/aws-sdk/clients/eks.d.ts +1 -1
- package/node_modules/aws-sdk/clients/elasticache.d.ts +13 -13
- package/node_modules/aws-sdk/clients/emr.d.ts +14 -14
- package/node_modules/aws-sdk/clients/es.d.ts +97 -0
- package/node_modules/aws-sdk/clients/eventbridge.d.ts +386 -13
- package/node_modules/aws-sdk/clients/evidently.d.ts +11 -3
- package/node_modules/aws-sdk/clients/finspacedata.d.ts +520 -46
- package/node_modules/aws-sdk/clients/fis.d.ts +266 -22
- package/node_modules/aws-sdk/clients/fms.d.ts +333 -3
- package/node_modules/aws-sdk/clients/frauddetector.d.ts +308 -0
- package/node_modules/aws-sdk/clients/fsx.d.ts +105 -69
- package/node_modules/aws-sdk/clients/gamelift.d.ts +216 -216
- package/node_modules/aws-sdk/clients/gamesparks.d.ts +1324 -0
- package/node_modules/aws-sdk/clients/gamesparks.js +18 -0
- package/node_modules/aws-sdk/clients/glue.d.ts +542 -7
- package/node_modules/aws-sdk/clients/grafana.d.ts +81 -5
- package/node_modules/aws-sdk/clients/greengrassv2.d.ts +6 -6
- package/node_modules/aws-sdk/clients/guardduty.d.ts +309 -44
- package/node_modules/aws-sdk/clients/iam.d.ts +10 -10
- package/node_modules/aws-sdk/clients/imagebuilder.d.ts +55 -6
- package/node_modules/aws-sdk/clients/iot.d.ts +76 -13
- package/node_modules/aws-sdk/clients/iotdata.d.ts +7 -7
- package/node_modules/aws-sdk/clients/iotsitewise.d.ts +369 -0
- package/node_modules/aws-sdk/clients/iottwinmaker.d.ts +25 -8
- package/node_modules/aws-sdk/clients/kafka.d.ts +19 -1
- package/node_modules/aws-sdk/clients/kafkaconnect.d.ts +50 -5
- package/node_modules/aws-sdk/clients/kendra.d.ts +400 -134
- package/node_modules/aws-sdk/clients/keyspaces.d.ts +652 -0
- package/node_modules/aws-sdk/clients/keyspaces.js +19 -0
- package/node_modules/aws-sdk/clients/kms.d.ts +205 -115
- package/node_modules/aws-sdk/clients/lakeformation.d.ts +2 -2
- package/node_modules/aws-sdk/clients/lambda.d.ts +316 -13
- package/node_modules/aws-sdk/clients/lexmodelsv2.d.ts +2 -2
- package/node_modules/aws-sdk/clients/lightsail.d.ts +54 -18
- package/node_modules/aws-sdk/clients/location.d.ts +8 -3
- package/node_modules/aws-sdk/clients/lookoutmetrics.d.ts +160 -0
- package/node_modules/aws-sdk/clients/lookoutvision.d.ts +4 -4
- package/node_modules/aws-sdk/clients/macie.d.ts +50 -50
- package/node_modules/aws-sdk/clients/macie2.d.ts +9 -4
- package/node_modules/aws-sdk/clients/marketplacemetering.d.ts +17 -12
- package/node_modules/aws-sdk/clients/mediaconnect.d.ts +47 -0
- package/node_modules/aws-sdk/clients/mediaconvert.d.ts +75 -16
- package/node_modules/aws-sdk/clients/medialive.d.ts +79 -3
- package/node_modules/aws-sdk/clients/mediapackage.d.ts +1 -1
- package/node_modules/aws-sdk/clients/mediapackagevod.d.ts +5 -0
- package/node_modules/aws-sdk/clients/mediatailor.d.ts +327 -12
- package/node_modules/aws-sdk/clients/mgn.d.ts +63 -50
- package/node_modules/aws-sdk/clients/migrationhubrefactorspaces.d.ts +17 -17
- package/node_modules/aws-sdk/clients/opensearch.d.ts +97 -0
- package/node_modules/aws-sdk/clients/organizations.d.ts +144 -129
- package/node_modules/aws-sdk/clients/outposts.d.ts +17 -2
- package/node_modules/aws-sdk/clients/panorama.d.ts +467 -406
- package/node_modules/aws-sdk/clients/personalize.d.ts +191 -25
- package/node_modules/aws-sdk/clients/pi.d.ts +26 -26
- package/node_modules/aws-sdk/clients/pinpoint.d.ts +4 -0
- package/node_modules/aws-sdk/clients/pinpointsmsvoicev2.d.ts +2367 -0
- package/node_modules/aws-sdk/clients/pinpointsmsvoicev2.js +19 -0
- package/node_modules/aws-sdk/clients/polly.d.ts +3 -3
- package/node_modules/aws-sdk/clients/proton.d.ts +105 -101
- package/node_modules/aws-sdk/clients/quicksight.d.ts +114 -12
- package/node_modules/aws-sdk/clients/ram.d.ts +5 -5
- package/node_modules/aws-sdk/clients/rbin.d.ts +41 -41
- package/node_modules/aws-sdk/clients/rds.d.ts +564 -779
- package/node_modules/aws-sdk/clients/redshift.d.ts +52 -18
- package/node_modules/aws-sdk/clients/robomaker.d.ts +37 -36
- package/node_modules/aws-sdk/clients/route53.d.ts +12 -12
- package/node_modules/aws-sdk/clients/route53recoverycluster.d.ts +82 -10
- package/node_modules/aws-sdk/clients/route53recoveryreadiness.d.ts +275 -230
- package/node_modules/aws-sdk/clients/s3.d.ts +731 -200
- package/node_modules/aws-sdk/clients/s3control.d.ts +145 -13
- package/node_modules/aws-sdk/clients/s3outposts.d.ts +50 -18
- package/node_modules/aws-sdk/clients/sagemaker.d.ts +28 -8
- package/node_modules/aws-sdk/clients/secretsmanager.d.ts +77 -63
- package/node_modules/aws-sdk/clients/securityhub.d.ts +151 -1
- package/node_modules/aws-sdk/clients/servicecatalog.d.ts +4 -0
- package/node_modules/aws-sdk/clients/sns.d.ts +2 -2
- package/node_modules/aws-sdk/clients/ssm.d.ts +61 -36
- package/node_modules/aws-sdk/clients/ssmincidents.d.ts +3 -2
- package/node_modules/aws-sdk/clients/storagegateway.d.ts +24 -24
- package/node_modules/aws-sdk/clients/sts.d.ts +3 -3
- package/node_modules/aws-sdk/clients/synthetics.d.ts +18 -7
- package/node_modules/aws-sdk/clients/textract.d.ts +47 -14
- package/node_modules/aws-sdk/clients/timestreamquery.d.ts +1 -1
- package/node_modules/aws-sdk/clients/transcribeservice.d.ts +119 -103
- package/node_modules/aws-sdk/clients/transfer.d.ts +75 -12
- package/node_modules/aws-sdk/clients/transfer.js +1 -0
- package/node_modules/aws-sdk/clients/translate.d.ts +2 -0
- package/node_modules/aws-sdk/clients/wafv2.d.ts +170 -7
- package/node_modules/aws-sdk/clients/wisdom.d.ts +77 -32
- package/node_modules/aws-sdk/clients/workspaces.d.ts +243 -4
- package/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js +44 -32
- package/node_modules/aws-sdk/dist/aws-sdk-react-native.js +1236 -1046
- package/node_modules/aws-sdk/dist/aws-sdk.js +5655 -3021
- package/node_modules/aws-sdk/dist/aws-sdk.min.js +93 -92
- package/node_modules/aws-sdk/lib/config-base.d.ts +1 -0
- package/node_modules/aws-sdk/lib/config_service_placeholders.d.ts +8 -0
- package/node_modules/aws-sdk/lib/core.d.ts +1 -0
- package/node_modules/aws-sdk/lib/core.js +1 -1
- package/node_modules/aws-sdk/lib/credentials/credential_provider_chain.js +1 -0
- package/node_modules/aws-sdk/lib/credentials/ec2_metadata_credentials.d.ts +28 -18
- package/node_modules/aws-sdk/lib/credentials/ec2_metadata_credentials.js +75 -18
- package/node_modules/aws-sdk/lib/credentials/sso_credentials.d.ts +14 -0
- package/node_modules/aws-sdk/lib/credentials/sso_credentials.js +179 -0
- package/node_modules/aws-sdk/lib/dynamodb/document_client.d.ts +9 -1
- package/node_modules/aws-sdk/lib/model/operation.js +6 -1
- package/node_modules/aws-sdk/lib/node_loader.js +2 -0
- package/node_modules/aws-sdk/lib/param_validator.js +2 -1
- package/node_modules/aws-sdk/lib/region_config_data.json +10 -0
- package/node_modules/aws-sdk/lib/services/s3.js +2 -1
- package/node_modules/aws-sdk/package.json +2 -2
- package/node_modules/aws-sdk/scripts/region-checker/allowlist.js +8 -5
- package/node_modules/jmespath/jmespath.js +32 -27
- package/node_modules/jmespath/package.json +2 -7
- package/node_modules/jszip/.github/workflows/pr.yaml +42 -0
- package/node_modules/jszip/CHANGES.md +15 -1
- package/node_modules/jszip/LICENSE.markdown +1 -1
- package/node_modules/jszip/dist/jszip.js +37 -5
- package/node_modules/jszip/dist/jszip.min.js +2 -2
- package/node_modules/jszip/index.d.ts +79 -14
- package/node_modules/jszip/lib/index.js +1 -1
- package/node_modules/jszip/lib/load.js +8 -1
- package/node_modules/jszip/lib/utils.js +27 -2
- package/node_modules/jszip/package.json +9 -8
- package/node_modules/jszip/tsconfig.json +101 -0
- package/package.json +25 -20
- package/releasetag.txt +1 -0
- package/version.txt +1 -0
- package/node_modules/jmespath/.eslintrc +0 -10
- package/node_modules/jmespath/.npmignore +0 -1
- package/node_modules/jmespath/.travis.yml +0 -6
- package/node_modules/jmespath/BASELINE +0 -15
- package/node_modules/jmespath/Gruntfile.js +0 -36
- package/node_modules/jmespath/g.sh +0 -5
- package/node_modules/jmespath/index.html +0 -93
- package/node_modules/jmespath/james.html +0 -7
- package/node_modules/jmespath/l.js +0 -189
- package/node_modules/jmespath/perf.js +0 -33
- package/node_modules/jmespath/reservedWords.json +0 -4
- package/node_modules/jmespath/test/compliance/basic.json +0 -96
- package/node_modules/jmespath/test/compliance/boolean.json +0 -257
- package/node_modules/jmespath/test/compliance/current.json +0 -25
- package/node_modules/jmespath/test/compliance/escape.json +0 -46
- package/node_modules/jmespath/test/compliance/filters.json +0 -468
- package/node_modules/jmespath/test/compliance/functions.json +0 -825
- package/node_modules/jmespath/test/compliance/identifiers.json +0 -1377
- package/node_modules/jmespath/test/compliance/indices.json +0 -346
- package/node_modules/jmespath/test/compliance/literal.json +0 -190
- package/node_modules/jmespath/test/compliance/multiselect.json +0 -393
- package/node_modules/jmespath/test/compliance/pipe.json +0 -131
- package/node_modules/jmespath/test/compliance/slice.json +0 -187
- package/node_modules/jmespath/test/compliance/syntax.json +0 -616
- package/node_modules/jmespath/test/compliance/unicode.json +0 -38
- package/node_modules/jmespath/test/compliance/wildcard.json +0 -460
- package/node_modules/jmespath/test/compliance.js +0 -56
- package/node_modules/jmespath/test/jmespath.js +0 -217
|
@@ -36,11 +36,11 @@ declare class CognitoIdentityServiceProvider extends Service {
|
|
|
36
36
|
*/
|
|
37
37
|
adminConfirmSignUp(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminConfirmSignUpResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminConfirmSignUpResponse, AWSError>;
|
|
38
38
|
/**
|
|
39
|
-
* Creates a new user in the specified user pool. If MessageAction
|
|
39
|
+
* Creates a new user in the specified user pool. If MessageAction isn't set, the default is to send a welcome message via email or phone (SMS). 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. This message is based on a template that you configured in your call to create or update a user pool. This template includes your custom sign-up instructions and placeholders for user name and temporary password. Alternatively, you can call AdminCreateUser with SUPPRESS for the MessageAction parameter, and Amazon Cognito won't send any email. In either case, the user will be in the FORCE_CHANGE_PASSWORD state until they sign in and change their password. AdminCreateUser requires developer credentials.
|
|
40
40
|
*/
|
|
41
41
|
adminCreateUser(params: CognitoIdentityServiceProvider.Types.AdminCreateUserRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminCreateUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminCreateUserResponse, AWSError>;
|
|
42
42
|
/**
|
|
43
|
-
* Creates a new user in the specified user pool. If MessageAction
|
|
43
|
+
* Creates a new user in the specified user pool. If MessageAction isn't set, the default is to send a welcome message via email or phone (SMS). 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. This message is based on a template that you configured in your call to create or update a user pool. This template includes your custom sign-up instructions and placeholders for user name and temporary password. Alternatively, you can call AdminCreateUser with SUPPRESS for the MessageAction parameter, and Amazon Cognito won't send any email. In either case, the user will be in the FORCE_CHANGE_PASSWORD state until they sign in and change their password. AdminCreateUser requires developer credentials.
|
|
44
44
|
*/
|
|
45
45
|
adminCreateUser(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminCreateUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminCreateUserResponse, AWSError>;
|
|
46
46
|
/**
|
|
@@ -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
|
-
*
|
|
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.
|
|
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
|
-
*
|
|
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.
|
|
68
68
|
*/
|
|
69
69
|
adminDisableProviderForUser(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminDisableProviderForUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminDisableProviderForUserResponse, AWSError>;
|
|
70
70
|
/**
|
|
@@ -108,19 +108,19 @@ declare class CognitoIdentityServiceProvider extends Service {
|
|
|
108
108
|
*/
|
|
109
109
|
adminGetUser(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminGetUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminGetUserResponse, AWSError>;
|
|
110
110
|
/**
|
|
111
|
-
* Initiates the authentication flow, as an administrator. This action might generate an SMS text message. Starting June 1, 2021,
|
|
111
|
+
* Initiates the authentication flow, as an administrator. 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. Calling this action requires developer credentials.
|
|
112
112
|
*/
|
|
113
113
|
adminInitiateAuth(params: CognitoIdentityServiceProvider.Types.AdminInitiateAuthRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminInitiateAuthResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminInitiateAuthResponse, AWSError>;
|
|
114
114
|
/**
|
|
115
|
-
* Initiates the authentication flow, as an administrator. This action might generate an SMS text message. Starting June 1, 2021,
|
|
115
|
+
* Initiates the authentication flow, as an administrator. 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. Calling this action requires developer credentials.
|
|
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
|
|
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.
|
|
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
|
|
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.
|
|
124
124
|
*/
|
|
125
125
|
adminLinkProviderForUser(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminLinkProviderForUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminLinkProviderForUserResponse, AWSError>;
|
|
126
126
|
/**
|
|
@@ -140,11 +140,11 @@ declare class CognitoIdentityServiceProvider extends Service {
|
|
|
140
140
|
*/
|
|
141
141
|
adminListGroupsForUser(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminListGroupsForUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminListGroupsForUserResponse, AWSError>;
|
|
142
142
|
/**
|
|
143
|
-
*
|
|
143
|
+
* A history of user activity and any risks detected as part of Amazon Cognito advanced security.
|
|
144
144
|
*/
|
|
145
145
|
adminListUserAuthEvents(params: CognitoIdentityServiceProvider.Types.AdminListUserAuthEventsRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminListUserAuthEventsResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminListUserAuthEventsResponse, AWSError>;
|
|
146
146
|
/**
|
|
147
|
-
*
|
|
147
|
+
* A history of user activity and any risks detected as part of Amazon Cognito advanced security.
|
|
148
148
|
*/
|
|
149
149
|
adminListUserAuthEvents(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminListUserAuthEventsResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminListUserAuthEventsResponse, AWSError>;
|
|
150
150
|
/**
|
|
@@ -156,51 +156,51 @@ declare class CognitoIdentityServiceProvider extends Service {
|
|
|
156
156
|
*/
|
|
157
157
|
adminRemoveUserFromGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
158
158
|
/**
|
|
159
|
-
* Resets the specified user's password in a user pool as an administrator. Works on any user. When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password. This action might generate an SMS text message. Starting June 1, 2021,
|
|
159
|
+
* Resets the specified user's password in a user pool as an administrator. Works on any user. When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password. 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. Calling this action requires developer credentials.
|
|
160
160
|
*/
|
|
161
161
|
adminResetUserPassword(params: CognitoIdentityServiceProvider.Types.AdminResetUserPasswordRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminResetUserPasswordResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminResetUserPasswordResponse, AWSError>;
|
|
162
162
|
/**
|
|
163
|
-
* Resets the specified user's password in a user pool as an administrator. Works on any user. When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password. This action might generate an SMS text message. Starting June 1, 2021,
|
|
163
|
+
* Resets the specified user's password in a user pool as an administrator. Works on any user. When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password. 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. Calling this action requires developer credentials.
|
|
164
164
|
*/
|
|
165
165
|
adminResetUserPassword(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminResetUserPasswordResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminResetUserPasswordResponse, AWSError>;
|
|
166
166
|
/**
|
|
167
|
-
* Responds to an authentication challenge, as an administrator. This action might generate an SMS text message. Starting June 1, 2021,
|
|
167
|
+
* Responds to an authentication challenge, as an administrator. 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. Calling this action requires developer credentials.
|
|
168
168
|
*/
|
|
169
169
|
adminRespondToAuthChallenge(params: CognitoIdentityServiceProvider.Types.AdminRespondToAuthChallengeRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminRespondToAuthChallengeResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminRespondToAuthChallengeResponse, AWSError>;
|
|
170
170
|
/**
|
|
171
|
-
* Responds to an authentication challenge, as an administrator. This action might generate an SMS text message. Starting June 1, 2021,
|
|
171
|
+
* Responds to an authentication challenge, as an administrator. 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. Calling this action requires developer credentials.
|
|
172
172
|
*/
|
|
173
173
|
adminRespondToAuthChallenge(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminRespondToAuthChallengeResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminRespondToAuthChallengeResponse, AWSError>;
|
|
174
174
|
/**
|
|
175
|
-
*
|
|
175
|
+
* The user's multi-factor authentication (MFA) preference, including which MFA options are activated, and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in.
|
|
176
176
|
*/
|
|
177
177
|
adminSetUserMFAPreference(params: CognitoIdentityServiceProvider.Types.AdminSetUserMFAPreferenceRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminSetUserMFAPreferenceResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminSetUserMFAPreferenceResponse, AWSError>;
|
|
178
178
|
/**
|
|
179
|
-
*
|
|
179
|
+
* The user's multi-factor authentication (MFA) preference, including which MFA options are activated, and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in.
|
|
180
180
|
*/
|
|
181
181
|
adminSetUserMFAPreference(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminSetUserMFAPreferenceResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminSetUserMFAPreferenceResponse, AWSError>;
|
|
182
182
|
/**
|
|
183
|
-
* Sets the specified user's password in a user pool as an administrator. Works on any user. The password can be temporary or permanent. If it is temporary, the user status
|
|
183
|
+
* Sets the specified user's password in a user pool as an administrator. Works on any user. The password can be temporary or permanent. If it is temporary, the user status enters the FORCE_CHANGE_PASSWORD state. When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth response will contain the NEW_PASSWORD_REQUIRED challenge. If the user doesn't sign in before it expires, the user won't be able to sign in, and an administrator must reset their password. Once the user has set a new password, or the password is permanent, the user status is set to Confirmed.
|
|
184
184
|
*/
|
|
185
185
|
adminSetUserPassword(params: CognitoIdentityServiceProvider.Types.AdminSetUserPasswordRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminSetUserPasswordResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminSetUserPasswordResponse, AWSError>;
|
|
186
186
|
/**
|
|
187
|
-
* Sets the specified user's password in a user pool as an administrator. Works on any user. The password can be temporary or permanent. If it is temporary, the user status
|
|
187
|
+
* Sets the specified user's password in a user pool as an administrator. Works on any user. The password can be temporary or permanent. If it is temporary, the user status enters the FORCE_CHANGE_PASSWORD state. When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth response will contain the NEW_PASSWORD_REQUIRED challenge. If the user doesn't sign in before it expires, the user won't be able to sign in, and an administrator must reset their password. Once the user has set a new password, or the password is permanent, the user status is set to Confirmed.
|
|
188
188
|
*/
|
|
189
189
|
adminSetUserPassword(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminSetUserPasswordResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminSetUserPasswordResponse, AWSError>;
|
|
190
190
|
/**
|
|
191
|
-
* This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use AdminSetUserMFAPreference instead.
|
|
191
|
+
* This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use AdminSetUserMFAPreference instead.
|
|
192
192
|
*/
|
|
193
193
|
adminSetUserSettings(params: CognitoIdentityServiceProvider.Types.AdminSetUserSettingsRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminSetUserSettingsResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminSetUserSettingsResponse, AWSError>;
|
|
194
194
|
/**
|
|
195
|
-
* This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use AdminSetUserMFAPreference instead.
|
|
195
|
+
* This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use AdminSetUserMFAPreference instead.
|
|
196
196
|
*/
|
|
197
197
|
adminSetUserSettings(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminSetUserSettingsResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminSetUserSettingsResponse, AWSError>;
|
|
198
198
|
/**
|
|
199
|
-
* Provides feedback for an authentication event
|
|
199
|
+
* Provides feedback for an authentication event indicating if it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
|
|
200
200
|
*/
|
|
201
201
|
adminUpdateAuthEventFeedback(params: CognitoIdentityServiceProvider.Types.AdminUpdateAuthEventFeedbackRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminUpdateAuthEventFeedbackResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminUpdateAuthEventFeedbackResponse, AWSError>;
|
|
202
202
|
/**
|
|
203
|
-
* Provides feedback for an authentication event
|
|
203
|
+
* Provides feedback for an authentication event indicating if it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
|
|
204
204
|
*/
|
|
205
205
|
adminUpdateAuthEventFeedback(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminUpdateAuthEventFeedbackResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminUpdateAuthEventFeedbackResponse, AWSError>;
|
|
206
206
|
/**
|
|
@@ -212,27 +212,27 @@ declare class CognitoIdentityServiceProvider extends Service {
|
|
|
212
212
|
*/
|
|
213
213
|
adminUpdateDeviceStatus(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminUpdateDeviceStatusResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminUpdateDeviceStatusResponse, AWSError>;
|
|
214
214
|
/**
|
|
215
|
-
* Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user. For custom attributes, you must prepend the custom: prefix to the attribute name. In addition to updating user attributes, this API can also be used to mark phone and email as verified. This action might generate an SMS text message. Starting June 1, 2021,
|
|
215
|
+
* Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user. For custom attributes, you must prepend the custom: prefix to the attribute name. In addition to updating user attributes, this API can also be used to mark phone and email as verified. 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. Calling this action requires developer credentials.
|
|
216
216
|
*/
|
|
217
217
|
adminUpdateUserAttributes(params: CognitoIdentityServiceProvider.Types.AdminUpdateUserAttributesRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminUpdateUserAttributesResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminUpdateUserAttributesResponse, AWSError>;
|
|
218
218
|
/**
|
|
219
|
-
* Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user. For custom attributes, you must prepend the custom: prefix to the attribute name. In addition to updating user attributes, this API can also be used to mark phone and email as verified. This action might generate an SMS text message. Starting June 1, 2021,
|
|
219
|
+
* Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user. For custom attributes, you must prepend the custom: prefix to the attribute name. In addition to updating user attributes, this API can also be used to mark phone and email as verified. 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. Calling this action requires developer credentials.
|
|
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
|
|
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.
|
|
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
|
|
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.
|
|
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
|
|
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.
|
|
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
|
|
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.
|
|
236
236
|
*/
|
|
237
237
|
associateSoftwareToken(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AssociateSoftwareTokenResponse) => void): Request<CognitoIdentityServiceProvider.Types.AssociateSoftwareTokenResponse, AWSError>;
|
|
238
238
|
/**
|
|
@@ -284,11 +284,11 @@ declare class CognitoIdentityServiceProvider extends Service {
|
|
|
284
284
|
*/
|
|
285
285
|
createIdentityProvider(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateIdentityProviderResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateIdentityProviderResponse, AWSError>;
|
|
286
286
|
/**
|
|
287
|
-
* Creates a new OAuth2.0 resource server and defines custom scopes
|
|
287
|
+
* Creates a new OAuth2.0 resource server and defines custom scopes within it.
|
|
288
288
|
*/
|
|
289
289
|
createResourceServer(params: CognitoIdentityServiceProvider.Types.CreateResourceServerRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateResourceServerResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateResourceServerResponse, AWSError>;
|
|
290
290
|
/**
|
|
291
|
-
* Creates a new OAuth2.0 resource server and defines custom scopes
|
|
291
|
+
* Creates a new OAuth2.0 resource server and defines custom scopes within it.
|
|
292
292
|
*/
|
|
293
293
|
createResourceServer(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateResourceServerResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateResourceServerResponse, AWSError>;
|
|
294
294
|
/**
|
|
@@ -300,19 +300,19 @@ declare class CognitoIdentityServiceProvider extends Service {
|
|
|
300
300
|
*/
|
|
301
301
|
createUserImportJob(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateUserImportJobResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateUserImportJobResponse, AWSError>;
|
|
302
302
|
/**
|
|
303
|
-
* Creates a new Amazon Cognito user pool and sets the password policy for the pool. This action might generate an SMS text message. Starting June 1, 2021,
|
|
303
|
+
* Creates a new Amazon Cognito user pool and sets the password policy for the pool. 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.
|
|
304
304
|
*/
|
|
305
305
|
createUserPool(params: CognitoIdentityServiceProvider.Types.CreateUserPoolRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateUserPoolResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateUserPoolResponse, AWSError>;
|
|
306
306
|
/**
|
|
307
|
-
* Creates a new Amazon Cognito user pool and sets the password policy for the pool. This action might generate an SMS text message. Starting June 1, 2021,
|
|
307
|
+
* Creates a new Amazon Cognito user pool and sets the password policy for the pool. 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.
|
|
308
308
|
*/
|
|
309
309
|
createUserPool(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateUserPoolResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateUserPoolResponse, AWSError>;
|
|
310
310
|
/**
|
|
311
|
-
* Creates the user pool client. When you create a new user pool client, token revocation is automatically
|
|
311
|
+
* Creates the user pool client. When you create a new user pool client, token revocation is automatically activated. For more information about revoking tokens, see RevokeToken.
|
|
312
312
|
*/
|
|
313
313
|
createUserPoolClient(params: CognitoIdentityServiceProvider.Types.CreateUserPoolClientRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateUserPoolClientResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateUserPoolClientResponse, AWSError>;
|
|
314
314
|
/**
|
|
315
|
-
* Creates the user pool client. When you create a new user pool client, token revocation is automatically
|
|
315
|
+
* Creates the user pool client. When you create a new user pool client, token revocation is automatically activated. For more information about revoking tokens, see RevokeToken.
|
|
316
316
|
*/
|
|
317
317
|
createUserPoolClient(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateUserPoolClientResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateUserPoolClientResponse, AWSError>;
|
|
318
318
|
/**
|
|
@@ -452,19 +452,19 @@ declare class CognitoIdentityServiceProvider extends Service {
|
|
|
452
452
|
*/
|
|
453
453
|
forgetDevice(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
454
454
|
/**
|
|
455
|
-
* Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the Username parameter, you can use the username or user alias. The method used to send the confirmation code is sent according to the specified AccountRecoverySetting. For more information, see Recovering User Accounts in the Amazon Cognito Developer Guide. If neither a verified phone number nor a verified email exists, an InvalidParameterException is thrown. To use the confirmation code for resetting the password, call ConfirmForgotPassword.
|
|
455
|
+
* Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the Username parameter, you can use the username or user alias. The method used to send the confirmation code is sent according to the specified AccountRecoverySetting. For more information, see Recovering User Accounts in the Amazon Cognito Developer Guide. If neither a verified phone number nor a verified email exists, an InvalidParameterException is thrown. To use the confirmation code for resetting the password, call ConfirmForgotPassword. 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.
|
|
456
456
|
*/
|
|
457
457
|
forgotPassword(params: CognitoIdentityServiceProvider.Types.ForgotPasswordRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ForgotPasswordResponse) => void): Request<CognitoIdentityServiceProvider.Types.ForgotPasswordResponse, AWSError>;
|
|
458
458
|
/**
|
|
459
|
-
* Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the Username parameter, you can use the username or user alias. The method used to send the confirmation code is sent according to the specified AccountRecoverySetting. For more information, see Recovering User Accounts in the Amazon Cognito Developer Guide. If neither a verified phone number nor a verified email exists, an InvalidParameterException is thrown. To use the confirmation code for resetting the password, call ConfirmForgotPassword.
|
|
459
|
+
* Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the Username parameter, you can use the username or user alias. The method used to send the confirmation code is sent according to the specified AccountRecoverySetting. For more information, see Recovering User Accounts in the Amazon Cognito Developer Guide. If neither a verified phone number nor a verified email exists, an InvalidParameterException is thrown. To use the confirmation code for resetting the password, call ConfirmForgotPassword. 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.
|
|
460
460
|
*/
|
|
461
461
|
forgotPassword(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ForgotPasswordResponse) => void): Request<CognitoIdentityServiceProvider.Types.ForgotPasswordResponse, AWSError>;
|
|
462
462
|
/**
|
|
463
|
-
* Gets the header information for the
|
|
463
|
+
* Gets the header information for the comma-separated value (CSV) file to be used as input for the user import job.
|
|
464
464
|
*/
|
|
465
465
|
getCSVHeader(params: CognitoIdentityServiceProvider.Types.GetCSVHeaderRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetCSVHeaderResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetCSVHeaderResponse, AWSError>;
|
|
466
466
|
/**
|
|
467
|
-
* Gets the header information for the
|
|
467
|
+
* Gets the header information for the comma-separated value (CSV) file to be used as input for the user import job.
|
|
468
468
|
*/
|
|
469
469
|
getCSVHeader(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetCSVHeaderResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetCSVHeaderResponse, AWSError>;
|
|
470
470
|
/**
|
|
@@ -500,11 +500,11 @@ declare class CognitoIdentityServiceProvider extends Service {
|
|
|
500
500
|
*/
|
|
501
501
|
getSigningCertificate(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetSigningCertificateResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetSigningCertificateResponse, AWSError>;
|
|
502
502
|
/**
|
|
503
|
-
* Gets the UI Customization information for a particular app client's app UI, if
|
|
503
|
+
* Gets the user interface (UI) Customization information for a particular app client's app UI, if any such information exists for the client. If nothing is set for the particular client, but there is an existing pool level customization (the app clientId is ALL), then that information is returned. If nothing is present, then an empty shape is returned.
|
|
504
504
|
*/
|
|
505
505
|
getUICustomization(params: CognitoIdentityServiceProvider.Types.GetUICustomizationRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetUICustomizationResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetUICustomizationResponse, AWSError>;
|
|
506
506
|
/**
|
|
507
|
-
* Gets the UI Customization information for a particular app client's app UI, if
|
|
507
|
+
* Gets the user interface (UI) Customization information for a particular app client's app UI, if any such information exists for the client. If nothing is set for the particular client, but there is an existing pool level customization (the app clientId is ALL), then that information is returned. If nothing is present, then an empty shape is returned.
|
|
508
508
|
*/
|
|
509
509
|
getUICustomization(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetUICustomizationResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetUICustomizationResponse, AWSError>;
|
|
510
510
|
/**
|
|
@@ -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,
|
|
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.
|
|
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,
|
|
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.
|
|
524
524
|
*/
|
|
525
525
|
getUserAttributeVerificationCode(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetUserAttributeVerificationCodeResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetUserAttributeVerificationCodeResponse, AWSError>;
|
|
526
526
|
/**
|
|
@@ -532,19 +532,19 @@ 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
|
|
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.
|
|
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
|
|
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.
|
|
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,
|
|
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.
|
|
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,
|
|
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.
|
|
548
548
|
*/
|
|
549
549
|
initiateAuth(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.InitiateAuthResponse) => void): Request<CognitoIdentityServiceProvider.Types.InitiateAuthResponse, AWSError>;
|
|
550
550
|
/**
|
|
@@ -604,11 +604,11 @@ declare class CognitoIdentityServiceProvider extends Service {
|
|
|
604
604
|
*/
|
|
605
605
|
listUserPoolClients(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUserPoolClientsResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListUserPoolClientsResponse, AWSError>;
|
|
606
606
|
/**
|
|
607
|
-
* Lists the user pools associated with an account.
|
|
607
|
+
* Lists the user pools associated with an Amazon Web Services account.
|
|
608
608
|
*/
|
|
609
609
|
listUserPools(params: CognitoIdentityServiceProvider.Types.ListUserPoolsRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUserPoolsResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListUserPoolsResponse, AWSError>;
|
|
610
610
|
/**
|
|
611
|
-
* Lists the user pools associated with an account.
|
|
611
|
+
* Lists the user pools associated with an Amazon Web Services account.
|
|
612
612
|
*/
|
|
613
613
|
listUserPools(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUserPoolsResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListUserPoolsResponse, AWSError>;
|
|
614
614
|
/**
|
|
@@ -628,75 +628,75 @@ declare class CognitoIdentityServiceProvider extends Service {
|
|
|
628
628
|
*/
|
|
629
629
|
listUsersInGroup(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUsersInGroupResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListUsersInGroupResponse, AWSError>;
|
|
630
630
|
/**
|
|
631
|
-
* Resends the confirmation (for confirmation of registration) to a specific user in the user pool. This action might generate an SMS text message. Starting June 1, 2021,
|
|
631
|
+
* Resends the confirmation (for confirmation of registration) to a specific user in the user pool. 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.
|
|
632
632
|
*/
|
|
633
633
|
resendConfirmationCode(params: CognitoIdentityServiceProvider.Types.ResendConfirmationCodeRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ResendConfirmationCodeResponse) => void): Request<CognitoIdentityServiceProvider.Types.ResendConfirmationCodeResponse, AWSError>;
|
|
634
634
|
/**
|
|
635
|
-
* Resends the confirmation (for confirmation of registration) to a specific user in the user pool. This action might generate an SMS text message. Starting June 1, 2021,
|
|
635
|
+
* Resends the confirmation (for confirmation of registration) to a specific user in the user pool. 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.
|
|
636
636
|
*/
|
|
637
637
|
resendConfirmationCode(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ResendConfirmationCodeResponse) => void): Request<CognitoIdentityServiceProvider.Types.ResendConfirmationCodeResponse, AWSError>;
|
|
638
638
|
/**
|
|
639
|
-
* Responds to the authentication challenge. This action might generate an SMS text message. Starting June 1, 2021,
|
|
639
|
+
* Responds to the authentication challenge. 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.
|
|
640
640
|
*/
|
|
641
641
|
respondToAuthChallenge(params: CognitoIdentityServiceProvider.Types.RespondToAuthChallengeRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.RespondToAuthChallengeResponse) => void): Request<CognitoIdentityServiceProvider.Types.RespondToAuthChallengeResponse, AWSError>;
|
|
642
642
|
/**
|
|
643
|
-
* Responds to the authentication challenge. This action might generate an SMS text message. Starting June 1, 2021,
|
|
643
|
+
* Responds to the authentication challenge. 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.
|
|
644
644
|
*/
|
|
645
645
|
respondToAuthChallenge(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.RespondToAuthChallengeResponse) => void): Request<CognitoIdentityServiceProvider.Types.RespondToAuthChallengeResponse, AWSError>;
|
|
646
646
|
/**
|
|
647
|
-
* Revokes all of the access tokens generated by the specified refresh token. After the token is revoked, you can
|
|
647
|
+
* Revokes all of the access tokens generated by the specified refresh token. After the token is revoked, you can't use the revoked token to access Amazon Cognito authenticated APIs.
|
|
648
648
|
*/
|
|
649
649
|
revokeToken(params: CognitoIdentityServiceProvider.Types.RevokeTokenRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.RevokeTokenResponse) => void): Request<CognitoIdentityServiceProvider.Types.RevokeTokenResponse, AWSError>;
|
|
650
650
|
/**
|
|
651
|
-
* Revokes all of the access tokens generated by the specified refresh token. After the token is revoked, you can
|
|
651
|
+
* Revokes all of the access tokens generated by the specified refresh token. After the token is revoked, you can't use the revoked token to access Amazon Cognito authenticated APIs.
|
|
652
652
|
*/
|
|
653
653
|
revokeToken(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.RevokeTokenResponse) => void): Request<CognitoIdentityServiceProvider.Types.RevokeTokenResponse, AWSError>;
|
|
654
654
|
/**
|
|
655
|
-
* Configures actions on detected risks. To delete the risk configuration for UserPoolId or ClientId, pass null values for all four configuration types. To
|
|
655
|
+
* Configures actions on detected risks. To delete the risk configuration for UserPoolId or ClientId, pass null values for all four configuration types. To activate Amazon Cognito advanced security features, update the user pool to include the UserPoolAddOns keyAdvancedSecurityMode.
|
|
656
656
|
*/
|
|
657
657
|
setRiskConfiguration(params: CognitoIdentityServiceProvider.Types.SetRiskConfigurationRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetRiskConfigurationResponse) => void): Request<CognitoIdentityServiceProvider.Types.SetRiskConfigurationResponse, AWSError>;
|
|
658
658
|
/**
|
|
659
|
-
* Configures actions on detected risks. To delete the risk configuration for UserPoolId or ClientId, pass null values for all four configuration types. To
|
|
659
|
+
* Configures actions on detected risks. To delete the risk configuration for UserPoolId or ClientId, pass null values for all four configuration types. To activate Amazon Cognito advanced security features, update the user pool to include the UserPoolAddOns keyAdvancedSecurityMode.
|
|
660
660
|
*/
|
|
661
661
|
setRiskConfiguration(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetRiskConfigurationResponse) => void): Request<CognitoIdentityServiceProvider.Types.SetRiskConfigurationResponse, AWSError>;
|
|
662
662
|
/**
|
|
663
|
-
* Sets the UI customization information for a user pool's built-in app UI. You can specify app UI customization settings for a single client (with a specific clientId) or for all clients (by setting the clientId to ALL). If you specify ALL, the default configuration
|
|
663
|
+
* Sets the user interface (UI) customization information for a user pool's built-in app UI. You can specify app UI customization settings for a single client (with a specific clientId) or for all clients (by setting the clientId to ALL). If you specify ALL, the default configuration is used for every client that has no previously set UI customization. If you specify UI customization settings for a particular client, it will no longer return to the ALL configuration. To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.
|
|
664
664
|
*/
|
|
665
665
|
setUICustomization(params: CognitoIdentityServiceProvider.Types.SetUICustomizationRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetUICustomizationResponse) => void): Request<CognitoIdentityServiceProvider.Types.SetUICustomizationResponse, AWSError>;
|
|
666
666
|
/**
|
|
667
|
-
* Sets the UI customization information for a user pool's built-in app UI. You can specify app UI customization settings for a single client (with a specific clientId) or for all clients (by setting the clientId to ALL). If you specify ALL, the default configuration
|
|
667
|
+
* Sets the user interface (UI) customization information for a user pool's built-in app UI. You can specify app UI customization settings for a single client (with a specific clientId) or for all clients (by setting the clientId to ALL). If you specify ALL, the default configuration is used for every client that has no previously set UI customization. If you specify UI customization settings for a particular client, it will no longer return to the ALL configuration. To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.
|
|
668
668
|
*/
|
|
669
669
|
setUICustomization(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetUICustomizationResponse) => void): Request<CognitoIdentityServiceProvider.Types.SetUICustomizationResponse, AWSError>;
|
|
670
670
|
/**
|
|
671
|
-
* Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are
|
|
671
|
+
* Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are activated and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts unless device tracking is turned on and the device has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.
|
|
672
672
|
*/
|
|
673
673
|
setUserMFAPreference(params: CognitoIdentityServiceProvider.Types.SetUserMFAPreferenceRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetUserMFAPreferenceResponse) => void): Request<CognitoIdentityServiceProvider.Types.SetUserMFAPreferenceResponse, AWSError>;
|
|
674
674
|
/**
|
|
675
|
-
* Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are
|
|
675
|
+
* Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are activated and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts unless device tracking is turned on and the device has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.
|
|
676
676
|
*/
|
|
677
677
|
setUserMFAPreference(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetUserMFAPreferenceResponse) => void): Request<CognitoIdentityServiceProvider.Types.SetUserMFAPreferenceResponse, AWSError>;
|
|
678
678
|
/**
|
|
679
|
-
*
|
|
679
|
+
* Sets the user pool multi-factor authentication (MFA) configuration. 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.
|
|
680
680
|
*/
|
|
681
681
|
setUserPoolMfaConfig(params: CognitoIdentityServiceProvider.Types.SetUserPoolMfaConfigRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetUserPoolMfaConfigResponse) => void): Request<CognitoIdentityServiceProvider.Types.SetUserPoolMfaConfigResponse, AWSError>;
|
|
682
682
|
/**
|
|
683
|
-
*
|
|
683
|
+
* Sets the user pool multi-factor authentication (MFA) configuration. 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.
|
|
684
684
|
*/
|
|
685
685
|
setUserPoolMfaConfig(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetUserPoolMfaConfigResponse) => void): Request<CognitoIdentityServiceProvider.Types.SetUserPoolMfaConfigResponse, AWSError>;
|
|
686
686
|
/**
|
|
687
|
-
* This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use SetUserMFAPreference instead.
|
|
687
|
+
* This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use SetUserMFAPreference instead.
|
|
688
688
|
*/
|
|
689
689
|
setUserSettings(params: CognitoIdentityServiceProvider.Types.SetUserSettingsRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetUserSettingsResponse) => void): Request<CognitoIdentityServiceProvider.Types.SetUserSettingsResponse, AWSError>;
|
|
690
690
|
/**
|
|
691
|
-
* This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use SetUserMFAPreference instead.
|
|
691
|
+
* This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use SetUserMFAPreference instead.
|
|
692
692
|
*/
|
|
693
693
|
setUserSettings(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetUserSettingsResponse) => void): Request<CognitoIdentityServiceProvider.Types.SetUserSettingsResponse, AWSError>;
|
|
694
694
|
/**
|
|
695
|
-
* Registers the user in the specified user pool and creates a user name, password, and user attributes. This action might generate an SMS text message. Starting June 1, 2021,
|
|
695
|
+
* Registers the user in the specified user pool and creates a user name, password, and user attributes. 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.
|
|
696
696
|
*/
|
|
697
697
|
signUp(params: CognitoIdentityServiceProvider.Types.SignUpRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SignUpResponse) => void): Request<CognitoIdentityServiceProvider.Types.SignUpResponse, AWSError>;
|
|
698
698
|
/**
|
|
699
|
-
* Registers the user in the specified user pool and creates a user name, password, and user attributes. This action might generate an SMS text message. Starting June 1, 2021,
|
|
699
|
+
* Registers the user in the specified user pool and creates a user name, password, and user attributes. 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.
|
|
700
700
|
*/
|
|
701
701
|
signUp(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SignUpResponse) => void): Request<CognitoIdentityServiceProvider.Types.SignUpResponse, AWSError>;
|
|
702
702
|
/**
|
|
@@ -716,27 +716,27 @@ declare class CognitoIdentityServiceProvider extends Service {
|
|
|
716
716
|
*/
|
|
717
717
|
stopUserImportJob(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.StopUserImportJobResponse) => void): Request<CognitoIdentityServiceProvider.Types.StopUserImportJobResponse, AWSError>;
|
|
718
718
|
/**
|
|
719
|
-
* Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria. Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of a user pool, one for testing and another for production, you might assign an Environment tag key to both user pools. The value of this key might be Test for one user pool and Production for the other. Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your user pools. In an
|
|
719
|
+
* Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria. Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of a user pool, one for testing and another for production, you might assign an Environment tag key to both user pools. The value of this key might be Test for one user pool, and Production for the other. Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your user pools. In an Identity and Access Management policy, you can constrain permissions for user pools based on specific tags or tag values. You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.
|
|
720
720
|
*/
|
|
721
721
|
tagResource(params: CognitoIdentityServiceProvider.Types.TagResourceRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.TagResourceResponse) => void): Request<CognitoIdentityServiceProvider.Types.TagResourceResponse, AWSError>;
|
|
722
722
|
/**
|
|
723
|
-
* Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria. Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of a user pool, one for testing and another for production, you might assign an Environment tag key to both user pools. The value of this key might be Test for one user pool and Production for the other. Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your user pools. In an
|
|
723
|
+
* Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria. Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of a user pool, one for testing and another for production, you might assign an Environment tag key to both user pools. The value of this key might be Test for one user pool, and Production for the other. Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your user pools. In an Identity and Access Management policy, you can constrain permissions for user pools based on specific tags or tag values. You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.
|
|
724
724
|
*/
|
|
725
725
|
tagResource(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.TagResourceResponse) => void): Request<CognitoIdentityServiceProvider.Types.TagResourceResponse, AWSError>;
|
|
726
726
|
/**
|
|
727
|
-
* Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account
|
|
727
|
+
* Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account.
|
|
728
728
|
*/
|
|
729
729
|
untagResource(params: CognitoIdentityServiceProvider.Types.UntagResourceRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UntagResourceResponse) => void): Request<CognitoIdentityServiceProvider.Types.UntagResourceResponse, AWSError>;
|
|
730
730
|
/**
|
|
731
|
-
* Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account
|
|
731
|
+
* Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account.
|
|
732
732
|
*/
|
|
733
733
|
untagResource(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UntagResourceResponse) => void): Request<CognitoIdentityServiceProvider.Types.UntagResourceResponse, AWSError>;
|
|
734
734
|
/**
|
|
735
|
-
* Provides the feedback for an authentication event whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
|
|
735
|
+
* Provides the feedback for an authentication event, whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
|
|
736
736
|
*/
|
|
737
737
|
updateAuthEventFeedback(params: CognitoIdentityServiceProvider.Types.UpdateAuthEventFeedbackRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateAuthEventFeedbackResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateAuthEventFeedbackResponse, AWSError>;
|
|
738
738
|
/**
|
|
739
|
-
* Provides the feedback for an authentication event whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
|
|
739
|
+
* Provides the feedback for an authentication event, whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
|
|
740
740
|
*/
|
|
741
741
|
updateAuthEventFeedback(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateAuthEventFeedbackResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateAuthEventFeedbackResponse, AWSError>;
|
|
742
742
|
/**
|
|
@@ -764,27 +764,27 @@ declare class CognitoIdentityServiceProvider extends Service {
|
|
|
764
764
|
*/
|
|
765
765
|
updateIdentityProvider(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateIdentityProviderResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateIdentityProviderResponse, AWSError>;
|
|
766
766
|
/**
|
|
767
|
-
* Updates the name and scopes of resource server. All other fields are read-only. If you don't provide a value for an attribute, it
|
|
767
|
+
* Updates the name and scopes of resource server. All other fields are read-only. If you don't provide a value for an attribute, it is set to the default value.
|
|
768
768
|
*/
|
|
769
769
|
updateResourceServer(params: CognitoIdentityServiceProvider.Types.UpdateResourceServerRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateResourceServerResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateResourceServerResponse, AWSError>;
|
|
770
770
|
/**
|
|
771
|
-
* Updates the name and scopes of resource server. All other fields are read-only. If you don't provide a value for an attribute, it
|
|
771
|
+
* Updates the name and scopes of resource server. All other fields are read-only. If you don't provide a value for an attribute, it is set to the default value.
|
|
772
772
|
*/
|
|
773
773
|
updateResourceServer(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateResourceServerResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateResourceServerResponse, AWSError>;
|
|
774
774
|
/**
|
|
775
|
-
* Allows a user to update a specific attribute (one at a time). This action might generate an SMS text message. Starting June 1, 2021,
|
|
775
|
+
* Allows a user to update a specific attribute (one at a time). 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.
|
|
776
776
|
*/
|
|
777
777
|
updateUserAttributes(params: CognitoIdentityServiceProvider.Types.UpdateUserAttributesRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateUserAttributesResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateUserAttributesResponse, AWSError>;
|
|
778
778
|
/**
|
|
779
|
-
* Allows a user to update a specific attribute (one at a time). This action might generate an SMS text message. Starting June 1, 2021,
|
|
779
|
+
* Allows a user to update a specific attribute (one at a time). 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.
|
|
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,
|
|
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,
|
|
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
|
/**
|
|
@@ -796,19 +796,19 @@ declare class CognitoIdentityServiceProvider extends Service {
|
|
|
796
796
|
*/
|
|
797
797
|
updateUserPoolClient(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateUserPoolClientResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateUserPoolClientResponse, AWSError>;
|
|
798
798
|
/**
|
|
799
|
-
* Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool. You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You
|
|
799
|
+
* Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool. You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You can't use it to change the domain for a user pool. A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain. Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically. However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito. When you add your new certificate in ACM, you must choose US East (N. Virginia) as the Amazon Web Services Region. After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain. For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
|
|
800
800
|
*/
|
|
801
801
|
updateUserPoolDomain(params: CognitoIdentityServiceProvider.Types.UpdateUserPoolDomainRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateUserPoolDomainResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateUserPoolDomainResponse, AWSError>;
|
|
802
802
|
/**
|
|
803
|
-
* Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool. You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You
|
|
803
|
+
* Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool. You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You can't use it to change the domain for a user pool. A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain. Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically. However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito. When you add your new certificate in ACM, you must choose US East (N. Virginia) as the Amazon Web Services Region. After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain. For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
|
|
804
804
|
*/
|
|
805
805
|
updateUserPoolDomain(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateUserPoolDomainResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateUserPoolDomainResponse, AWSError>;
|
|
806
806
|
/**
|
|
807
|
-
* Use this API to register a user's entered TOTP code and mark the user's software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both.
|
|
807
|
+
* Use this API to register a user's entered time-based one-time password (TOTP) code and mark the user's software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both.
|
|
808
808
|
*/
|
|
809
809
|
verifySoftwareToken(params: CognitoIdentityServiceProvider.Types.VerifySoftwareTokenRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.VerifySoftwareTokenResponse) => void): Request<CognitoIdentityServiceProvider.Types.VerifySoftwareTokenResponse, AWSError>;
|
|
810
810
|
/**
|
|
811
|
-
* Use this API to register a user's entered TOTP code and mark the user's software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both.
|
|
811
|
+
* Use this API to register a user's entered time-based one-time password (TOTP) code and mark the user's software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both.
|
|
812
812
|
*/
|
|
813
813
|
verifySoftwareToken(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.VerifySoftwareTokenResponse) => void): Request<CognitoIdentityServiceProvider.Types.VerifySoftwareTokenResponse, AWSError>;
|
|
814
814
|
/**
|
|
@@ -836,7 +836,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
836
836
|
*/
|
|
837
837
|
Notify: AccountTakeoverActionNotifyType;
|
|
838
838
|
/**
|
|
839
|
-
* The
|
|
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.
|
|
840
840
|
*/
|
|
841
841
|
EventAction: AccountTakeoverEventActionType;
|
|
842
842
|
}
|
|
@@ -861,7 +861,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
861
861
|
*/
|
|
862
862
|
NotifyConfiguration?: NotifyConfigurationType;
|
|
863
863
|
/**
|
|
864
|
-
* Account takeover risk configuration actions
|
|
864
|
+
* Account takeover risk configuration actions.
|
|
865
865
|
*/
|
|
866
866
|
Actions: AccountTakeoverActionsType;
|
|
867
867
|
}
|
|
@@ -901,7 +901,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
901
901
|
*/
|
|
902
902
|
Username: UsernameType;
|
|
903
903
|
/**
|
|
904
|
-
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
|
|
904
|
+
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the Lambda function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp request. In your function code in Lambda, you can process the ClientMetadata value to enhance your workflow for your specific needs. For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose. Validate the ClientMetadata value. Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
|
|
905
905
|
*/
|
|
906
906
|
ClientMetadata?: ClientMetadataType;
|
|
907
907
|
}
|
|
@@ -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
|
|
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.
|
|
917
917
|
*/
|
|
918
918
|
UnusedAccountValidityDays?: AdminCreateUserUnusedAccountValidityDaysType;
|
|
919
919
|
/**
|
|
@@ -927,35 +927,35 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
927
927
|
*/
|
|
928
928
|
UserPoolId: UserPoolIdType;
|
|
929
929
|
/**
|
|
930
|
-
* The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username
|
|
930
|
+
* The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username can't be changed.
|
|
931
931
|
*/
|
|
932
932
|
Username: UsernameType;
|
|
933
933
|
/**
|
|
934
|
-
* An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (when creating a user pool or in the Attributes tab of the console)
|
|
934
|
+
* An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (when creating a user pool or in the Attributes tab of the console) either you should supply (in your call to AdminCreateUser) or the user should supply (when they sign up in response to your welcome message). For custom attributes, you must prepend the custom: prefix to the attribute name. To send a message inviting the user to sign up, you must specify the user's email address or phone number. You can do this in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools. In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. You can also do this by calling AdminUpdateUserAttributes. email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if "EMAIL" is specified in the DesiredDeliveryMediums parameter. phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if "SMS" is specified in the DesiredDeliveryMediums parameter.
|
|
935
935
|
*/
|
|
936
936
|
UserAttributes?: AttributeListType;
|
|
937
937
|
/**
|
|
938
|
-
* The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain. To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process. The user's validation data
|
|
938
|
+
* The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain. To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process. The user's validation data isn't persisted.
|
|
939
939
|
*/
|
|
940
940
|
ValidationData?: AttributeListType;
|
|
941
941
|
/**
|
|
942
|
-
* The user's temporary password. This password must conform to the password policy that you specified when you created the user pool. The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins. This parameter
|
|
942
|
+
* The user's temporary password. This password must conform to the password policy that you specified when you created the user pool. The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page, along with a new password to be used in all future sign-ins. This parameter isn't required. If you don't specify a value, Amazon Cognito generates one for you. The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter.
|
|
943
943
|
*/
|
|
944
944
|
TemporaryPassword?: PasswordType;
|
|
945
945
|
/**
|
|
946
|
-
* This parameter is only
|
|
946
|
+
* This parameter is used only if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored. If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias. If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.
|
|
947
947
|
*/
|
|
948
948
|
ForceAliasCreation?: ForceAliasCreation;
|
|
949
949
|
/**
|
|
950
|
-
* Set to
|
|
950
|
+
* Set to RESEND to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to SUPPRESS to suppress sending the message. You can specify only one value.
|
|
951
951
|
*/
|
|
952
952
|
MessageAction?: MessageActionType;
|
|
953
953
|
/**
|
|
954
|
-
* Specify "EMAIL" if email will be used to send the welcome message. Specify "SMS" if the phone number will be used. The default value is "SMS".
|
|
954
|
+
* Specify "EMAIL" if email will be used to send the welcome message. Specify "SMS" if the phone number will be used. The default value is "SMS". You can specify more than one value.
|
|
955
955
|
*/
|
|
956
956
|
DesiredDeliveryMediums?: DeliveryMediumListType;
|
|
957
957
|
/**
|
|
958
|
-
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
|
|
958
|
+
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the pre sign-up trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs. For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose. Validate the ClientMetadata value. Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
|
|
959
959
|
*/
|
|
960
960
|
ClientMetadata?: ClientMetadataType;
|
|
961
961
|
}
|
|
@@ -976,7 +976,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
976
976
|
*/
|
|
977
977
|
Username: UsernameType;
|
|
978
978
|
/**
|
|
979
|
-
* An array of strings representing the user attribute names you
|
|
979
|
+
* An array of strings representing the user attribute names you want to delete. For custom attributes, you must prepend the custom: prefix to the attribute name.
|
|
980
980
|
*/
|
|
981
981
|
UserAttributeNames: AttributeNameListType;
|
|
982
982
|
}
|
|
@@ -988,7 +988,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
988
988
|
*/
|
|
989
989
|
UserPoolId: UserPoolIdType;
|
|
990
990
|
/**
|
|
991
|
-
* The user name of the user you
|
|
991
|
+
* The user name of the user you want to delete.
|
|
992
992
|
*/
|
|
993
993
|
Username: UsernameType;
|
|
994
994
|
}
|
|
@@ -1010,7 +1010,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1010
1010
|
*/
|
|
1011
1011
|
UserPoolId: UserPoolIdType;
|
|
1012
1012
|
/**
|
|
1013
|
-
* The user name of the user you
|
|
1013
|
+
* The user name of the user you want to disable.
|
|
1014
1014
|
*/
|
|
1015
1015
|
Username: UsernameType;
|
|
1016
1016
|
}
|
|
@@ -1022,7 +1022,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1022
1022
|
*/
|
|
1023
1023
|
UserPoolId: UserPoolIdType;
|
|
1024
1024
|
/**
|
|
1025
|
-
* The user name of the user you
|
|
1025
|
+
* The user name of the user you want to enable.
|
|
1026
1026
|
*/
|
|
1027
1027
|
Username: UsernameType;
|
|
1028
1028
|
}
|
|
@@ -1068,13 +1068,13 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1068
1068
|
*/
|
|
1069
1069
|
UserPoolId: UserPoolIdType;
|
|
1070
1070
|
/**
|
|
1071
|
-
* The user name of the user you
|
|
1071
|
+
* The user name of the user you want to retrieve.
|
|
1072
1072
|
*/
|
|
1073
1073
|
Username: UsernameType;
|
|
1074
1074
|
}
|
|
1075
1075
|
export interface AdminGetUserResponse {
|
|
1076
1076
|
/**
|
|
1077
|
-
* The user name of the user about whom you
|
|
1077
|
+
* The user name of the user about whom you're receiving information.
|
|
1078
1078
|
*/
|
|
1079
1079
|
Username: UsernameType;
|
|
1080
1080
|
/**
|
|
@@ -1094,11 +1094,11 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1094
1094
|
*/
|
|
1095
1095
|
Enabled?: BooleanType;
|
|
1096
1096
|
/**
|
|
1097
|
-
* The user status. 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.
|
|
1097
|
+
* The user status. 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.
|
|
1098
1098
|
*/
|
|
1099
1099
|
UserStatus?: UserStatusType;
|
|
1100
1100
|
/**
|
|
1101
|
-
* This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about TOTP software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
|
|
1101
|
+
* This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
|
|
1102
1102
|
*/
|
|
1103
1103
|
MFAOptions?: MFAOptionListType;
|
|
1104
1104
|
/**
|
|
@@ -1106,7 +1106,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1106
1106
|
*/
|
|
1107
1107
|
PreferredMfaSetting?: StringType;
|
|
1108
1108
|
/**
|
|
1109
|
-
* The MFA options that are
|
|
1109
|
+
* The MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.
|
|
1110
1110
|
*/
|
|
1111
1111
|
UserMFASettingList?: UserMFASettingListType;
|
|
1112
1112
|
}
|
|
@@ -1120,15 +1120,15 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1120
1120
|
*/
|
|
1121
1121
|
ClientId: ClientIdType;
|
|
1122
1122
|
/**
|
|
1123
|
-
* The authentication flow for this call to
|
|
1123
|
+
* The authentication flow for this call to run. The API action will depend on this value. For example: REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens. USER_SRP_AUTH will take in USERNAME and SRP_A and return the Secure Remote Password (SRP) protocol variables to be used for next challenge execution. ADMIN_USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return 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. ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client. ADMIN_USER_PASSWORD_AUTH: Admin-based user password authentication. This replaces the ADMIN_NO_SRP_AUTH authentication flow. In this flow, Amazon Cognito receives the password in the request instead of using the SRP process to verify passwords.
|
|
1124
1124
|
*/
|
|
1125
1125
|
AuthFlow: AuthFlowType;
|
|
1126
1126
|
/**
|
|
1127
|
-
* The authentication parameters. These are inputs corresponding to the AuthFlow that you
|
|
1127
|
+
* The authentication parameters. These are inputs corresponding to the AuthFlow that you're invoking. The required values depend on the value of AuthFlow: For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY. For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY. For ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), PASSWORD (required), DEVICE_KEY. For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).
|
|
1128
1128
|
*/
|
|
1129
1129
|
AuthParameters?: AuthParametersType;
|
|
1130
1130
|
/**
|
|
1131
|
-
* A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers. You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminInitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers: Pre signup Pre authentication User migration When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminInitiateAuth request. In your function code in Lambda, you can process the validationData value to enhance your workflow for your specific needs. When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it
|
|
1131
|
+
* A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers. You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminInitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers: Pre signup Pre authentication User migration When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminInitiateAuth request. In your function code in Lambda, you can process the validationData value to enhance your workflow for your specific needs. When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input: Post authentication Custom message Pre token generation Create auth challenge Define auth challenge Verify auth challenge For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose. Validate the ClientMetadata value. Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
|
|
1132
1132
|
*/
|
|
1133
1133
|
ClientMetadata?: ClientMetadataType;
|
|
1134
1134
|
/**
|
|
@@ -1142,19 +1142,19 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1142
1142
|
}
|
|
1143
1143
|
export interface AdminInitiateAuthResponse {
|
|
1144
1144
|
/**
|
|
1145
|
-
* The name of the challenge
|
|
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.
|
|
1146
1146
|
*/
|
|
1147
1147
|
ChallengeName?: ChallengeNameType;
|
|
1148
1148
|
/**
|
|
1149
|
-
* The session
|
|
1149
|
+
* The session that should be passed both ways in challenge-response calls to the service. If AdminInitiateAuth or AdminRespondToAuthChallenge API call determines that the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next AdminRespondToAuthChallenge API call.
|
|
1150
1150
|
*/
|
|
1151
1151
|
Session?: SessionType;
|
|
1152
1152
|
/**
|
|
1153
|
-
* The challenge parameters. These are returned to you in the AdminInitiateAuth response if you
|
|
1153
|
+
* The challenge parameters. These are returned to you in the AdminInitiateAuth response if you must pass another challenge. The responses in this parameter should be used to compute inputs to the next call (AdminRespondToAuthChallenge). All challenges require USERNAME and SECRET_HASH (if applicable). The value of the USER_ID_FOR_SRP attribute is the user's actual username, not an alias (such as email address or phone number), even if you specified an alias in your call to AdminInitiateAuth. This happens because, in the AdminRespondToAuthChallenge API ChallengeResponses, the USERNAME attribute can't be an alias.
|
|
1154
1154
|
*/
|
|
1155
1155
|
ChallengeParameters?: ChallengeParametersType;
|
|
1156
1156
|
/**
|
|
1157
|
-
* The result of the authentication response. This is only returned if the caller
|
|
1157
|
+
* The result of the authentication response. This is only returned if the caller doesn't need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, ChallengeName, ChallengeParameters, and Session are returned.
|
|
1158
1158
|
*/
|
|
1159
1159
|
AuthenticationResult?: AuthenticationResultType;
|
|
1160
1160
|
}
|
|
@@ -1164,11 +1164,11 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1164
1164
|
*/
|
|
1165
1165
|
UserPoolId: StringType;
|
|
1166
1166
|
/**
|
|
1167
|
-
* The existing user in the user pool
|
|
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.
|
|
1168
1168
|
*/
|
|
1169
1169
|
DestinationUser: ProviderUserIdentifierType;
|
|
1170
1170
|
/**
|
|
1171
|
-
* An external identity provider account for a user who
|
|
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.
|
|
1172
1172
|
*/
|
|
1173
1173
|
SourceUser: ProviderUserIdentifierType;
|
|
1174
1174
|
}
|
|
@@ -1278,11 +1278,11 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1278
1278
|
*/
|
|
1279
1279
|
UserPoolId: UserPoolIdType;
|
|
1280
1280
|
/**
|
|
1281
|
-
* The user name of the user whose password you
|
|
1281
|
+
* The user name of the user whose password you want to reset.
|
|
1282
1282
|
*/
|
|
1283
1283
|
Username: UsernameType;
|
|
1284
1284
|
/**
|
|
1285
|
-
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
|
|
1285
|
+
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs. For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose. Validate the ClientMetadata value. Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
|
|
1286
1286
|
*/
|
|
1287
1287
|
ClientMetadata?: ClientMetadataType;
|
|
1288
1288
|
}
|
|
@@ -1302,11 +1302,11 @@ 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).
|
|
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.
|
|
1306
1306
|
*/
|
|
1307
1307
|
ChallengeResponses?: ChallengeResponsesType;
|
|
1308
1308
|
/**
|
|
1309
|
-
* The session
|
|
1309
|
+
* The session that should be passed both ways in challenge-response calls to the service. If an InitiateAuth or RespondToAuthChallenge API call determines that the caller must pass another challenge, it returns a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
|
|
1310
1310
|
*/
|
|
1311
1311
|
Session?: SessionType;
|
|
1312
1312
|
/**
|
|
@@ -1318,7 +1318,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1318
1318
|
*/
|
|
1319
1319
|
ContextData?: ContextDataType;
|
|
1320
1320
|
/**
|
|
1321
|
-
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
|
|
1321
|
+
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that you have assigned to the following triggers: pre sign-up custom message post authentication user migration pre token generation define auth challenge create auth challenge verify auth challenge response When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute that provides the data that you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs. For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose. Validate the ClientMetadata value. Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
|
|
1322
1322
|
*/
|
|
1323
1323
|
ClientMetadata?: ClientMetadataType;
|
|
1324
1324
|
}
|
|
@@ -1328,7 +1328,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1328
1328
|
*/
|
|
1329
1329
|
ChallengeName?: ChallengeNameType;
|
|
1330
1330
|
/**
|
|
1331
|
-
* The session
|
|
1331
|
+
* The session that should be passed both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
|
|
1332
1332
|
*/
|
|
1333
1333
|
Session?: SessionType;
|
|
1334
1334
|
/**
|
|
@@ -1366,7 +1366,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1366
1366
|
*/
|
|
1367
1367
|
UserPoolId: UserPoolIdType;
|
|
1368
1368
|
/**
|
|
1369
|
-
* The user name of the user whose password you
|
|
1369
|
+
* The user name of the user whose password you want to set.
|
|
1370
1370
|
*/
|
|
1371
1371
|
Username: UsernameType;
|
|
1372
1372
|
/**
|
|
@@ -1382,11 +1382,11 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1382
1382
|
}
|
|
1383
1383
|
export interface AdminSetUserSettingsRequest {
|
|
1384
1384
|
/**
|
|
1385
|
-
* The ID of the user pool that contains the user
|
|
1385
|
+
* The ID of the user pool that contains the user whose options you're setting.
|
|
1386
1386
|
*/
|
|
1387
1387
|
UserPoolId: UserPoolIdType;
|
|
1388
1388
|
/**
|
|
1389
|
-
* The user name of the user
|
|
1389
|
+
* The user name of the user whose options you're setting.
|
|
1390
1390
|
*/
|
|
1391
1391
|
Username: UsernameType;
|
|
1392
1392
|
/**
|
|
@@ -1450,7 +1450,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1450
1450
|
*/
|
|
1451
1451
|
UserAttributes: AttributeListType;
|
|
1452
1452
|
/**
|
|
1453
|
-
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
|
|
1453
|
+
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs. For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose. Validate the ClientMetadata value. Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
|
|
1454
1454
|
*/
|
|
1455
1455
|
ClientMetadata?: ClientMetadataType;
|
|
1456
1456
|
}
|
|
@@ -1477,11 +1477,11 @@ 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
|
|
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.
|
|
1481
1481
|
*/
|
|
1482
1482
|
ApplicationArn?: ArnType;
|
|
1483
1483
|
/**
|
|
1484
|
-
* The ARN of an
|
|
1484
|
+
* The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
|
|
1485
1485
|
*/
|
|
1486
1486
|
RoleArn?: ArnType;
|
|
1487
1487
|
/**
|
|
@@ -1506,17 +1506,17 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1506
1506
|
*/
|
|
1507
1507
|
AccessToken?: TokenModelType;
|
|
1508
1508
|
/**
|
|
1509
|
-
* The session
|
|
1509
|
+
* The session that should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.
|
|
1510
1510
|
*/
|
|
1511
1511
|
Session?: SessionType;
|
|
1512
1512
|
}
|
|
1513
1513
|
export interface AssociateSoftwareTokenResponse {
|
|
1514
1514
|
/**
|
|
1515
|
-
* A unique generated shared secret code that is used in the TOTP algorithm to generate a one
|
|
1515
|
+
* A unique generated shared secret code that is used in the time-based one-time password (TOTP) algorithm to generate a one-time code.
|
|
1516
1516
|
*/
|
|
1517
1517
|
SecretCode?: SecretCodeType;
|
|
1518
1518
|
/**
|
|
1519
|
-
* The session
|
|
1519
|
+
* The session that should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.
|
|
1520
1520
|
*/
|
|
1521
1521
|
Session?: SessionType;
|
|
1522
1522
|
}
|
|
@@ -1563,7 +1563,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1563
1563
|
*/
|
|
1564
1564
|
ChallengeResponses?: ChallengeResponseListType;
|
|
1565
1565
|
/**
|
|
1566
|
-
* The user context data captured at the time of an event request.
|
|
1566
|
+
* The user context data captured at the time of an event request. This value provides additional information about the client from which event the request is received.
|
|
1567
1567
|
*/
|
|
1568
1568
|
EventContextData?: EventContextDataType;
|
|
1569
1569
|
/**
|
|
@@ -1612,7 +1612,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1612
1612
|
export type ChallengeResponseListType = ChallengeResponseType[];
|
|
1613
1613
|
export interface ChallengeResponseType {
|
|
1614
1614
|
/**
|
|
1615
|
-
* The challenge name
|
|
1615
|
+
* The challenge name.
|
|
1616
1616
|
*/
|
|
1617
1617
|
ChallengeName?: ChallengeName;
|
|
1618
1618
|
/**
|
|
@@ -1696,7 +1696,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1696
1696
|
}
|
|
1697
1697
|
export interface ConfirmDeviceResponse {
|
|
1698
1698
|
/**
|
|
1699
|
-
* Indicates whether the user confirmation
|
|
1699
|
+
* Indicates whether the user confirmation must confirm the device response.
|
|
1700
1700
|
*/
|
|
1701
1701
|
UserConfirmationNecessary?: BooleanType;
|
|
1702
1702
|
}
|
|
@@ -1730,7 +1730,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1730
1730
|
*/
|
|
1731
1731
|
UserContextData?: UserContextDataType;
|
|
1732
1732
|
/**
|
|
1733
|
-
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
|
|
1733
|
+
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs. For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose. Validate the ClientMetadata value. Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
|
|
1734
1734
|
*/
|
|
1735
1735
|
ClientMetadata?: ClientMetadataType;
|
|
1736
1736
|
}
|
|
@@ -1746,7 +1746,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1746
1746
|
*/
|
|
1747
1747
|
SecretHash?: SecretHashType;
|
|
1748
1748
|
/**
|
|
1749
|
-
* The user name of the user whose registration you
|
|
1749
|
+
* The user name of the user whose registration you want to confirm.
|
|
1750
1750
|
*/
|
|
1751
1751
|
Username: UsernameType;
|
|
1752
1752
|
/**
|
|
@@ -1766,7 +1766,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1766
1766
|
*/
|
|
1767
1767
|
UserContextData?: UserContextDataType;
|
|
1768
1768
|
/**
|
|
1769
|
-
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
|
|
1769
|
+
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs. For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose. Validate the ClientMetadata value. Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
|
|
1770
1770
|
*/
|
|
1771
1771
|
ClientMetadata?: ClientMetadataType;
|
|
1772
1772
|
}
|
|
@@ -1783,7 +1783,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1783
1783
|
*/
|
|
1784
1784
|
ServerName: StringType;
|
|
1785
1785
|
/**
|
|
1786
|
-
* Your server path where this API is invoked.
|
|
1786
|
+
* Your server path where this API is invoked.
|
|
1787
1787
|
*/
|
|
1788
1788
|
ServerPath: StringType;
|
|
1789
1789
|
/**
|
|
@@ -1791,7 +1791,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1791
1791
|
*/
|
|
1792
1792
|
HttpHeaders: HttpHeaderList;
|
|
1793
1793
|
/**
|
|
1794
|
-
* Encoded data containing device fingerprinting details
|
|
1794
|
+
* Encoded data containing device fingerprinting details collected using the Amazon Cognito context data collection library.
|
|
1795
1795
|
*/
|
|
1796
1796
|
EncodedData?: StringType;
|
|
1797
1797
|
}
|
|
@@ -1809,11 +1809,11 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1809
1809
|
*/
|
|
1810
1810
|
Description?: DescriptionType;
|
|
1811
1811
|
/**
|
|
1812
|
-
* The role ARN for the group.
|
|
1812
|
+
* The role Amazon Resource Name (ARN) for the group.
|
|
1813
1813
|
*/
|
|
1814
1814
|
RoleArn?: ArnType;
|
|
1815
1815
|
/**
|
|
1816
|
-
* A
|
|
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
1817
|
*/
|
|
1818
1818
|
Precedence?: PrecedenceType;
|
|
1819
1819
|
}
|
|
@@ -1837,7 +1837,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1837
1837
|
*/
|
|
1838
1838
|
ProviderType: IdentityProviderTypeType;
|
|
1839
1839
|
/**
|
|
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 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 For SAML providers: MetadataFile OR MetadataURL IDPSignout optional
|
|
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
1841
|
*/
|
|
1842
1842
|
ProviderDetails: ProviderDetailsType;
|
|
1843
1843
|
/**
|
|
@@ -1861,7 +1861,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1861
1861
|
*/
|
|
1862
1862
|
UserPoolId: UserPoolIdType;
|
|
1863
1863
|
/**
|
|
1864
|
-
* A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located
|
|
1864
|
+
* A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located, such as https://my-weather-api.example.com.
|
|
1865
1865
|
*/
|
|
1866
1866
|
Identifier: ResourceServerIdentifierType;
|
|
1867
1867
|
/**
|
|
@@ -1869,7 +1869,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1869
1869
|
*/
|
|
1870
1870
|
Name: ResourceServerNameType;
|
|
1871
1871
|
/**
|
|
1872
|
-
* A list of scopes. Each scope is map
|
|
1872
|
+
* A list of scopes. Each scope is a key-value map with the keys name and description.
|
|
1873
1873
|
*/
|
|
1874
1874
|
Scopes?: ResourceServerScopeListType;
|
|
1875
1875
|
}
|
|
@@ -1889,7 +1889,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1889
1889
|
*/
|
|
1890
1890
|
UserPoolId: UserPoolIdType;
|
|
1891
1891
|
/**
|
|
1892
|
-
* The role ARN for the Amazon CloudWatch Logging role for the user import job.
|
|
1892
|
+
* The role ARN for the Amazon CloudWatch Logs Logging role for the user import job.
|
|
1893
1893
|
*/
|
|
1894
1894
|
CloudWatchLogsRoleArn: ArnType;
|
|
1895
1895
|
}
|
|
@@ -1913,19 +1913,19 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1913
1913
|
*/
|
|
1914
1914
|
GenerateSecret?: GenerateSecret;
|
|
1915
1915
|
/**
|
|
1916
|
-
* The time limit, in days, after which the refresh token is no longer valid and
|
|
1916
|
+
* The time limit, in days, after which the refresh token is no longer valid and can't be used.
|
|
1917
1917
|
*/
|
|
1918
1918
|
RefreshTokenValidity?: RefreshTokenValidityType;
|
|
1919
1919
|
/**
|
|
1920
|
-
* The time limit, between 5 minutes and 1 day, after which the access token is no longer valid and
|
|
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
1921
|
*/
|
|
1922
1922
|
AccessTokenValidity?: AccessTokenValidityType;
|
|
1923
1923
|
/**
|
|
1924
|
-
* The time limit, between 5 minutes and 1 day, after which the
|
|
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
1925
|
*/
|
|
1926
1926
|
IdTokenValidity?: IdTokenValidityType;
|
|
1927
1927
|
/**
|
|
1928
|
-
* The units in which the validity times are represented
|
|
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
1929
|
*/
|
|
1930
1930
|
TokenValidityUnits?: TokenValidityUnitsType;
|
|
1931
1931
|
/**
|
|
@@ -1933,11 +1933,11 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1933
1933
|
*/
|
|
1934
1934
|
ReadAttributes?: ClientPermissionListType;
|
|
1935
1935
|
/**
|
|
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
|
|
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
1937
|
*/
|
|
1938
1938
|
WriteAttributes?: ClientPermissionListType;
|
|
1939
1939
|
/**
|
|
1940
|
-
* The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are
|
|
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
1941
|
*/
|
|
1942
1942
|
ExplicitAuthFlows?: ExplicitAuthFlowsListType;
|
|
1943
1943
|
/**
|
|
@@ -1965,19 +1965,19 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1965
1965
|
*/
|
|
1966
1966
|
AllowedOAuthScopes?: ScopeListType;
|
|
1967
1967
|
/**
|
|
1968
|
-
* Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
|
|
1968
|
+
* Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
|
|
1969
1969
|
*/
|
|
1970
1970
|
AllowedOAuthFlowsUserPoolClient?: BooleanType;
|
|
1971
1971
|
/**
|
|
1972
|
-
* The
|
|
1972
|
+
* The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign. In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
|
|
1973
1973
|
*/
|
|
1974
1974
|
AnalyticsConfiguration?: AnalyticsConfigurationType;
|
|
1975
1975
|
/**
|
|
1976
|
-
*
|
|
1976
|
+
* 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 early behavior of Amazon Cognito where user existence related errors aren't prevented.
|
|
1977
1977
|
*/
|
|
1978
1978
|
PreventUserExistenceErrors?: PreventUserExistenceErrorTypes;
|
|
1979
1979
|
/**
|
|
1980
|
-
*
|
|
1980
|
+
* 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
1981
|
*/
|
|
1982
1982
|
EnableTokenRevocation?: WrappedBooleanType;
|
|
1983
1983
|
}
|
|
@@ -1989,7 +1989,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
1989
1989
|
}
|
|
1990
1990
|
export interface CreateUserPoolDomainRequest {
|
|
1991
1991
|
/**
|
|
1992
|
-
* The domain string.
|
|
1992
|
+
* The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.
|
|
1993
1993
|
*/
|
|
1994
1994
|
Domain: DomainType;
|
|
1995
1995
|
/**
|
|
@@ -2017,7 +2017,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
2017
2017
|
*/
|
|
2018
2018
|
Policies?: UserPoolPolicyType;
|
|
2019
2019
|
/**
|
|
2020
|
-
* The Lambda trigger configuration information for the new user pool. In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you
|
|
2020
|
+
* The Lambda trigger configuration information for the new user pool. In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function. For more information on using the Lambda API to add permission, see AddPermission . For adding permission using the CLI, see add-permission .
|
|
2021
2021
|
*/
|
|
2022
2022
|
LambdaConfig?: LambdaConfigType;
|
|
2023
2023
|
/**
|
|
@@ -2029,7 +2029,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
2029
2029
|
*/
|
|
2030
2030
|
AliasAttributes?: AliasAttributesListType;
|
|
2031
2031
|
/**
|
|
2032
|
-
* Specifies whether email
|
|
2032
|
+
* Specifies whether a user can use an email address or phone number as a username when they sign up.
|
|
2033
2033
|
*/
|
|
2034
2034
|
UsernameAttributes?: UsernameAttributesListType;
|
|
2035
2035
|
/**
|
|
@@ -2061,11 +2061,11 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
2061
2061
|
*/
|
|
2062
2062
|
DeviceConfiguration?: DeviceConfigurationType;
|
|
2063
2063
|
/**
|
|
2064
|
-
* The email configuration.
|
|
2064
|
+
* The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.
|
|
2065
2065
|
*/
|
|
2066
2066
|
EmailConfiguration?: EmailConfigurationType;
|
|
2067
2067
|
/**
|
|
2068
|
-
* The SMS configuration.
|
|
2068
|
+
* The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
|
|
2069
2069
|
*/
|
|
2070
2070
|
SmsConfiguration?: SmsConfigurationType;
|
|
2071
2071
|
/**
|
|
@@ -2081,15 +2081,15 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
2081
2081
|
*/
|
|
2082
2082
|
Schema?: SchemaAttributesListType;
|
|
2083
2083
|
/**
|
|
2084
|
-
*
|
|
2084
|
+
* Enables advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
|
|
2085
2085
|
*/
|
|
2086
2086
|
UserPoolAddOns?: UserPoolAddOnsType;
|
|
2087
2087
|
/**
|
|
2088
|
-
*
|
|
2088
|
+
* Case sensitivity on the username input for the selected sign-in option. For example, when case sensitivity is set to False, users can sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.
|
|
2089
2089
|
*/
|
|
2090
2090
|
UsernameConfiguration?: UsernameConfigurationType;
|
|
2091
2091
|
/**
|
|
2092
|
-
*
|
|
2092
|
+
* The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
|
|
2093
2093
|
*/
|
|
2094
2094
|
AccountRecoverySetting?: AccountRecoverySettingType;
|
|
2095
2095
|
}
|
|
@@ -2109,22 +2109,22 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
2109
2109
|
}
|
|
2110
2110
|
export interface CustomEmailLambdaVersionConfigType {
|
|
2111
2111
|
/**
|
|
2112
|
-
*
|
|
2112
|
+
* Signature of the "request" attribute in the "event" information Amazon Cognito passes to your custom email Lambda function. The only supported value is V1_0.
|
|
2113
2113
|
*/
|
|
2114
2114
|
LambdaVersion: CustomEmailSenderLambdaVersionType;
|
|
2115
2115
|
/**
|
|
2116
|
-
* The
|
|
2116
|
+
* The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send email notifications to users.
|
|
2117
2117
|
*/
|
|
2118
2118
|
LambdaArn: ArnType;
|
|
2119
2119
|
}
|
|
2120
2120
|
export type CustomEmailSenderLambdaVersionType = "V1_0"|string;
|
|
2121
2121
|
export interface CustomSMSLambdaVersionConfigType {
|
|
2122
2122
|
/**
|
|
2123
|
-
*
|
|
2123
|
+
* Signature of the "request" attribute in the "event" information that Amazon Cognito passes to your custom SMS Lambda function. The only supported value is V1_0.
|
|
2124
2124
|
*/
|
|
2125
2125
|
LambdaVersion: CustomSMSSenderLambdaVersionType;
|
|
2126
2126
|
/**
|
|
2127
|
-
* The
|
|
2127
|
+
* The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send SMS notifications to users.
|
|
2128
2128
|
*/
|
|
2129
2129
|
LambdaArn: ArnType;
|
|
2130
2130
|
}
|
|
@@ -2163,7 +2163,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
2163
2163
|
}
|
|
2164
2164
|
export interface DeleteUserAttributesRequest {
|
|
2165
2165
|
/**
|
|
2166
|
-
* An array of strings representing the user attribute names you
|
|
2166
|
+
* An array of strings representing the user attribute names you want to delete. For custom attributes, you must prependattach the custom: prefix to the front of the attribute name.
|
|
2167
2167
|
*/
|
|
2168
2168
|
UserAttributeNames: AttributeNameListType;
|
|
2169
2169
|
/**
|
|
@@ -2185,7 +2185,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
2185
2185
|
}
|
|
2186
2186
|
export interface DeleteUserPoolDomainRequest {
|
|
2187
2187
|
/**
|
|
2188
|
-
* The domain string.
|
|
2188
|
+
* The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.
|
|
2189
2189
|
*/
|
|
2190
2190
|
Domain: DomainType;
|
|
2191
2191
|
/**
|
|
@@ -2291,7 +2291,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
2291
2291
|
}
|
|
2292
2292
|
export interface DescribeUserPoolDomainRequest {
|
|
2293
2293
|
/**
|
|
2294
|
-
* The domain string.
|
|
2294
|
+
* The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.
|
|
2295
2295
|
*/
|
|
2296
2296
|
Domain: DomainType;
|
|
2297
2297
|
}
|
|
@@ -2316,11 +2316,11 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
2316
2316
|
export type DescriptionType = string;
|
|
2317
2317
|
export interface DeviceConfigurationType {
|
|
2318
2318
|
/**
|
|
2319
|
-
*
|
|
2319
|
+
* When true, device authentication can replace SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA). Users that sign in with devices that have not been confirmed or remembered will still have to provide a second factor, whether or not ChallengeRequiredOnNewDevice is true, when your user pool requires MFA.
|
|
2320
2320
|
*/
|
|
2321
2321
|
ChallengeRequiredOnNewDevice?: BooleanType;
|
|
2322
2322
|
/**
|
|
2323
|
-
*
|
|
2323
|
+
* When true, users can opt in to remembering their device. Your app code must use callback functions to return the user's choice.
|
|
2324
2324
|
*/
|
|
2325
2325
|
DeviceOnlyRememberedOnUserPrompt?: BooleanType;
|
|
2326
2326
|
}
|
|
@@ -2356,7 +2356,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
2356
2356
|
*/
|
|
2357
2357
|
DeviceLastModifiedDate?: DateType;
|
|
2358
2358
|
/**
|
|
2359
|
-
* The date
|
|
2359
|
+
* The date when the device was last authenticated.
|
|
2360
2360
|
*/
|
|
2361
2361
|
DeviceLastAuthenticatedDate?: DateType;
|
|
2362
2362
|
}
|
|
@@ -2366,19 +2366,19 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
2366
2366
|
*/
|
|
2367
2367
|
UserPoolId?: UserPoolIdType;
|
|
2368
2368
|
/**
|
|
2369
|
-
* The
|
|
2369
|
+
* The Amazon Web Services ID for the user pool owner.
|
|
2370
2370
|
*/
|
|
2371
2371
|
AWSAccountId?: AWSAccountIdType;
|
|
2372
2372
|
/**
|
|
2373
|
-
* The domain string.
|
|
2373
|
+
* The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.
|
|
2374
2374
|
*/
|
|
2375
2375
|
Domain?: DomainType;
|
|
2376
2376
|
/**
|
|
2377
|
-
* The S3 bucket where the static files for this domain are stored.
|
|
2377
|
+
* The Amazon S3 bucket where the static files for this domain are stored.
|
|
2378
2378
|
*/
|
|
2379
2379
|
S3Bucket?: S3BucketType;
|
|
2380
2380
|
/**
|
|
2381
|
-
* The ARN of the CloudFront distribution.
|
|
2381
|
+
* The Amazon Resource Name (ARN) of the Amazon CloudFront distribution.
|
|
2382
2382
|
*/
|
|
2383
2383
|
CloudFrontDistribution?: StringType;
|
|
2384
2384
|
/**
|
|
@@ -2400,23 +2400,23 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
2400
2400
|
export type EmailAddressType = string;
|
|
2401
2401
|
export interface EmailConfigurationType {
|
|
2402
2402
|
/**
|
|
2403
|
-
* The
|
|
2403
|
+
* The ARN of a verified email address in Amazon SES. Amazon Cognito uses this email address in one of the following ways, depending on the value that you specify for the EmailSendingAccount parameter: If you specify COGNITO_DEFAULT, Amazon Cognito uses this address as the custom FROM address when it emails your users using its built-in email account. If you specify DEVELOPER, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf. The Region value of the SourceArn parameter must indicate a supported Amazon Web Services Region of your user pool. Typically, the Region in the SourceArn and the user pool Region are the same. For more information, see Amazon SES email configuration regions in the Amazon Cognito Developer Guide.
|
|
2404
2404
|
*/
|
|
2405
2405
|
SourceArn?: ArnType;
|
|
2406
2406
|
/**
|
|
2407
|
-
* The destination to which the receiver of the email should reply
|
|
2407
|
+
* The destination to which the receiver of the email should reply.
|
|
2408
2408
|
*/
|
|
2409
2409
|
ReplyToEmailAddress?: EmailAddressType;
|
|
2410
2410
|
/**
|
|
2411
|
-
* Specifies whether Amazon Cognito
|
|
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.
|
|
2412
2412
|
*/
|
|
2413
2413
|
EmailSendingAccount?: EmailSendingAccountType;
|
|
2414
2414
|
/**
|
|
2415
|
-
*
|
|
2415
|
+
* Either the sender’s email address or the sender’s name with their email address. For example, testuser@example.com or Test User <testuser@example.com>. This address appears before the body of the email.
|
|
2416
2416
|
*/
|
|
2417
2417
|
From?: StringType;
|
|
2418
2418
|
/**
|
|
2419
|
-
* The set of configuration rules that can be applied to emails sent using Amazon
|
|
2419
|
+
* The set of configuration rules that can be applied to emails sent using Amazon Simple Email Service. A configuration set is applied to an email by including a reference to the configuration set in the headers of the email. Once applied, all of the rules in that configuration set are applied to the email. Configuration sets can be used to apply the following types of rules to emails: Event publishing Amazon Simple Email Service can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other Amazon Web Services services such as and Amazon CloudWatch IP pool management When leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.
|
|
2420
2420
|
*/
|
|
2421
2421
|
ConfigurationSet?: SESConfigurationSet;
|
|
2422
2422
|
}
|
|
@@ -2518,7 +2518,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
2518
2518
|
*/
|
|
2519
2519
|
AnalyticsMetadata?: AnalyticsMetadataType;
|
|
2520
2520
|
/**
|
|
2521
|
-
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
|
|
2521
|
+
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and user migration. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ForgotPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs. For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose. Validate the ClientMetadata value. Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
|
|
2522
2522
|
*/
|
|
2523
2523
|
ClientMetadata?: ClientMetadataType;
|
|
2524
2524
|
}
|
|
@@ -2541,7 +2541,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
2541
2541
|
*/
|
|
2542
2542
|
UserPoolId?: UserPoolIdType;
|
|
2543
2543
|
/**
|
|
2544
|
-
* The header information
|
|
2544
|
+
* The header information of the CSV file for the user import job.
|
|
2545
2545
|
*/
|
|
2546
2546
|
CSVHeader?: ListOfStringTypes;
|
|
2547
2547
|
}
|
|
@@ -2631,7 +2631,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
2631
2631
|
*/
|
|
2632
2632
|
AttributeName: AttributeNameType;
|
|
2633
2633
|
/**
|
|
2634
|
-
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
|
|
2634
|
+
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning Lambda functions to user pool triggers. When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs. For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose. Validate the ClientMetadata value. Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
|
|
2635
2635
|
*/
|
|
2636
2636
|
ClientMetadata?: ClientMetadataType;
|
|
2637
2637
|
}
|
|
@@ -2657,7 +2657,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
2657
2657
|
*/
|
|
2658
2658
|
SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType;
|
|
2659
2659
|
/**
|
|
2660
|
-
* The multi-factor (MFA) configuration. Valid values include: OFF MFA
|
|
2660
|
+
* The multi-factor (MFA) configuration. Valid values include: OFF MFA won't be used for any users. ON MFA is required for all users to sign in. OPTIONAL MFA will be required only for individual users who have an MFA factor activated.
|
|
2661
2661
|
*/
|
|
2662
2662
|
MfaConfiguration?: UserPoolMfaType;
|
|
2663
2663
|
}
|
|
@@ -2669,7 +2669,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
2669
2669
|
}
|
|
2670
2670
|
export interface GetUserResponse {
|
|
2671
2671
|
/**
|
|
2672
|
-
* The user name of the user you
|
|
2672
|
+
* The user name of the user you want to retrieve from the get user request.
|
|
2673
2673
|
*/
|
|
2674
2674
|
Username: UsernameType;
|
|
2675
2675
|
/**
|
|
@@ -2677,7 +2677,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
2677
2677
|
*/
|
|
2678
2678
|
UserAttributes: AttributeListType;
|
|
2679
2679
|
/**
|
|
2680
|
-
* This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about TOTP software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
|
|
2680
|
+
* This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
|
|
2681
2681
|
*/
|
|
2682
2682
|
MFAOptions?: MFAOptionListType;
|
|
2683
2683
|
/**
|
|
@@ -2685,7 +2685,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
2685
2685
|
*/
|
|
2686
2686
|
PreferredMfaSetting?: StringType;
|
|
2687
2687
|
/**
|
|
2688
|
-
* The MFA options that are
|
|
2688
|
+
* The MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.
|
|
2689
2689
|
*/
|
|
2690
2690
|
UserMFASettingList?: UserMFASettingListType;
|
|
2691
2691
|
}
|
|
@@ -2713,11 +2713,11 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
2713
2713
|
*/
|
|
2714
2714
|
Description?: DescriptionType;
|
|
2715
2715
|
/**
|
|
2716
|
-
* The role ARN for the group.
|
|
2716
|
+
* The role Amazon Resource Name (ARN) for the group.
|
|
2717
2717
|
*/
|
|
2718
2718
|
RoleArn?: ArnType;
|
|
2719
2719
|
/**
|
|
2720
|
-
* A
|
|
2720
|
+
* 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.
|
|
2721
2721
|
*/
|
|
2722
2722
|
Precedence?: PrecedenceType;
|
|
2723
2723
|
/**
|
|
@@ -2732,7 +2732,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
2732
2732
|
export type HexStringType = string;
|
|
2733
2733
|
export interface HttpHeader {
|
|
2734
2734
|
/**
|
|
2735
|
-
* The header name
|
|
2735
|
+
* The header name.
|
|
2736
2736
|
*/
|
|
2737
2737
|
headerName?: StringType;
|
|
2738
2738
|
/**
|
|
@@ -2756,7 +2756,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
2756
2756
|
*/
|
|
2757
2757
|
ProviderType?: IdentityProviderTypeType;
|
|
2758
2758
|
/**
|
|
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 For SAML providers: MetadataFile
|
|
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
|
|
2760
2760
|
*/
|
|
2761
2761
|
ProviderDetails?: ProviderDetailsType;
|
|
2762
2762
|
/**
|
|
@@ -2783,15 +2783,15 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
2783
2783
|
export type ImageUrlType = string;
|
|
2784
2784
|
export interface InitiateAuthRequest {
|
|
2785
2785
|
/**
|
|
2786
|
-
* The authentication flow for this call to
|
|
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.
|
|
2787
2787
|
*/
|
|
2788
2788
|
AuthFlow: AuthFlowType;
|
|
2789
2789
|
/**
|
|
2790
|
-
* The authentication parameters. These are inputs corresponding to the AuthFlow that you
|
|
2790
|
+
* The authentication parameters. These are inputs corresponding to the AuthFlow that you're invoking. The required values depend on the value of AuthFlow: For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY. For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY. For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).
|
|
2791
2791
|
*/
|
|
2792
2792
|
AuthParameters?: AuthParametersType;
|
|
2793
2793
|
/**
|
|
2794
|
-
* A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers. You create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers: Pre signup Pre authentication User migration When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your InitiateAuth request. In your function code in Lambda, you can process the validationData value to enhance your workflow for your specific needs. When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it
|
|
2794
|
+
* A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers. You create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers: Pre signup Pre authentication User migration When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your InitiateAuth request. In your function code in Lambda, you can process the validationData value to enhance your workflow for your specific needs. When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input: Post authentication Custom message Pre token generation Create auth challenge Define auth challenge Verify auth challenge For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose. Validate the ClientMetadata value. Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
|
|
2795
2795
|
*/
|
|
2796
2796
|
ClientMetadata?: ClientMetadataType;
|
|
2797
2797
|
/**
|
|
@@ -2809,19 +2809,19 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
2809
2809
|
}
|
|
2810
2810
|
export interface InitiateAuthResponse {
|
|
2811
2811
|
/**
|
|
2812
|
-
* The name of the challenge
|
|
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.
|
|
2813
2813
|
*/
|
|
2814
2814
|
ChallengeName?: ChallengeNameType;
|
|
2815
2815
|
/**
|
|
2816
|
-
* The session
|
|
2816
|
+
* The session that should pass both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
|
|
2817
2817
|
*/
|
|
2818
2818
|
Session?: SessionType;
|
|
2819
2819
|
/**
|
|
2820
|
-
* The challenge parameters. These are returned
|
|
2820
|
+
* The challenge parameters. These are returned in the InitiateAuth response if you must pass another challenge. The responses in this parameter should be used to compute inputs to the next call (RespondToAuthChallenge). All challenges require USERNAME and SECRET_HASH (if applicable).
|
|
2821
2821
|
*/
|
|
2822
2822
|
ChallengeParameters?: ChallengeParametersType;
|
|
2823
2823
|
/**
|
|
2824
|
-
* The result of the authentication response. This is only returned if the caller
|
|
2824
|
+
* The result of the authentication response. This result is only returned if the caller doesn't need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, ChallengeName, ChallengeParameters, and Session are returned.
|
|
2825
2825
|
*/
|
|
2826
2826
|
AuthenticationResult?: AuthenticationResultType;
|
|
2827
2827
|
}
|
|
@@ -2876,7 +2876,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
2876
2876
|
*/
|
|
2877
2877
|
CustomEmailSender?: CustomEmailLambdaVersionConfigType;
|
|
2878
2878
|
/**
|
|
2879
|
-
* The Amazon Resource Name of
|
|
2879
|
+
* The Amazon Resource Name (ARN) of an KMS key. Amazon Cognito uses the key to encrypt codes and temporary passwords sent to CustomEmailSender and CustomSMSSender.
|
|
2880
2880
|
*/
|
|
2881
2881
|
KMSKeyID?: ArnType;
|
|
2882
2882
|
}
|
|
@@ -3105,7 +3105,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
3105
3105
|
*/
|
|
3106
3106
|
PaginationToken?: SearchPaginationTokenType;
|
|
3107
3107
|
/**
|
|
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
|
|
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.
|
|
3109
3109
|
*/
|
|
3110
3110
|
Filter?: UserFilterType;
|
|
3111
3111
|
}
|
|
@@ -3159,7 +3159,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
3159
3159
|
}
|
|
3160
3160
|
export interface NotifyConfigurationType {
|
|
3161
3161
|
/**
|
|
3162
|
-
* The email address that is sending the email.
|
|
3162
|
+
* The email address that is sending the email. The address must be either individually verified with Amazon Simple Email Service, or from a domain that has been verified with Amazon SES.
|
|
3163
3163
|
*/
|
|
3164
3164
|
From?: StringType;
|
|
3165
3165
|
/**
|
|
@@ -3167,7 +3167,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
3167
3167
|
*/
|
|
3168
3168
|
ReplyTo?: StringType;
|
|
3169
3169
|
/**
|
|
3170
|
-
* The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy.
|
|
3170
|
+
* The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy. This identity permits Amazon Cognito to send for the email address specified in the From parameter.
|
|
3171
3171
|
*/
|
|
3172
3172
|
SourceArn: ArnType;
|
|
3173
3173
|
/**
|
|
@@ -3179,21 +3179,21 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
3179
3179
|
*/
|
|
3180
3180
|
NoActionEmail?: NotifyEmailType;
|
|
3181
3181
|
/**
|
|
3182
|
-
* The MFA email template used when MFA is challenged as part of a detected risk.
|
|
3182
|
+
* The multi-factor authentication (MFA) email template used when MFA is challenged as part of a detected risk.
|
|
3183
3183
|
*/
|
|
3184
3184
|
MfaEmail?: NotifyEmailType;
|
|
3185
3185
|
}
|
|
3186
3186
|
export interface NotifyEmailType {
|
|
3187
3187
|
/**
|
|
3188
|
-
* The subject.
|
|
3188
|
+
* The email subject.
|
|
3189
3189
|
*/
|
|
3190
3190
|
Subject: EmailNotificationSubjectType;
|
|
3191
3191
|
/**
|
|
3192
|
-
* The HTML body.
|
|
3192
|
+
* The email HTML body.
|
|
3193
3193
|
*/
|
|
3194
3194
|
HtmlBody?: EmailNotificationBodyType;
|
|
3195
3195
|
/**
|
|
3196
|
-
* The text body.
|
|
3196
|
+
* The email text body.
|
|
3197
3197
|
*/
|
|
3198
3198
|
TextBody?: EmailNotificationBodyType;
|
|
3199
3199
|
}
|
|
@@ -3214,7 +3214,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
3214
3214
|
export type PasswordPolicyMinLengthType = number;
|
|
3215
3215
|
export interface PasswordPolicyType {
|
|
3216
3216
|
/**
|
|
3217
|
-
* The minimum length of the password policy that you have set.
|
|
3217
|
+
* The minimum length of the password in the policy that you have set. This value can't be less than 6.
|
|
3218
3218
|
*/
|
|
3219
3219
|
MinimumLength?: PasswordPolicyMinLengthType;
|
|
3220
3220
|
/**
|
|
@@ -3234,7 +3234,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
3234
3234
|
*/
|
|
3235
3235
|
RequireSymbols?: BooleanType;
|
|
3236
3236
|
/**
|
|
3237
|
-
*
|
|
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.
|
|
3238
3238
|
*/
|
|
3239
3239
|
TemporaryPasswordValidityDays?: TemporaryPasswordValidityDaysType;
|
|
3240
3240
|
}
|
|
@@ -3267,15 +3267,15 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
3267
3267
|
export type ProviderNameTypeV1 = string;
|
|
3268
3268
|
export interface ProviderUserIdentifierType {
|
|
3269
3269
|
/**
|
|
3270
|
-
* The name of the provider,
|
|
3270
|
+
* The name of the provider, such as Facebook, Google, or Login with Amazon.
|
|
3271
3271
|
*/
|
|
3272
3272
|
ProviderName?: ProviderNameType;
|
|
3273
3273
|
/**
|
|
3274
|
-
* The name of the provider attribute to link to,
|
|
3274
|
+
* The name of the provider attribute to link to, such as NameID.
|
|
3275
3275
|
*/
|
|
3276
3276
|
ProviderAttributeName?: StringType;
|
|
3277
3277
|
/**
|
|
3278
|
-
* The value of the provider attribute to link to,
|
|
3278
|
+
* The value of the provider attribute to link to, such as xxxxx_account.
|
|
3279
3279
|
*/
|
|
3280
3280
|
ProviderAttributeValue?: StringType;
|
|
3281
3281
|
}
|
|
@@ -3290,12 +3290,13 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
3290
3290
|
*/
|
|
3291
3291
|
Priority: PriorityType;
|
|
3292
3292
|
/**
|
|
3293
|
-
*
|
|
3293
|
+
* The recovery method for a user.
|
|
3294
3294
|
*/
|
|
3295
3295
|
Name: RecoveryOptionNameType;
|
|
3296
3296
|
}
|
|
3297
3297
|
export type RedirectUrlType = string;
|
|
3298
3298
|
export type RefreshTokenValidityType = number;
|
|
3299
|
+
export type RegionCodeType = string;
|
|
3299
3300
|
export interface ResendConfirmationCodeRequest {
|
|
3300
3301
|
/**
|
|
3301
3302
|
* The ID of the client associated with the user pool.
|
|
@@ -3310,7 +3311,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
3310
3311
|
*/
|
|
3311
3312
|
UserContextData?: UserContextDataType;
|
|
3312
3313
|
/**
|
|
3313
|
-
* The
|
|
3314
|
+
* The username attribute of the user to whom you want to resend a confirmation code.
|
|
3314
3315
|
*/
|
|
3315
3316
|
Username: UsernameType;
|
|
3316
3317
|
/**
|
|
@@ -3318,7 +3319,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
3318
3319
|
*/
|
|
3319
3320
|
AnalyticsMetadata?: AnalyticsMetadataType;
|
|
3320
3321
|
/**
|
|
3321
|
-
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
|
|
3322
|
+
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ResendConfirmationCode API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ResendConfirmationCode request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs. For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose. Validate the ClientMetadata value. Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
|
|
3322
3323
|
*/
|
|
3323
3324
|
ClientMetadata?: ClientMetadataType;
|
|
3324
3325
|
}
|
|
@@ -3368,15 +3369,15 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
3368
3369
|
*/
|
|
3369
3370
|
ClientId: ClientIdType;
|
|
3370
3371
|
/**
|
|
3371
|
-
* The challenge name. For more information, see InitiateAuth. ADMIN_NO_SRP_AUTH
|
|
3372
|
+
* The challenge name. For more information, see InitiateAuth. ADMIN_NO_SRP_AUTH isn't a valid value.
|
|
3372
3373
|
*/
|
|
3373
3374
|
ChallengeName: ChallengeNameType;
|
|
3374
3375
|
/**
|
|
3375
|
-
* The session
|
|
3376
|
+
* The session that should be passed both ways in challenge-response calls to the service. If InitiateAuth or RespondToAuthChallenge API call determines that the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
|
|
3376
3377
|
*/
|
|
3377
3378
|
Session?: SessionType;
|
|
3378
3379
|
/**
|
|
3379
|
-
* 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 inputs
|
|
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.
|
|
3380
3381
|
*/
|
|
3381
3382
|
ChallengeResponses?: ChallengeResponsesType;
|
|
3382
3383
|
/**
|
|
@@ -3388,7 +3389,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
3388
3389
|
*/
|
|
3389
3390
|
UserContextData?: UserContextDataType;
|
|
3390
3391
|
/**
|
|
3391
|
-
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
|
|
3392
|
+
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning Lambda functions to user pool triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, define auth challenge, create auth challenge, and verify auth challenge. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs. For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose. Validate the ClientMetadata value. Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
|
|
3392
3393
|
*/
|
|
3393
3394
|
ClientMetadata?: ClientMetadataType;
|
|
3394
3395
|
}
|
|
@@ -3398,7 +3399,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
3398
3399
|
*/
|
|
3399
3400
|
ChallengeName?: ChallengeNameType;
|
|
3400
3401
|
/**
|
|
3401
|
-
* The session
|
|
3402
|
+
* The session that should be passed both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
|
|
3402
3403
|
*/
|
|
3403
3404
|
Session?: SessionType;
|
|
3404
3405
|
/**
|
|
@@ -3412,7 +3413,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
3412
3413
|
}
|
|
3413
3414
|
export interface RevokeTokenRequest {
|
|
3414
3415
|
/**
|
|
3415
|
-
* The token that you want to revoke.
|
|
3416
|
+
* The refresh token that you want to revoke.
|
|
3416
3417
|
*/
|
|
3417
3418
|
Token: TokenModelType;
|
|
3418
3419
|
/**
|
|
@@ -3436,11 +3437,11 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
3436
3437
|
*/
|
|
3437
3438
|
ClientId?: ClientIdType;
|
|
3438
3439
|
/**
|
|
3439
|
-
* The compromised credentials risk configuration object including the EventFilter and the EventAction
|
|
3440
|
+
* The compromised credentials risk configuration object, including the EventFilter and the EventAction.
|
|
3440
3441
|
*/
|
|
3441
3442
|
CompromisedCredentialsRiskConfiguration?: CompromisedCredentialsRiskConfigurationType;
|
|
3442
3443
|
/**
|
|
3443
|
-
* The account takeover risk configuration object including the NotifyConfiguration object and Actions to take
|
|
3444
|
+
* The account takeover risk configuration object, including the NotifyConfiguration object and Actions to take if there is an account takeover.
|
|
3444
3445
|
*/
|
|
3445
3446
|
AccountTakeoverRiskConfiguration?: AccountTakeoverRiskConfigurationType;
|
|
3446
3447
|
/**
|
|
@@ -3455,11 +3456,11 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
3455
3456
|
export type RiskDecisionType = "NoRisk"|"AccountTakeover"|"Block"|string;
|
|
3456
3457
|
export interface RiskExceptionConfigurationType {
|
|
3457
3458
|
/**
|
|
3458
|
-
* Overrides the risk decision to always block the pre-authentication requests. The IP range is in CIDR notation
|
|
3459
|
+
* Overrides the risk decision to always block the pre-authentication requests. The IP range is in CIDR notation, a compact representation of an IP address and its routing prefix.
|
|
3459
3460
|
*/
|
|
3460
3461
|
BlockedIPRangeList?: BlockedIPRangeListType;
|
|
3461
3462
|
/**
|
|
3462
|
-
* Risk detection
|
|
3463
|
+
* Risk detection isn't performed on the IP addresses in this range list. The IP range is in CIDR notation.
|
|
3463
3464
|
*/
|
|
3464
3465
|
SkippedIPRangeList?: SkippedIPRangeListType;
|
|
3465
3466
|
}
|
|
@@ -3468,7 +3469,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
3468
3469
|
export type SESConfigurationSet = string;
|
|
3469
3470
|
export interface SMSMfaSettingsType {
|
|
3470
3471
|
/**
|
|
3471
|
-
* Specifies whether SMS text message MFA is
|
|
3472
|
+
* Specifies whether SMS text message MFA is activated. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted.
|
|
3472
3473
|
*/
|
|
3473
3474
|
Enabled?: BooleanType;
|
|
3474
3475
|
/**
|
|
@@ -3486,15 +3487,15 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
3486
3487
|
*/
|
|
3487
3488
|
AttributeDataType?: AttributeDataType;
|
|
3488
3489
|
/**
|
|
3489
|
-
*
|
|
3490
|
+
* You should use WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead of using DeveloperOnlyAttribute. Specifies whether the attribute type is developer only. This attribute can only be modified by an administrator. Users won't be able to modify this attribute using their access token. For example, DeveloperOnlyAttribute can be modified using AdminUpdateUserAttributes but can't be updated using UpdateUserAttributes.
|
|
3490
3491
|
*/
|
|
3491
3492
|
DeveloperOnlyAttribute?: BooleanType;
|
|
3492
3493
|
/**
|
|
3493
|
-
* Specifies whether the value of the attribute can be changed. For any user pool attribute that
|
|
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.
|
|
3494
3495
|
*/
|
|
3495
3496
|
Mutable?: BooleanType;
|
|
3496
3497
|
/**
|
|
3497
|
-
* Specifies whether a user pool attribute is required. If the attribute is required and the user
|
|
3498
|
+
* Specifies whether a user pool attribute is required. If the attribute is required and the user doesn't provide a value, registration or sign-in will fail.
|
|
3498
3499
|
*/
|
|
3499
3500
|
Required?: BooleanType;
|
|
3500
3501
|
/**
|
|
@@ -3520,7 +3521,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
3520
3521
|
*/
|
|
3521
3522
|
UserPoolId: UserPoolIdType;
|
|
3522
3523
|
/**
|
|
3523
|
-
* The app client ID. If ClientId is null, then the risk configuration is mapped to userPoolId. When the client ID is null, the same risk configuration is applied to all the clients in the userPool. Otherwise, ClientId is mapped to the client. When the client ID
|
|
3524
|
+
* The app client ID. If ClientId is null, then the risk configuration is mapped to userPoolId. When the client ID is null, the same risk configuration is applied to all the clients in the userPool. Otherwise, ClientId is mapped to the client. When the client ID isn't null, the user pool configuration is overridden and the risk configuration for the client is used instead.
|
|
3524
3525
|
*/
|
|
3525
3526
|
ClientId?: ClientIdType;
|
|
3526
3527
|
/**
|
|
@@ -3596,7 +3597,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
3596
3597
|
*/
|
|
3597
3598
|
SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType;
|
|
3598
3599
|
/**
|
|
3599
|
-
* The MFA configuration.
|
|
3600
|
+
* The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include: OFF MFA won't be used for any users. ON MFA is required for all users to sign in. OPTIONAL MFA will be required only for individual users who have an MFA factor activated.
|
|
3600
3601
|
*/
|
|
3601
3602
|
MfaConfiguration?: UserPoolMfaType;
|
|
3602
3603
|
}
|
|
@@ -3610,7 +3611,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
3610
3611
|
*/
|
|
3611
3612
|
SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType;
|
|
3612
3613
|
/**
|
|
3613
|
-
* The MFA configuration. Valid values include: OFF MFA
|
|
3614
|
+
* The MFA configuration. Valid values include: OFF MFA won't be used for any users. ON MFA is required for all users to sign in. OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.
|
|
3614
3615
|
*/
|
|
3615
3616
|
MfaConfiguration?: UserPoolMfaType;
|
|
3616
3617
|
}
|
|
@@ -3636,11 +3637,11 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
3636
3637
|
*/
|
|
3637
3638
|
SecretHash?: SecretHashType;
|
|
3638
3639
|
/**
|
|
3639
|
-
* The user name of the user you
|
|
3640
|
+
* The user name of the user you want to register.
|
|
3640
3641
|
*/
|
|
3641
3642
|
Username: UsernameType;
|
|
3642
3643
|
/**
|
|
3643
|
-
* The password of the user you
|
|
3644
|
+
* The password of the user you want to register.
|
|
3644
3645
|
*/
|
|
3645
3646
|
Password: PasswordType;
|
|
3646
3647
|
/**
|
|
@@ -3660,7 +3661,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
3660
3661
|
*/
|
|
3661
3662
|
UserContextData?: UserContextDataType;
|
|
3662
3663
|
/**
|
|
3663
|
-
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
|
|
3664
|
+
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning Lambda functions to user pool triggers. When you use the SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your SignUp request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs. For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose. Validate the ClientMetadata value. Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
|
|
3664
3665
|
*/
|
|
3665
3666
|
ClientMetadata?: ClientMetadataType;
|
|
3666
3667
|
}
|
|
@@ -3674,28 +3675,32 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
3674
3675
|
*/
|
|
3675
3676
|
CodeDeliveryDetails?: CodeDeliveryDetailsType;
|
|
3676
3677
|
/**
|
|
3677
|
-
* The UUID of the authenticated user. This
|
|
3678
|
+
* The UUID of the authenticated user. This isn't the same as username.
|
|
3678
3679
|
*/
|
|
3679
3680
|
UserSub: StringType;
|
|
3680
3681
|
}
|
|
3681
3682
|
export type SkippedIPRangeListType = StringType[];
|
|
3682
3683
|
export interface SmsConfigurationType {
|
|
3683
3684
|
/**
|
|
3684
|
-
* The Amazon Resource Name (ARN) of the Amazon
|
|
3685
|
+
* The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role in your Amazon Web Services account that Amazon Cognito will use to send SMS messages. SMS messages are subject to a spending limit.
|
|
3685
3686
|
*/
|
|
3686
3687
|
SnsCallerArn: ArnType;
|
|
3687
3688
|
/**
|
|
3688
|
-
* The external ID
|
|
3689
|
+
* The external ID provides additional security for your IAM role. You can use an ExternalId with the IAM role that you use with Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId, your Amazon Cognito user pool includes it in the request to assume your IAM role. You can configure the role trust policy to require that Amazon Cognito, and any principal, provide the ExternalID. If you use the Amazon Cognito Management Console to create a role for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required permissions and a trust policy that demonstrates use of the ExternalId. For more information about the ExternalId of a role, see How to use an external ID when granting access to your Amazon Web Services resources to a third party
|
|
3689
3690
|
*/
|
|
3690
3691
|
ExternalId?: StringType;
|
|
3692
|
+
/**
|
|
3693
|
+
* The Amazon Web Services Region to use with Amazon SNS integration. You can choose the same Region as your user pool, or a supported Legacy Amazon SNS alternate Region. Amazon Cognito resources in the Asia Pacific (Seoul) Amazon Web Services Region must use your Amazon SNS configuration in the Asia Pacific (Tokyo) Region. For more information, see SMS message settings for Amazon Cognito user pools.
|
|
3694
|
+
*/
|
|
3695
|
+
SnsRegion?: RegionCodeType;
|
|
3691
3696
|
}
|
|
3692
3697
|
export interface SmsMfaConfigType {
|
|
3693
3698
|
/**
|
|
3694
|
-
* The SMS authentication message that will be sent to users with the code they
|
|
3699
|
+
* The SMS authentication message that will be sent to users with the code they must sign in. The message must contain the ‘{####}’ placeholder, which is replaced with the code. If the message isn't included, and default message will be used.
|
|
3695
3700
|
*/
|
|
3696
3701
|
SmsAuthenticationMessage?: SmsVerificationMessageType;
|
|
3697
3702
|
/**
|
|
3698
|
-
* The SMS configuration.
|
|
3703
|
+
* The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To request Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role that you provide for your Amazon Web Services account.
|
|
3699
3704
|
*/
|
|
3700
3705
|
SmsConfiguration?: SmsConfigurationType;
|
|
3701
3706
|
}
|
|
@@ -3703,13 +3708,13 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
3703
3708
|
export type SoftwareTokenMFAUserCodeType = string;
|
|
3704
3709
|
export interface SoftwareTokenMfaConfigType {
|
|
3705
3710
|
/**
|
|
3706
|
-
* Specifies whether software token MFA is
|
|
3711
|
+
* Specifies whether software token MFA is activated.
|
|
3707
3712
|
*/
|
|
3708
3713
|
Enabled?: BooleanType;
|
|
3709
3714
|
}
|
|
3710
3715
|
export interface SoftwareTokenMfaSettingsType {
|
|
3711
3716
|
/**
|
|
3712
|
-
* Specifies whether software token MFA is
|
|
3717
|
+
* Specifies whether software token MFA is activated. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted.
|
|
3713
3718
|
*/
|
|
3714
3719
|
Enabled?: BooleanType;
|
|
3715
3720
|
/**
|
|
@@ -3781,15 +3786,15 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
3781
3786
|
export type TokenModelType = string;
|
|
3782
3787
|
export interface TokenValidityUnitsType {
|
|
3783
3788
|
/**
|
|
3784
|
-
* A time unit in “seconds”, “minutes”, “hours
|
|
3789
|
+
* A time unit in “seconds”, “minutes”, “hours”, or “days” for the value in AccessTokenValidity, defaulting to hours.
|
|
3785
3790
|
*/
|
|
3786
3791
|
AccessToken?: TimeUnitsType;
|
|
3787
3792
|
/**
|
|
3788
|
-
* A time unit in “seconds”, “minutes”, “hours
|
|
3793
|
+
* A time unit in “seconds”, “minutes”, “hours”, or “days” for the value in IdTokenValidity, defaulting to hours.
|
|
3789
3794
|
*/
|
|
3790
3795
|
IdToken?: TimeUnitsType;
|
|
3791
3796
|
/**
|
|
3792
|
-
* A time unit in “seconds”, “minutes”, “hours
|
|
3797
|
+
* A time unit in “seconds”, “minutes”, “hours”, or “days” for the value in RefreshTokenValidity, defaulting to days.
|
|
3793
3798
|
*/
|
|
3794
3799
|
RefreshToken?: TimeUnitsType;
|
|
3795
3800
|
}
|
|
@@ -3889,7 +3894,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
3889
3894
|
*/
|
|
3890
3895
|
Description?: DescriptionType;
|
|
3891
3896
|
/**
|
|
3892
|
-
* The new role ARN for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.
|
|
3897
|
+
* The new role Amazon Resource Name (ARN) for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.
|
|
3893
3898
|
*/
|
|
3894
3899
|
RoleArn?: ArnType;
|
|
3895
3900
|
/**
|
|
@@ -3965,7 +3970,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
3965
3970
|
*/
|
|
3966
3971
|
AccessToken: TokenModelType;
|
|
3967
3972
|
/**
|
|
3968
|
-
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action
|
|
3973
|
+
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action initiates. You create custom workflows by assigning Lambda functions to user pool triggers. When you use the UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your UpdateUserAttributes request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs. For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose. Validate the ClientMetadata value. Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
|
|
3969
3974
|
*/
|
|
3970
3975
|
ClientMetadata?: ClientMetadataType;
|
|
3971
3976
|
}
|
|
@@ -3989,19 +3994,19 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
3989
3994
|
*/
|
|
3990
3995
|
ClientName?: ClientNameType;
|
|
3991
3996
|
/**
|
|
3992
|
-
* The time limit, in days, after which the refresh token is no longer valid and
|
|
3997
|
+
* The time limit, in days, after which the refresh token is no longer valid and can't be used.
|
|
3993
3998
|
*/
|
|
3994
3999
|
RefreshTokenValidity?: RefreshTokenValidityType;
|
|
3995
4000
|
/**
|
|
3996
|
-
* The time limit
|
|
4001
|
+
* The time limit after which the access token is no longer valid and can't be used.
|
|
3997
4002
|
*/
|
|
3998
4003
|
AccessTokenValidity?: AccessTokenValidityType;
|
|
3999
4004
|
/**
|
|
4000
|
-
* The time limit
|
|
4005
|
+
* The time limit after which the ID token is no longer valid and can't be used.
|
|
4001
4006
|
*/
|
|
4002
4007
|
IdTokenValidity?: IdTokenValidityType;
|
|
4003
4008
|
/**
|
|
4004
|
-
* The units in which the validity times are represented
|
|
4009
|
+
* The units in which the validity times are represented. Default for RefreshToken is days, and default for ID and access tokens is hours.
|
|
4005
4010
|
*/
|
|
4006
4011
|
TokenValidityUnits?: TokenValidityUnitsType;
|
|
4007
4012
|
/**
|
|
@@ -4013,7 +4018,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
4013
4018
|
*/
|
|
4014
4019
|
WriteAttributes?: ClientPermissionListType;
|
|
4015
4020
|
/**
|
|
4016
|
-
* The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are
|
|
4021
|
+
* 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. Note that values with ALLOW_ prefix must be used only along with values 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.
|
|
4017
4022
|
*/
|
|
4018
4023
|
ExplicitAuthFlows?: ExplicitAuthFlowsListType;
|
|
4019
4024
|
/**
|
|
@@ -4041,35 +4046,35 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
4041
4046
|
*/
|
|
4042
4047
|
AllowedOAuthScopes?: ScopeListType;
|
|
4043
4048
|
/**
|
|
4044
|
-
* Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
|
|
4049
|
+
* Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
|
|
4045
4050
|
*/
|
|
4046
4051
|
AllowedOAuthFlowsUserPoolClient?: BooleanType;
|
|
4047
4052
|
/**
|
|
4048
|
-
* The Amazon Pinpoint analytics configuration for collecting metrics for this user pool. In
|
|
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.
|
|
4049
4054
|
*/
|
|
4050
4055
|
AnalyticsConfiguration?: AnalyticsConfigurationType;
|
|
4051
4056
|
/**
|
|
4052
|
-
*
|
|
4057
|
+
* 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 early behavior of Amazon Cognito where user existence related errors aren't prevented.
|
|
4053
4058
|
*/
|
|
4054
4059
|
PreventUserExistenceErrors?: PreventUserExistenceErrorTypes;
|
|
4055
4060
|
/**
|
|
4056
|
-
*
|
|
4061
|
+
* Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
|
|
4057
4062
|
*/
|
|
4058
4063
|
EnableTokenRevocation?: WrappedBooleanType;
|
|
4059
4064
|
}
|
|
4060
4065
|
export interface UpdateUserPoolClientResponse {
|
|
4061
4066
|
/**
|
|
4062
|
-
* The user pool client value from the response from the server when
|
|
4067
|
+
* The user pool client value from the response from the server when you request to update the user pool client.
|
|
4063
4068
|
*/
|
|
4064
4069
|
UserPoolClient?: UserPoolClientType;
|
|
4065
4070
|
}
|
|
4066
4071
|
export interface UpdateUserPoolDomainRequest {
|
|
4067
4072
|
/**
|
|
4068
|
-
* The domain name for the custom domain that hosts the sign-up and sign-in pages for your application.
|
|
4073
|
+
* The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. One example might be auth.example.com. This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names.
|
|
4069
4074
|
*/
|
|
4070
4075
|
Domain: DomainType;
|
|
4071
4076
|
/**
|
|
4072
|
-
* The ID of the user pool that is associated with the custom domain
|
|
4077
|
+
* The ID of the user pool that is associated with the custom domain whose certificate you're updating.
|
|
4073
4078
|
*/
|
|
4074
4079
|
UserPoolId: UserPoolIdType;
|
|
4075
4080
|
/**
|
|
@@ -4089,7 +4094,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
4089
4094
|
*/
|
|
4090
4095
|
UserPoolId: UserPoolIdType;
|
|
4091
4096
|
/**
|
|
4092
|
-
* A container with the policies you
|
|
4097
|
+
* A container with the policies you want to update in a user pool.
|
|
4093
4098
|
*/
|
|
4094
4099
|
Policies?: UserPoolPolicyType;
|
|
4095
4100
|
/**
|
|
@@ -4097,7 +4102,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
4097
4102
|
*/
|
|
4098
4103
|
LambdaConfig?: LambdaConfigType;
|
|
4099
4104
|
/**
|
|
4100
|
-
* The attributes that are automatically verified when
|
|
4105
|
+
* The attributes that are automatically verified when Amazon Cognito requests to update user pools.
|
|
4101
4106
|
*/
|
|
4102
4107
|
AutoVerifiedAttributes?: VerifiedAttributesListType;
|
|
4103
4108
|
/**
|
|
@@ -4121,7 +4126,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
4121
4126
|
*/
|
|
4122
4127
|
SmsAuthenticationMessage?: SmsVerificationMessageType;
|
|
4123
4128
|
/**
|
|
4124
|
-
* Can be one of the following values: OFF - MFA tokens
|
|
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.
|
|
4125
4130
|
*/
|
|
4126
4131
|
MfaConfiguration?: UserPoolMfaType;
|
|
4127
4132
|
/**
|
|
@@ -4129,11 +4134,11 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
4129
4134
|
*/
|
|
4130
4135
|
DeviceConfiguration?: DeviceConfigurationType;
|
|
4131
4136
|
/**
|
|
4132
|
-
*
|
|
4137
|
+
* The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for email invitation and verification messages from your user pool.
|
|
4133
4138
|
*/
|
|
4134
4139
|
EmailConfiguration?: EmailConfigurationType;
|
|
4135
4140
|
/**
|
|
4136
|
-
* SMS configuration.
|
|
4141
|
+
* The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
|
|
4137
4142
|
*/
|
|
4138
4143
|
SmsConfiguration?: SmsConfigurationType;
|
|
4139
4144
|
/**
|
|
@@ -4145,11 +4150,11 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
4145
4150
|
*/
|
|
4146
4151
|
AdminCreateUserConfig?: AdminCreateUserConfigType;
|
|
4147
4152
|
/**
|
|
4148
|
-
*
|
|
4153
|
+
* Enables advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
|
|
4149
4154
|
*/
|
|
4150
4155
|
UserPoolAddOns?: UserPoolAddOnsType;
|
|
4151
4156
|
/**
|
|
4152
|
-
*
|
|
4157
|
+
* The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
|
|
4153
4158
|
*/
|
|
4154
4159
|
AccountRecoverySetting?: AccountRecoverySettingType;
|
|
4155
4160
|
}
|
|
@@ -4157,7 +4162,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
4157
4162
|
}
|
|
4158
4163
|
export interface UserContextDataType {
|
|
4159
4164
|
/**
|
|
4160
|
-
* 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.
|
|
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.
|
|
4161
4166
|
*/
|
|
4162
4167
|
EncodedData?: StringType;
|
|
4163
4168
|
}
|
|
@@ -4195,11 +4200,11 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
4195
4200
|
*/
|
|
4196
4201
|
CompletionDate?: DateType;
|
|
4197
4202
|
/**
|
|
4198
|
-
* The status of the user import job. One of the following: Created - The job was created but not started. Pending - A transition state. You have started the job, but it has not begun importing users yet. InProgress - The job has started, and users are being imported. Stopping - You have stopped the job, but the job has not stopped importing users yet. Stopped - You have stopped the job, and the job has stopped importing users. Succeeded - The job has completed successfully. Failed - The job has stopped due to an error. Expired - You created a job, but did not start the job within 24-48 hours. All data associated with the job was deleted, and the job
|
|
4203
|
+
* The status of the user import job. One of the following: Created - The job was created but not started. Pending - A transition state. You have started the job, but it has not begun importing users yet. InProgress - The job has started, and users are being imported. Stopping - You have stopped the job, but the job has not stopped importing users yet. Stopped - You have stopped the job, and the job has stopped importing users. Succeeded - The job has completed successfully. Failed - The job has stopped due to an error. Expired - You created a job, but did not start the job within 24-48 hours. All data associated with the job was deleted, and the job can't be started.
|
|
4199
4204
|
*/
|
|
4200
4205
|
Status?: UserImportJobStatusType;
|
|
4201
4206
|
/**
|
|
4202
|
-
* The role ARN for the Amazon CloudWatch Logging role for the user import job. For more information, see "Creating the CloudWatch Logs IAM Role" in the Amazon Cognito Developer Guide.
|
|
4207
|
+
* The role Amazon Resource Name (ARN) for the Amazon CloudWatch Logging role for the user import job. For more information, see "Creating the CloudWatch Logs IAM Role" in the Amazon Cognito Developer Guide.
|
|
4203
4208
|
*/
|
|
4204
4209
|
CloudWatchLogsRoleArn?: ArnType;
|
|
4205
4210
|
/**
|
|
@@ -4211,7 +4216,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
4211
4216
|
*/
|
|
4212
4217
|
SkippedUsers?: LongType;
|
|
4213
4218
|
/**
|
|
4214
|
-
* The number of users that
|
|
4219
|
+
* The number of users that couldn't be imported.
|
|
4215
4220
|
*/
|
|
4216
4221
|
FailedUsers?: LongType;
|
|
4217
4222
|
/**
|
|
@@ -4268,15 +4273,15 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
4268
4273
|
*/
|
|
4269
4274
|
CreationDate?: DateType;
|
|
4270
4275
|
/**
|
|
4271
|
-
* The time limit, in days, after which the refresh token is no longer valid and
|
|
4276
|
+
* The time limit, in days, after which the refresh token is no longer valid and can't be used.
|
|
4272
4277
|
*/
|
|
4273
4278
|
RefreshTokenValidity?: RefreshTokenValidityType;
|
|
4274
4279
|
/**
|
|
4275
|
-
* The time limit, specified by tokenValidityUnits, defaulting to hours, after which the access token is no longer valid and
|
|
4280
|
+
* The time limit, specified by tokenValidityUnits, defaulting to hours, after which the access token is no longer valid and can't be used.
|
|
4276
4281
|
*/
|
|
4277
4282
|
AccessTokenValidity?: AccessTokenValidityType;
|
|
4278
4283
|
/**
|
|
4279
|
-
* The time limit
|
|
4284
|
+
* The time limit specified by tokenValidityUnits, defaulting to hours, after which the refresh token is no longer valid and can't be used.
|
|
4280
4285
|
*/
|
|
4281
4286
|
IdTokenValidity?: IdTokenValidityType;
|
|
4282
4287
|
/**
|
|
@@ -4292,7 +4297,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
4292
4297
|
*/
|
|
4293
4298
|
WriteAttributes?: ClientPermissionListType;
|
|
4294
4299
|
/**
|
|
4295
|
-
* The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are
|
|
4300
|
+
* 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. Note that values with ALLOW_ prefix must be used only along with values including 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.
|
|
4296
4301
|
*/
|
|
4297
4302
|
ExplicitAuthFlows?: ExplicitAuthFlowsListType;
|
|
4298
4303
|
/**
|
|
@@ -4320,19 +4325,19 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
4320
4325
|
*/
|
|
4321
4326
|
AllowedOAuthScopes?: ScopeListType;
|
|
4322
4327
|
/**
|
|
4323
|
-
* Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
|
|
4328
|
+
* Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
|
|
4324
4329
|
*/
|
|
4325
4330
|
AllowedOAuthFlowsUserPoolClient?: BooleanType;
|
|
4326
4331
|
/**
|
|
4327
|
-
* The Amazon Pinpoint analytics configuration for the user pool client. Cognito
|
|
4332
|
+
* The Amazon Pinpoint analytics configuration for the user pool client. Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region where the user pool resides.
|
|
4328
4333
|
*/
|
|
4329
4334
|
AnalyticsConfiguration?: AnalyticsConfigurationType;
|
|
4330
4335
|
/**
|
|
4331
|
-
*
|
|
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.
|
|
4332
4337
|
*/
|
|
4333
4338
|
PreventUserExistenceErrors?: PreventUserExistenceErrorTypes;
|
|
4334
4339
|
/**
|
|
4335
|
-
* Indicates whether token revocation is
|
|
4340
|
+
* 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.
|
|
4336
4341
|
*/
|
|
4337
4342
|
EnableTokenRevocation?: WrappedBooleanType;
|
|
4338
4343
|
}
|
|
@@ -4408,15 +4413,15 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
4408
4413
|
*/
|
|
4409
4414
|
SchemaAttributes?: SchemaAttributesListType;
|
|
4410
4415
|
/**
|
|
4411
|
-
*
|
|
4416
|
+
* The attributes that are auto-verified in a user pool.
|
|
4412
4417
|
*/
|
|
4413
4418
|
AutoVerifiedAttributes?: VerifiedAttributesListType;
|
|
4414
4419
|
/**
|
|
4415
|
-
*
|
|
4420
|
+
* The attributes that are aliased in a user pool.
|
|
4416
4421
|
*/
|
|
4417
4422
|
AliasAttributes?: AliasAttributesListType;
|
|
4418
4423
|
/**
|
|
4419
|
-
* Specifies whether email
|
|
4424
|
+
* Specifies whether a user can use an email address or phone number as a username when they sign up.
|
|
4420
4425
|
*/
|
|
4421
4426
|
UsernameAttributes?: UsernameAttributesListType;
|
|
4422
4427
|
/**
|
|
@@ -4440,7 +4445,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
4440
4445
|
*/
|
|
4441
4446
|
SmsAuthenticationMessage?: SmsVerificationMessageType;
|
|
4442
4447
|
/**
|
|
4443
|
-
* Can be one of the following values: OFF - MFA tokens
|
|
4448
|
+
* 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.
|
|
4444
4449
|
*/
|
|
4445
4450
|
MfaConfiguration?: UserPoolMfaType;
|
|
4446
4451
|
/**
|
|
@@ -4452,11 +4457,11 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
4452
4457
|
*/
|
|
4453
4458
|
EstimatedNumberOfUsers?: IntegerType;
|
|
4454
4459
|
/**
|
|
4455
|
-
* The email configuration.
|
|
4460
|
+
* The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages tfrom your user pool.
|
|
4456
4461
|
*/
|
|
4457
4462
|
EmailConfiguration?: EmailConfigurationType;
|
|
4458
4463
|
/**
|
|
4459
|
-
* The SMS configuration.
|
|
4464
|
+
* The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
|
|
4460
4465
|
*/
|
|
4461
4466
|
SmsConfiguration?: SmsConfigurationType;
|
|
4462
4467
|
/**
|
|
@@ -4464,19 +4469,19 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
4464
4469
|
*/
|
|
4465
4470
|
UserPoolTags?: UserPoolTagsType;
|
|
4466
4471
|
/**
|
|
4467
|
-
* The reason why the SMS configuration
|
|
4472
|
+
* The reason why the SMS configuration can't send the messages to your users. This message might include comma-separated values to describe why your SMS configuration can't send messages to user pool end users. InvalidSmsRoleAccessPolicyException The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly configured. For more information, see SmsConfigurationType. SNSSandbox The Amazon Web Services account is in the SNS SMS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the IAM user creating the user pool doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox, see Moving out of the SMS sandbox.
|
|
4468
4473
|
*/
|
|
4469
4474
|
SmsConfigurationFailure?: StringType;
|
|
4470
4475
|
/**
|
|
4471
|
-
*
|
|
4476
|
+
* Deprecated. Review error codes from API requests with EventSource:cognito-idp.amazonaws.com in CloudTrail for information about problems with user pool email configuration.
|
|
4472
4477
|
*/
|
|
4473
4478
|
EmailConfigurationFailure?: StringType;
|
|
4474
4479
|
/**
|
|
4475
|
-
*
|
|
4480
|
+
* The domain prefix, if the user pool has a domain associated with it.
|
|
4476
4481
|
*/
|
|
4477
4482
|
Domain?: DomainType;
|
|
4478
4483
|
/**
|
|
4479
|
-
* A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application.
|
|
4484
|
+
* A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. An example of a custom domain name might be auth.example.com. For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
|
|
4480
4485
|
*/
|
|
4481
4486
|
CustomDomain?: DomainType;
|
|
4482
4487
|
/**
|
|
@@ -4488,7 +4493,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
4488
4493
|
*/
|
|
4489
4494
|
UserPoolAddOns?: UserPoolAddOnsType;
|
|
4490
4495
|
/**
|
|
4491
|
-
*
|
|
4496
|
+
* Case sensitivity of the username input for the selected sign-in option. For example, when case sensitivity is set to False, users can sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.
|
|
4492
4497
|
*/
|
|
4493
4498
|
UsernameConfiguration?: UsernameConfigurationType;
|
|
4494
4499
|
/**
|
|
@@ -4496,14 +4501,14 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
4496
4501
|
*/
|
|
4497
4502
|
Arn?: ArnType;
|
|
4498
4503
|
/**
|
|
4499
|
-
*
|
|
4504
|
+
* The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
|
|
4500
4505
|
*/
|
|
4501
4506
|
AccountRecoverySetting?: AccountRecoverySettingType;
|
|
4502
4507
|
}
|
|
4503
4508
|
export type UserStatusType = "UNCONFIRMED"|"CONFIRMED"|"ARCHIVED"|"COMPROMISED"|"UNKNOWN"|"RESET_REQUIRED"|"FORCE_CHANGE_PASSWORD"|string;
|
|
4504
4509
|
export interface UserType {
|
|
4505
4510
|
/**
|
|
4506
|
-
* The user name of the user you
|
|
4511
|
+
* The user name of the user you want to describe.
|
|
4507
4512
|
*/
|
|
4508
4513
|
Username?: UsernameType;
|
|
4509
4514
|
/**
|
|
@@ -4523,7 +4528,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
4523
4528
|
*/
|
|
4524
4529
|
Enabled?: BooleanType;
|
|
4525
4530
|
/**
|
|
4526
|
-
* The user status.
|
|
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.
|
|
4527
4532
|
*/
|
|
4528
4533
|
UserStatus?: UserStatusType;
|
|
4529
4534
|
/**
|
|
@@ -4535,7 +4540,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
4535
4540
|
export type UsernameAttributesListType = UsernameAttributeType[];
|
|
4536
4541
|
export interface UsernameConfigurationType {
|
|
4537
4542
|
/**
|
|
4538
|
-
* Specifies whether username case sensitivity will be applied for all users in the user pool through Cognito APIs. Valid values include:
|
|
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.
|
|
4539
4544
|
*/
|
|
4540
4545
|
CaseSensitive: WrappedBooleanType;
|
|
4541
4546
|
}
|
|
@@ -4575,11 +4580,11 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
4575
4580
|
*/
|
|
4576
4581
|
AccessToken?: TokenModelType;
|
|
4577
4582
|
/**
|
|
4578
|
-
* The session
|
|
4583
|
+
* The session that should be passed both ways in challenge-response calls to the service.
|
|
4579
4584
|
*/
|
|
4580
4585
|
Session?: SessionType;
|
|
4581
4586
|
/**
|
|
4582
|
-
* The one time password computed using the secret code returned by AssociateSoftwareToken
|
|
4587
|
+
* The one- time password computed using the secret code returned by AssociateSoftwareToken.
|
|
4583
4588
|
*/
|
|
4584
4589
|
UserCode: SoftwareTokenMFAUserCodeType;
|
|
4585
4590
|
/**
|
|
@@ -4593,14 +4598,14 @@ declare namespace CognitoIdentityServiceProvider {
|
|
|
4593
4598
|
*/
|
|
4594
4599
|
Status?: VerifySoftwareTokenResponseType;
|
|
4595
4600
|
/**
|
|
4596
|
-
* The session
|
|
4601
|
+
* The session that should be passed both ways in challenge-response calls to the service.
|
|
4597
4602
|
*/
|
|
4598
4603
|
Session?: SessionType;
|
|
4599
4604
|
}
|
|
4600
4605
|
export type VerifySoftwareTokenResponseType = "SUCCESS"|"ERROR"|string;
|
|
4601
4606
|
export interface VerifyUserAttributeRequest {
|
|
4602
4607
|
/**
|
|
4603
|
-
*
|
|
4608
|
+
* The access token of the request to verify user attributes.
|
|
4604
4609
|
*/
|
|
4605
4610
|
AccessToken: TokenModelType;
|
|
4606
4611
|
/**
|