@pgarbe/cdk-ecr-sync 0.5.25 → 0.5.28
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 +6 -4
- package/CHANGELOG.md +1 -1
- package/lib/ecr-sync.d.ts +5 -22
- package/lib/ecr-sync.d.ts.map +1 -0
- package/lib/ecr-sync.js +3 -10
- package/lib/image.d.ts +6 -8
- package/lib/image.d.ts.map +1 -0
- package/lib/image.js +1 -1
- package/lib/index.d.ts +1 -0
- package/lib/index.d.ts.map +1 -0
- package/lib/lambda/docker-adapter.d.ts +1 -0
- package/lib/lambda/docker-adapter.d.ts.map +1 -0
- package/lib/lambda/ecr-adapter.d.ts +1 -0
- package/lib/lambda/ecr-adapter.d.ts.map +1 -0
- package/lib/lambda/get-image-tags-handler.d.ts +1 -0
- package/lib/lambda/get-image-tags-handler.d.ts.map +1 -0
- package/node_modules/aws-sdk/CHANGELOG.md +433 -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/backup-2018-11-15.min.json +30 -0
- package/node_modules/aws-sdk/apis/backup-2018-11-15.paginators.json +22 -11
- 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/braket-2019-09-01.min.json +30 -27
- 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-media-pipelines-2021-07-15.examples.json +5 -0
- package/node_modules/aws-sdk/apis/chime-sdk-media-pipelines-2021-07-15.min.json +330 -0
- package/node_modules/aws-sdk/apis/chime-sdk-media-pipelines-2021-07-15.paginators.json +9 -0
- package/node_modules/aws-sdk/apis/chime-sdk-meetings-2021-07-15.min.json +16 -11
- package/node_modules/aws-sdk/apis/cloudcontrol-2021-09-30.paginators.json +4 -2
- package/node_modules/aws-sdk/apis/cloudcontrol-2021-09-30.waiters2.json +23 -27
- package/node_modules/aws-sdk/apis/cloudformation-2010-05-15.min.json +86 -25
- package/node_modules/aws-sdk/apis/cloudfront-2020-05-31.min.json +42 -28
- package/node_modules/aws-sdk/apis/cloudtrail-2013-11-01.min.json +25 -2
- package/node_modules/aws-sdk/apis/codeguru-reviewer-2019-09-19.min.json +15 -8
- 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 +832 -139
- package/node_modules/aws-sdk/apis/connect-2017-08-08.paginators.json +33 -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 +144 -74
- package/node_modules/aws-sdk/apis/devops-guru-2020-12-01.min.json +213 -119
- package/node_modules/aws-sdk/apis/discovery-2015-11-01.min.json +67 -32
- 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 +1179 -850
- package/node_modules/aws-sdk/apis/ec2-2016-11-15.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/ec2-2016-11-15.waiters2.json +18 -0
- 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/elasticmapreduce-2009-03-31.min.json +47 -35
- 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 +14 -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 +2257 -440
- 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 +194 -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 +280 -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/iotsecuretunneling-2018-10-05.min.json +28 -0
- 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/iotwireless-2020-11-22.min.json +401 -80
- package/node_modules/aws-sdk/apis/iotwireless-2020-11-22.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/ivschat-2020-07-14.examples.json +5 -0
- package/node_modules/aws-sdk/apis/ivschat-2020-07-14.min.json +443 -0
- package/node_modules/aws-sdk/apis/ivschat-2020-07-14.paginators.json +9 -0
- 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 +349 -83
- package/node_modules/aws-sdk/apis/kendra-2019-02-03.paginators.json +20 -0
- 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/kinesis-video-archived-media-2017-09-30.min.json +64 -0
- package/node_modules/aws-sdk/apis/kinesis-video-archived-media-2017-09-30.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/kinesisvideo-2017-09-30.min.json +145 -8
- 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 +117 -56
- package/node_modules/aws-sdk/apis/location-2020-11-19.min.json +20 -12
- package/node_modules/aws-sdk/apis/location-2020-11-19.paginators.json +2 -0
- package/node_modules/aws-sdk/apis/lookoutequipment-2020-12-15.min.json +274 -12
- package/node_modules/aws-sdk/apis/lookoutequipment-2020-12-15.paginators.json +5 -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 +31 -28
- 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 +179 -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 +20 -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/mq-2017-11-27.min.json +22 -7
- package/node_modules/aws-sdk/apis/network-firewall-2020-11-12.min.json +139 -53
- 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 +74 -0
- package/node_modules/aws-sdk/apis/outposts-2019-12-03.paginators.json +10 -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 +289 -413
- package/node_modules/aws-sdk/apis/rds-2014-10-31.paginators.json +0 -12
- package/node_modules/aws-sdk/apis/rds-data-2018-08-01.min.json +4 -1
- package/node_modules/aws-sdk/apis/redshift-2012-12-01.min.json +41 -23
- package/node_modules/aws-sdk/apis/rekognition-2016-06-27.min.json +247 -111
- package/node_modules/aws-sdk/apis/resiliencehub-2020-04-30.min.json +125 -74
- 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 +97 -97
- 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 +732 -691
- package/node_modules/aws-sdk/apis/secretsmanager-2017-10-17.examples.json +15 -13
- 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 +392 -304
- 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 +333 -294
- package/node_modules/aws-sdk/apis/ssm-contacts-2021-05-03.examples.json +1 -1
- package/node_modules/aws-sdk/apis/ssm-incidents-2018-05-10.min.json +48 -37
- package/node_modules/aws-sdk/apis/synthetics-2017-10-11.min.json +49 -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 +313 -131
- 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/apis/workspaces-web-2020-07-08.min.json +107 -36
- package/node_modules/aws-sdk/clients/acmpca.d.ts +72 -36
- package/node_modules/aws-sdk/clients/all.d.ts +6 -0
- package/node_modules/aws-sdk/clients/all.js +7 -1
- package/node_modules/aws-sdk/clients/amplify.d.ts +19 -14
- 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 +10 -10
- package/node_modules/aws-sdk/clients/autoscaling.d.ts +62 -34
- package/node_modules/aws-sdk/clients/backup.d.ts +49 -25
- 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/braket.d.ts +7 -2
- 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/chimesdkmediapipelines.d.ts +348 -0
- package/node_modules/aws-sdk/clients/chimesdkmediapipelines.js +18 -0
- package/node_modules/aws-sdk/clients/chimesdkmeetings.d.ts +31 -5
- package/node_modules/aws-sdk/clients/cloudcontrol.d.ts +24 -24
- package/node_modules/aws-sdk/clients/cloudformation.d.ts +408 -265
- package/node_modules/aws-sdk/clients/cloudfront.d.ts +15 -0
- package/node_modules/aws-sdk/clients/cloudtrail.d.ts +34 -26
- package/node_modules/aws-sdk/clients/cloudwatch.d.ts +44 -12
- package/node_modules/aws-sdk/clients/codegurureviewer.d.ts +24 -10
- 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/computeoptimizer.d.ts +3 -3
- package/node_modules/aws-sdk/clients/configservice.d.ts +220 -49
- package/node_modules/aws-sdk/clients/connect.d.ts +877 -30
- 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 +103 -16
- package/node_modules/aws-sdk/clients/devopsguru.d.ts +109 -3
- package/node_modules/aws-sdk/clients/discovery.d.ts +63 -26
- 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 +571 -145
- 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 +14 -14
- package/node_modules/aws-sdk/clients/elasticache.d.ts +13 -13
- package/node_modules/aws-sdk/clients/emr.d.ts +38 -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/eventbridge.js +1 -0
- package/node_modules/aws-sdk/clients/evidently.d.ts +19 -7
- 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 +186 -186
- 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 +2588 -188
- package/node_modules/aws-sdk/clients/grafana.d.ts +153 -6
- package/node_modules/aws-sdk/clients/greengrassv2.d.ts +6 -6
- package/node_modules/aws-sdk/clients/guardduty.d.ts +314 -46
- 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 +88 -22
- package/node_modules/aws-sdk/clients/iotdata.d.ts +7 -7
- package/node_modules/aws-sdk/clients/iotsecuretunneling.d.ts +52 -18
- 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/iotwireless.d.ts +356 -25
- package/node_modules/aws-sdk/clients/ivschat.d.ts +523 -0
- package/node_modules/aws-sdk/clients/ivschat.js +18 -0
- 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 +489 -138
- 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/kinesisvideo.d.ts +177 -10
- package/node_modules/aws-sdk/clients/kinesisvideoarchivedmedia.d.ts +94 -0
- package/node_modules/aws-sdk/clients/kms.d.ts +209 -119
- package/node_modules/aws-sdk/clients/lakeformation.d.ts +2 -2
- package/node_modules/aws-sdk/clients/lambda.d.ts +319 -16
- package/node_modules/aws-sdk/clients/lexmodelsv2.d.ts +2 -2
- package/node_modules/aws-sdk/clients/lightsail.d.ts +175 -64
- package/node_modules/aws-sdk/clients/location.d.ts +28 -19
- package/node_modules/aws-sdk/clients/lookoutequipment.d.ts +295 -9
- 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 +7 -2
- 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 +98 -18
- package/node_modules/aws-sdk/clients/medialive.d.ts +79 -3
- package/node_modules/aws-sdk/clients/mediapackage.d.ts +4 -4
- 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/mq.d.ts +16 -1
- package/node_modules/aws-sdk/clients/networkfirewall.d.ts +151 -21
- package/node_modules/aws-sdk/clients/opensearch.d.ts +97 -0
- package/node_modules/aws-sdk/clients/organizations.d.ts +146 -131
- package/node_modules/aws-sdk/clients/outposts.d.ts +94 -22
- 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/pricing.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 +600 -779
- package/node_modules/aws-sdk/clients/rdsdataservice.d.ts +22 -7
- package/node_modules/aws-sdk/clients/redshift.d.ts +68 -30
- package/node_modules/aws-sdk/clients/rekognition.d.ts +209 -53
- package/node_modules/aws-sdk/clients/resiliencehub.d.ts +138 -58
- 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 +735 -204
- 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 +252 -182
- package/node_modules/aws-sdk/clients/secretsmanager.d.ts +77 -63
- package/node_modules/aws-sdk/clients/securityhub.d.ts +166 -7
- package/node_modules/aws-sdk/clients/servicecatalog.d.ts +8 -4
- package/node_modules/aws-sdk/clients/sns.d.ts +2 -2
- package/node_modules/aws-sdk/clients/ssm.d.ts +90 -37
- package/node_modules/aws-sdk/clients/ssmcontacts.d.ts +2 -2
- package/node_modules/aws-sdk/clients/ssmincidents.d.ts +21 -7
- package/node_modules/aws-sdk/clients/storagegateway.d.ts +24 -24
- package/node_modules/aws-sdk/clients/sts.d.ts +5 -5
- package/node_modules/aws-sdk/clients/synthetics.d.ts +25 -10
- 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 +77 -14
- 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 +274 -34
- 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/clients/workspacesweb.d.ts +38 -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 +1367 -1072
- package/node_modules/aws-sdk/dist/aws-sdk.js +6655 -3278
- package/node_modules/aws-sdk/dist/aws-sdk.min.js +94 -92
- package/node_modules/aws-sdk/lib/config-base.d.ts +1 -0
- package/node_modules/aws-sdk/lib/config_service_placeholders.d.ts +12 -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/eventbridge.js +19 -0
- package/node_modules/aws-sdk/lib/services/s3.js +2 -1
- package/node_modules/aws-sdk/lib/services/s3util.js +6 -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/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/.npmignore +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/CHANGELOG.md +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/LICENSE +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/README.md +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/Utility.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLAttribute.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLCData.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLComment.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLDTDAttList.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLDTDElement.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLDTDEntity.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLDTDNotation.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLDeclaration.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLDocType.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLDocument.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLDocumentCB.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLElement.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLNode.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLProcessingInstruction.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLRaw.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLStreamWriter.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLStringWriter.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLStringifier.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLText.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLWriterBase.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/index.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/package.json +0 -0
- package/package.json +20 -15
- package/releasetag.txt +1 -1
- package/version.txt +1 -1
- 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
|
@@ -28,27 +28,27 @@ declare class Kendra extends Service {
|
|
|
28
28
|
*/
|
|
29
29
|
associatePersonasToEntities(callback?: (err: AWSError, data: Kendra.Types.AssociatePersonasToEntitiesResponse) => void): Request<Kendra.Types.AssociatePersonasToEntitiesResponse, AWSError>;
|
|
30
30
|
/**
|
|
31
|
-
* Removes one or more documents from an index. The documents must have been added with the BatchPutDocument
|
|
31
|
+
* Removes one or more documents from an index. The documents must have been added with the BatchPutDocument API. The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to you CloudWatch log.
|
|
32
32
|
*/
|
|
33
33
|
batchDeleteDocument(params: Kendra.Types.BatchDeleteDocumentRequest, callback?: (err: AWSError, data: Kendra.Types.BatchDeleteDocumentResponse) => void): Request<Kendra.Types.BatchDeleteDocumentResponse, AWSError>;
|
|
34
34
|
/**
|
|
35
|
-
* Removes one or more documents from an index. The documents must have been added with the BatchPutDocument
|
|
35
|
+
* Removes one or more documents from an index. The documents must have been added with the BatchPutDocument API. The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to you CloudWatch log.
|
|
36
36
|
*/
|
|
37
37
|
batchDeleteDocument(callback?: (err: AWSError, data: Kendra.Types.BatchDeleteDocumentResponse) => void): Request<Kendra.Types.BatchDeleteDocumentResponse, AWSError>;
|
|
38
38
|
/**
|
|
39
|
-
* Returns the indexing status for one or more documents submitted with the BatchPutDocument
|
|
39
|
+
* Returns the indexing status for one or more documents submitted with the BatchPutDocument API. When you use the BatchPutDocument API, documents are indexed asynchronously. You can use the BatchGetDocumentStatus API to get the current status of a list of documents so that you can determine if they have been successfully indexed. You can also use the BatchGetDocumentStatus API to check the status of the BatchDeleteDocument API. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.
|
|
40
40
|
*/
|
|
41
41
|
batchGetDocumentStatus(params: Kendra.Types.BatchGetDocumentStatusRequest, callback?: (err: AWSError, data: Kendra.Types.BatchGetDocumentStatusResponse) => void): Request<Kendra.Types.BatchGetDocumentStatusResponse, AWSError>;
|
|
42
42
|
/**
|
|
43
|
-
* Returns the indexing status for one or more documents submitted with the BatchPutDocument
|
|
43
|
+
* Returns the indexing status for one or more documents submitted with the BatchPutDocument API. When you use the BatchPutDocument API, documents are indexed asynchronously. You can use the BatchGetDocumentStatus API to get the current status of a list of documents so that you can determine if they have been successfully indexed. You can also use the BatchGetDocumentStatus API to check the status of the BatchDeleteDocument API. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.
|
|
44
44
|
*/
|
|
45
45
|
batchGetDocumentStatus(callback?: (err: AWSError, data: Kendra.Types.BatchGetDocumentStatusResponse) => void): Request<Kendra.Types.BatchGetDocumentStatusResponse, AWSError>;
|
|
46
46
|
/**
|
|
47
|
-
* Adds one or more documents to an index. The BatchPutDocument
|
|
47
|
+
* Adds one or more documents to an index. The BatchPutDocument API enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this API to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index. The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log.
|
|
48
48
|
*/
|
|
49
49
|
batchPutDocument(params: Kendra.Types.BatchPutDocumentRequest, callback?: (err: AWSError, data: Kendra.Types.BatchPutDocumentResponse) => void): Request<Kendra.Types.BatchPutDocumentResponse, AWSError>;
|
|
50
50
|
/**
|
|
51
|
-
* Adds one or more documents to an index. The BatchPutDocument
|
|
51
|
+
* Adds one or more documents to an index. The BatchPutDocument API enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this API to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index. The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log.
|
|
52
52
|
*/
|
|
53
53
|
batchPutDocument(callback?: (err: AWSError, data: Kendra.Types.BatchPutDocumentResponse) => void): Request<Kendra.Types.BatchPutDocumentResponse, AWSError>;
|
|
54
54
|
/**
|
|
@@ -84,11 +84,11 @@ declare class Kendra extends Service {
|
|
|
84
84
|
*/
|
|
85
85
|
createFaq(callback?: (err: AWSError, data: Kendra.Types.CreateFaqResponse) => void): Request<Kendra.Types.CreateFaqResponse, AWSError>;
|
|
86
86
|
/**
|
|
87
|
-
* Creates a new Amazon Kendra index. Index creation is an asynchronous
|
|
87
|
+
* Creates a new Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use. Once the index is active you can index your documents using the BatchPutDocument API or using one of the supported data sources.
|
|
88
88
|
*/
|
|
89
89
|
createIndex(params: Kendra.Types.CreateIndexRequest, callback?: (err: AWSError, data: Kendra.Types.CreateIndexResponse) => void): Request<Kendra.Types.CreateIndexResponse, AWSError>;
|
|
90
90
|
/**
|
|
91
|
-
* Creates a new Amazon Kendra index. Index creation is an asynchronous
|
|
91
|
+
* Creates a new Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use. Once the index is active you can index your documents using the BatchPutDocument API or using one of the supported data sources.
|
|
92
92
|
*/
|
|
93
93
|
createIndex(callback?: (err: AWSError, data: Kendra.Types.CreateIndexResponse) => void): Request<Kendra.Types.CreateIndexResponse, AWSError>;
|
|
94
94
|
/**
|
|
@@ -108,11 +108,11 @@ declare class Kendra extends Service {
|
|
|
108
108
|
*/
|
|
109
109
|
createThesaurus(callback?: (err: AWSError, data: Kendra.Types.CreateThesaurusResponse) => void): Request<Kendra.Types.CreateThesaurusResponse, AWSError>;
|
|
110
110
|
/**
|
|
111
|
-
* Deletes an Amazon Kendra data source. An exception is not thrown if the data source is already being deleted. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource
|
|
111
|
+
* Deletes an Amazon Kendra data source. An exception is not thrown if the data source is already being deleted. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING. For more information, see Deleting Data Sources.
|
|
112
112
|
*/
|
|
113
113
|
deleteDataSource(params: Kendra.Types.DeleteDataSourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
114
114
|
/**
|
|
115
|
-
* Deletes an Amazon Kendra data source. An exception is not thrown if the data source is already being deleted. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource
|
|
115
|
+
* Deletes an Amazon Kendra data source. An exception is not thrown if the data source is already being deleted. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING. For more information, see Deleting Data Sources.
|
|
116
116
|
*/
|
|
117
117
|
deleteDataSource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
118
118
|
/**
|
|
@@ -132,11 +132,11 @@ declare class Kendra extends Service {
|
|
|
132
132
|
*/
|
|
133
133
|
deleteFaq(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
134
134
|
/**
|
|
135
|
-
* Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the Status field returned by a call to the DescribeIndex
|
|
135
|
+
* Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the Status field returned by a call to the DescribeIndex API is set to DELETING.
|
|
136
136
|
*/
|
|
137
137
|
deleteIndex(params: Kendra.Types.DeleteIndexRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
138
138
|
/**
|
|
139
|
-
* Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the Status field returned by a call to the DescribeIndex
|
|
139
|
+
* Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the Status field returned by a call to the DescribeIndex API is set to DELETING.
|
|
140
140
|
*/
|
|
141
141
|
deleteIndex(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
142
142
|
/**
|
|
@@ -164,11 +164,11 @@ declare class Kendra extends Service {
|
|
|
164
164
|
*/
|
|
165
165
|
deleteThesaurus(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
166
166
|
/**
|
|
167
|
-
* Gets information about
|
|
167
|
+
* Gets information about an Amazon Kendra data source.
|
|
168
168
|
*/
|
|
169
169
|
describeDataSource(params: Kendra.Types.DescribeDataSourceRequest, callback?: (err: AWSError, data: Kendra.Types.DescribeDataSourceResponse) => void): Request<Kendra.Types.DescribeDataSourceResponse, AWSError>;
|
|
170
170
|
/**
|
|
171
|
-
* Gets information about
|
|
171
|
+
* Gets information about an Amazon Kendra data source.
|
|
172
172
|
*/
|
|
173
173
|
describeDataSource(callback?: (err: AWSError, data: Kendra.Types.DescribeDataSourceResponse) => void): Request<Kendra.Types.DescribeDataSourceResponse, AWSError>;
|
|
174
174
|
/**
|
|
@@ -188,11 +188,11 @@ declare class Kendra extends Service {
|
|
|
188
188
|
*/
|
|
189
189
|
describeFaq(callback?: (err: AWSError, data: Kendra.Types.DescribeFaqResponse) => void): Request<Kendra.Types.DescribeFaqResponse, AWSError>;
|
|
190
190
|
/**
|
|
191
|
-
* Describes an existing Amazon Kendra index
|
|
191
|
+
* Describes an existing Amazon Kendra index.
|
|
192
192
|
*/
|
|
193
193
|
describeIndex(params: Kendra.Types.DescribeIndexRequest, callback?: (err: AWSError, data: Kendra.Types.DescribeIndexResponse) => void): Request<Kendra.Types.DescribeIndexResponse, AWSError>;
|
|
194
194
|
/**
|
|
195
|
-
* Describes an existing Amazon Kendra index
|
|
195
|
+
* Describes an existing Amazon Kendra index.
|
|
196
196
|
*/
|
|
197
197
|
describeIndex(callback?: (err: AWSError, data: Kendra.Types.DescribeIndexResponse) => void): Request<Kendra.Types.DescribeIndexResponse, AWSError>;
|
|
198
198
|
/**
|
|
@@ -316,11 +316,11 @@ declare class Kendra extends Service {
|
|
|
316
316
|
*/
|
|
317
317
|
listGroupsOlderThanOrderingId(callback?: (err: AWSError, data: Kendra.Types.ListGroupsOlderThanOrderingIdResponse) => void): Request<Kendra.Types.ListGroupsOlderThanOrderingIdResponse, AWSError>;
|
|
318
318
|
/**
|
|
319
|
-
* Lists the Amazon Kendra indexes that you
|
|
319
|
+
* Lists the Amazon Kendra indexes that you created.
|
|
320
320
|
*/
|
|
321
321
|
listIndices(params: Kendra.Types.ListIndicesRequest, callback?: (err: AWSError, data: Kendra.Types.ListIndicesResponse) => void): Request<Kendra.Types.ListIndicesResponse, AWSError>;
|
|
322
322
|
/**
|
|
323
|
-
* Lists the Amazon Kendra indexes that you
|
|
323
|
+
* Lists the Amazon Kendra indexes that you created.
|
|
324
324
|
*/
|
|
325
325
|
listIndices(callback?: (err: AWSError, data: Kendra.Types.ListIndicesResponse) => void): Request<Kendra.Types.ListIndicesResponse, AWSError>;
|
|
326
326
|
/**
|
|
@@ -356,11 +356,11 @@ declare class Kendra extends Service {
|
|
|
356
356
|
*/
|
|
357
357
|
putPrincipalMapping(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
358
358
|
/**
|
|
359
|
-
* Searches an active index. Use this API to search your documents using query. The Query
|
|
359
|
+
* Searches an active index. Use this API to search your documents using query. The Query API enables to do faceted search and to filter results based on document attributes. It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results. Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results. Relevant passages Matching FAQs Relevant documents You can specify that the query return only one type of result using the QueryResultTypeConfig parameter. Each query returns the 100 most relevant results.
|
|
360
360
|
*/
|
|
361
361
|
query(params: Kendra.Types.QueryRequest, callback?: (err: AWSError, data: Kendra.Types.QueryResult) => void): Request<Kendra.Types.QueryResult, AWSError>;
|
|
362
362
|
/**
|
|
363
|
-
* Searches an active index. Use this API to search your documents using query. The Query
|
|
363
|
+
* Searches an active index. Use this API to search your documents using query. The Query API enables to do faceted search and to filter results based on document attributes. It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results. Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results. Relevant passages Matching FAQs Relevant documents You can specify that the query return only one type of result using the QueryResultTypeConfig parameter. Each query returns the 100 most relevant results.
|
|
364
364
|
*/
|
|
365
365
|
query(callback?: (err: AWSError, data: Kendra.Types.QueryResult) => void): Request<Kendra.Types.QueryResult, AWSError>;
|
|
366
366
|
/**
|
|
@@ -372,11 +372,11 @@ declare class Kendra extends Service {
|
|
|
372
372
|
*/
|
|
373
373
|
startDataSourceSyncJob(callback?: (err: AWSError, data: Kendra.Types.StartDataSourceSyncJobResponse) => void): Request<Kendra.Types.StartDataSourceSyncJobResponse, AWSError>;
|
|
374
374
|
/**
|
|
375
|
-
* Stops a
|
|
375
|
+
* Stops a synchronization job that is currently running. You can't stop a scheduled synchronization job.
|
|
376
376
|
*/
|
|
377
377
|
stopDataSourceSyncJob(params: Kendra.Types.StopDataSourceSyncJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
378
378
|
/**
|
|
379
|
-
* Stops a
|
|
379
|
+
* Stops a synchronization job that is currently running. You can't stop a scheduled synchronization job.
|
|
380
380
|
*/
|
|
381
381
|
stopDataSourceSyncJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
382
382
|
/**
|
|
@@ -461,7 +461,7 @@ declare namespace Kendra {
|
|
|
461
461
|
}
|
|
462
462
|
export interface AclConfiguration {
|
|
463
463
|
/**
|
|
464
|
-
* A list of groups, separated by semi-colons, that filters a query response based on user context. The document is only returned to users that are in one of the groups specified in the UserContext field of the Query
|
|
464
|
+
* A list of groups, separated by semi-colons, that filters a query response based on user context. The document is only returned to users that are in one of the groups specified in the UserContext field of the Query API.
|
|
465
465
|
*/
|
|
466
466
|
AllowedGroupsColumnName: ColumnName;
|
|
467
467
|
}
|
|
@@ -628,7 +628,7 @@ declare namespace Kendra {
|
|
|
628
628
|
export type BatchDeleteDocumentResponseFailedDocuments = BatchDeleteDocumentResponseFailedDocument[];
|
|
629
629
|
export interface BatchGetDocumentStatusRequest {
|
|
630
630
|
/**
|
|
631
|
-
* The identifier of the index to add documents to. The index ID is returned by the
|
|
631
|
+
* The identifier of the index to add documents to. The index ID is returned by the CreateIndex API.
|
|
632
632
|
*/
|
|
633
633
|
IndexId: IndexId;
|
|
634
634
|
/**
|
|
@@ -663,19 +663,19 @@ declare namespace Kendra {
|
|
|
663
663
|
export type BatchGetDocumentStatusResponseErrors = BatchGetDocumentStatusResponseError[];
|
|
664
664
|
export interface BatchPutDocumentRequest {
|
|
665
665
|
/**
|
|
666
|
-
* The identifier of the index to add the documents to. You need to create the index first using the CreateIndex
|
|
666
|
+
* The identifier of the index to add the documents to. You need to create the index first using the CreateIndex API.
|
|
667
667
|
*/
|
|
668
668
|
IndexId: IndexId;
|
|
669
669
|
/**
|
|
670
|
-
* The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument
|
|
670
|
+
* The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument API. For more information, see IAM Roles for Amazon Kendra.
|
|
671
671
|
*/
|
|
672
672
|
RoleArn?: RoleArn;
|
|
673
673
|
/**
|
|
674
|
-
* One or more documents to add to the index. Documents
|
|
674
|
+
* One or more documents to add to the index. Documents have the following file size limits. 5 MB total size for inline documents 50 MB total size for files from an S3 bucket 5 MB extracted text for any file For more information about file size and transaction per second quotas, see Quotas.
|
|
675
675
|
*/
|
|
676
676
|
Documents: DocumentList;
|
|
677
677
|
/**
|
|
678
|
-
* Configuration information for altering your document metadata and content during the document ingestion process when you use the BatchPutDocument
|
|
678
|
+
* Configuration information for altering your document metadata and content during the document ingestion process when you use the BatchPutDocument API. For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.
|
|
679
679
|
*/
|
|
680
680
|
CustomDocumentEnrichmentConfiguration?: CustomDocumentEnrichmentConfiguration;
|
|
681
681
|
}
|
|
@@ -702,6 +702,60 @@ declare namespace Kendra {
|
|
|
702
702
|
export type BatchPutDocumentResponseFailedDocuments = BatchPutDocumentResponseFailedDocument[];
|
|
703
703
|
export type _Blob = Buffer|Uint8Array|Blob|string;
|
|
704
704
|
export type Boolean = boolean;
|
|
705
|
+
export interface BoxConfiguration {
|
|
706
|
+
/**
|
|
707
|
+
* The identifier of the Box Enterprise platform. You can find the enterprise ID in the Box Developer Console settings or when you create an app in Box and download your authentication credentials. For example, 801234567.
|
|
708
|
+
*/
|
|
709
|
+
EnterpriseId: EnterpriseId;
|
|
710
|
+
/**
|
|
711
|
+
* The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Box platform. The secret must contain a JSON structure with the following keys: clientID—The identifier of the client OAuth 2.0 authentication application created in Box. clientSecret—A set of characters known only to the OAuth 2.0 authentication application created in Box. publicKeyId—The identifier of the public key contained within an identity certificate. privateKey—A set of characters that make up an encryption key. passphrase—A set of characters that act like a password. You create an application in Box to generate the keys or credentials required for the secret. For more information, see Authentication for a Box data source.
|
|
712
|
+
*/
|
|
713
|
+
SecretArn: SecretArn;
|
|
714
|
+
/**
|
|
715
|
+
* TRUE to use the Slack change log to determine which documents require updating in the index. Depending on the data source change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents.
|
|
716
|
+
*/
|
|
717
|
+
UseChangeLog?: Boolean;
|
|
718
|
+
/**
|
|
719
|
+
* TRUE to index comments.
|
|
720
|
+
*/
|
|
721
|
+
CrawlComments?: Boolean;
|
|
722
|
+
/**
|
|
723
|
+
* TRUE to index the contents of tasks.
|
|
724
|
+
*/
|
|
725
|
+
CrawlTasks?: Boolean;
|
|
726
|
+
/**
|
|
727
|
+
* TRUE to index web links.
|
|
728
|
+
*/
|
|
729
|
+
CrawlWebLinks?: Boolean;
|
|
730
|
+
/**
|
|
731
|
+
* A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Box files to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Box fields. For more information, see Mapping data source fields. The Box field names must exist in your Box custom metadata.
|
|
732
|
+
*/
|
|
733
|
+
FileFieldMappings?: DataSourceToIndexFieldMappingList;
|
|
734
|
+
/**
|
|
735
|
+
* A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Box tasks to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Box fields. For more information, see Mapping data source fields. The Box field names must exist in your Box custom metadata.
|
|
736
|
+
*/
|
|
737
|
+
TaskFieldMappings?: DataSourceToIndexFieldMappingList;
|
|
738
|
+
/**
|
|
739
|
+
* A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Box comments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Box fields. For more information, see Mapping data source fields. The Box field names must exist in your Box custom metadata.
|
|
740
|
+
*/
|
|
741
|
+
CommentFieldMappings?: DataSourceToIndexFieldMappingList;
|
|
742
|
+
/**
|
|
743
|
+
* A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Box web links to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Box fields. For more information, see Mapping data source fields. The Box field names must exist in your Box custom metadata.
|
|
744
|
+
*/
|
|
745
|
+
WebLinkFieldMappings?: DataSourceToIndexFieldMappingList;
|
|
746
|
+
/**
|
|
747
|
+
* A list of regular expression patterns to include certain files and folders in your Box platform. Files and folders that match the patterns are included in the index. Files and folders that don't match the patterns are excluded from the index. If a file or folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file or folder isn't included in the index.
|
|
748
|
+
*/
|
|
749
|
+
InclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
|
750
|
+
/**
|
|
751
|
+
* A list of regular expression patterns to exclude certain files and folders from your Box platform. Files and folders that match the patterns are excluded from the index.Files and folders that don't match the patterns are included in the index. If a file or folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file or folder isn't included in the index.
|
|
752
|
+
*/
|
|
753
|
+
ExclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
|
754
|
+
/**
|
|
755
|
+
* Configuration information for an Amazon VPC to connect to your Box. For more information, see Configuring a VPC.
|
|
756
|
+
*/
|
|
757
|
+
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
758
|
+
}
|
|
705
759
|
export interface CapacityUnitsConfiguration {
|
|
706
760
|
/**
|
|
707
761
|
* The amount of extra storage capacity for an index. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first.
|
|
@@ -746,7 +800,7 @@ declare namespace Kendra {
|
|
|
746
800
|
*/
|
|
747
801
|
DocumentTitleColumnName?: ColumnName;
|
|
748
802
|
/**
|
|
749
|
-
* An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex
|
|
803
|
+
* An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex API.
|
|
750
804
|
*/
|
|
751
805
|
FieldMappings?: DataSourceToIndexFieldMappingList;
|
|
752
806
|
/**
|
|
@@ -762,7 +816,7 @@ declare namespace Kendra {
|
|
|
762
816
|
*/
|
|
763
817
|
CrawlAttachments?: Boolean;
|
|
764
818
|
/**
|
|
765
|
-
*
|
|
819
|
+
* Maps attributes or field names of Confluence attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The Confluence data source field names must exist in your Confluence custom metadata. If you specify the AttachentFieldMappings parameter, you must specify at least one field mapping.
|
|
766
820
|
*/
|
|
767
821
|
AttachmentFieldMappings?: ConfluenceAttachmentFieldMappingsList;
|
|
768
822
|
}
|
|
@@ -770,7 +824,7 @@ declare namespace Kendra {
|
|
|
770
824
|
export type ConfluenceAttachmentFieldName = "AUTHOR"|"CONTENT_TYPE"|"CREATED_DATE"|"DISPLAY_URL"|"FILE_SIZE"|"ITEM_TYPE"|"PARENT_ID"|"SPACE_KEY"|"SPACE_NAME"|"URL"|"VERSION"|string;
|
|
771
825
|
export interface ConfluenceAttachmentToIndexFieldMapping {
|
|
772
826
|
/**
|
|
773
|
-
* The name of the field in the data source. You must first create the index field using the UpdateIndex
|
|
827
|
+
* The name of the field in the data source. You must first create the index field using the UpdateIndex API.
|
|
774
828
|
*/
|
|
775
829
|
DataSourceFieldName?: ConfluenceAttachmentFieldName;
|
|
776
830
|
/**
|
|
@@ -784,7 +838,7 @@ declare namespace Kendra {
|
|
|
784
838
|
}
|
|
785
839
|
export interface ConfluenceBlogConfiguration {
|
|
786
840
|
/**
|
|
787
|
-
*
|
|
841
|
+
* Maps attributes or field names of Confluence blogs to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The Confluence data source field names must exist in your Confluence custom metadata. If you specify the BlogFieldMappings parameter, you must specify at least one field mapping.
|
|
788
842
|
*/
|
|
789
843
|
BlogFieldMappings?: ConfluenceBlogFieldMappingsList;
|
|
790
844
|
}
|
|
@@ -810,7 +864,7 @@ declare namespace Kendra {
|
|
|
810
864
|
*/
|
|
811
865
|
ServerUrl: Url;
|
|
812
866
|
/**
|
|
813
|
-
* The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key
|
|
867
|
+
* The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Confluence server. The secret must contain a JSON structure with the following keys: username—The user name or email address of a user with administrative privileges for the Confluence server. password—The password associated with the user logging in to the Confluence server.
|
|
814
868
|
*/
|
|
815
869
|
SecretArn: SecretArn;
|
|
816
870
|
/**
|
|
@@ -818,37 +872,37 @@ declare namespace Kendra {
|
|
|
818
872
|
*/
|
|
819
873
|
Version: ConfluenceVersion;
|
|
820
874
|
/**
|
|
821
|
-
*
|
|
875
|
+
* Configuration information for indexing Confluence spaces.
|
|
822
876
|
*/
|
|
823
877
|
SpaceConfiguration?: ConfluenceSpaceConfiguration;
|
|
824
878
|
/**
|
|
825
|
-
*
|
|
879
|
+
* Configuration information for indexing Confluence pages.
|
|
826
880
|
*/
|
|
827
881
|
PageConfiguration?: ConfluencePageConfiguration;
|
|
828
882
|
/**
|
|
829
|
-
*
|
|
883
|
+
* Configuration information for indexing Confluence blogs.
|
|
830
884
|
*/
|
|
831
885
|
BlogConfiguration?: ConfluenceBlogConfiguration;
|
|
832
886
|
/**
|
|
833
|
-
*
|
|
887
|
+
* Configuration information for indexing attachments to Confluence blogs and pages.
|
|
834
888
|
*/
|
|
835
889
|
AttachmentConfiguration?: ConfluenceAttachmentConfiguration;
|
|
836
890
|
/**
|
|
837
|
-
*
|
|
891
|
+
* Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC.
|
|
838
892
|
*/
|
|
839
893
|
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
840
894
|
/**
|
|
841
|
-
* A list of regular expression patterns
|
|
895
|
+
* A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are included in the index. Content that doesn't match the patterns is excluded from the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.
|
|
842
896
|
*/
|
|
843
897
|
InclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
|
844
898
|
/**
|
|
845
|
-
* A list of regular expression patterns
|
|
899
|
+
* >A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are excluded from the index. Content that doesn't match the patterns is included in the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.
|
|
846
900
|
*/
|
|
847
901
|
ExclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
|
848
902
|
}
|
|
849
903
|
export interface ConfluencePageConfiguration {
|
|
850
904
|
/**
|
|
851
|
-
*
|
|
905
|
+
* >Maps attributes or field names of Confluence pages to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The Confluence data source field names must exist in your Confluence custom metadata. If you specify the PageFieldMappings parameter, you must specify at least one field mapping.
|
|
852
906
|
*/
|
|
853
907
|
PageFieldMappings?: ConfluencePageFieldMappingsList;
|
|
854
908
|
}
|
|
@@ -856,7 +910,7 @@ declare namespace Kendra {
|
|
|
856
910
|
export type ConfluencePageFieldName = "AUTHOR"|"CONTENT_STATUS"|"CREATED_DATE"|"DISPLAY_URL"|"ITEM_TYPE"|"LABELS"|"MODIFIED_DATE"|"PARENT_ID"|"SPACE_KEY"|"SPACE_NAME"|"URL"|"VERSION"|string;
|
|
857
911
|
export interface ConfluencePageToIndexFieldMapping {
|
|
858
912
|
/**
|
|
859
|
-
* The name of the field in the data source.
|
|
913
|
+
* The name of the field in the data source.
|
|
860
914
|
*/
|
|
861
915
|
DataSourceFieldName?: ConfluencePageFieldName;
|
|
862
916
|
/**
|
|
@@ -886,7 +940,7 @@ declare namespace Kendra {
|
|
|
886
940
|
*/
|
|
887
941
|
ExcludeSpaces?: ConfluenceSpaceList;
|
|
888
942
|
/**
|
|
889
|
-
*
|
|
943
|
+
* Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The Confluence data source field names must exist in your Confluence custom metadata. If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.
|
|
890
944
|
*/
|
|
891
945
|
SpaceFieldMappings?: ConfluenceSpaceFieldMappingsList;
|
|
892
946
|
}
|
|
@@ -941,11 +995,30 @@ declare namespace Kendra {
|
|
|
941
995
|
*/
|
|
942
996
|
FaqIds?: FaqIdsList;
|
|
943
997
|
/**
|
|
944
|
-
* TRUE to use documents you indexed directly using the BatchPutDocument
|
|
998
|
+
* TRUE to use documents you indexed directly using the BatchPutDocument API.
|
|
945
999
|
*/
|
|
946
1000
|
DirectPutContent?: Boolean;
|
|
947
1001
|
}
|
|
948
1002
|
export type ContentType = "PDF"|"HTML"|"MS_WORD"|"PLAIN_TEXT"|"PPT"|string;
|
|
1003
|
+
export interface Correction {
|
|
1004
|
+
/**
|
|
1005
|
+
* The zero-based location in the response string or text where the corrected word starts.
|
|
1006
|
+
*/
|
|
1007
|
+
BeginOffset?: Integer;
|
|
1008
|
+
/**
|
|
1009
|
+
* The zero-based location in the response string or text where the corrected word ends.
|
|
1010
|
+
*/
|
|
1011
|
+
EndOffset?: Integer;
|
|
1012
|
+
/**
|
|
1013
|
+
* The string or text of a misspelled word in a query.
|
|
1014
|
+
*/
|
|
1015
|
+
Term?: String;
|
|
1016
|
+
/**
|
|
1017
|
+
* The string or text of a corrected misspelled word in a query.
|
|
1018
|
+
*/
|
|
1019
|
+
CorrectedTerm?: String;
|
|
1020
|
+
}
|
|
1021
|
+
export type CorrectionList = Correction[];
|
|
949
1022
|
export type CrawlDepth = number;
|
|
950
1023
|
export interface CreateDataSourceRequest {
|
|
951
1024
|
/**
|
|
@@ -961,7 +1034,7 @@ declare namespace Kendra {
|
|
|
961
1034
|
*/
|
|
962
1035
|
Type: DataSourceType;
|
|
963
1036
|
/**
|
|
964
|
-
*
|
|
1037
|
+
* Configuration information that is required to access the data source repository. You can't specify the Configuration parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception. The Configuration parameter is required for all other data sources.
|
|
965
1038
|
*/
|
|
966
1039
|
Configuration?: DataSourceConfiguration;
|
|
967
1040
|
/**
|
|
@@ -969,7 +1042,7 @@ declare namespace Kendra {
|
|
|
969
1042
|
*/
|
|
970
1043
|
Description?: Description;
|
|
971
1044
|
/**
|
|
972
|
-
* Sets the frequency
|
|
1045
|
+
* Sets the frequency for Amazon Kendra to check the documents in your repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the StartDataSourceSyncJob API to update the index. You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.
|
|
973
1046
|
*/
|
|
974
1047
|
Schedule?: ScanSchedule;
|
|
975
1048
|
/**
|
|
@@ -981,7 +1054,7 @@ declare namespace Kendra {
|
|
|
981
1054
|
*/
|
|
982
1055
|
Tags?: TagList;
|
|
983
1056
|
/**
|
|
984
|
-
* A token that you provide to identify the request to create a data source. Multiple calls to the CreateDataSource
|
|
1057
|
+
* A token that you provide to identify the request to create a data source. Multiple calls to the CreateDataSource API with the same client token will create only one data source.
|
|
985
1058
|
*/
|
|
986
1059
|
ClientToken?: ClientTokenName;
|
|
987
1060
|
/**
|
|
@@ -1009,11 +1082,11 @@ declare namespace Kendra {
|
|
|
1009
1082
|
*/
|
|
1010
1083
|
IndexId: IndexId;
|
|
1011
1084
|
/**
|
|
1012
|
-
* The Amazon Resource Name (ARN) of a role with permission to access Query
|
|
1085
|
+
* The Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and Amazon Web Services SSO that stores your user and group information. For more information, see IAM roles for Amazon Kendra.
|
|
1013
1086
|
*/
|
|
1014
1087
|
RoleArn?: RoleArn;
|
|
1015
1088
|
/**
|
|
1016
|
-
*
|
|
1089
|
+
* Configuration information for your Amazon Kendra experience. This includes ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user or group information to grant access to your Amazon Kendra experience.
|
|
1017
1090
|
*/
|
|
1018
1091
|
Configuration?: ExperienceConfiguration;
|
|
1019
1092
|
/**
|
|
@@ -1021,7 +1094,7 @@ declare namespace Kendra {
|
|
|
1021
1094
|
*/
|
|
1022
1095
|
Description?: Description;
|
|
1023
1096
|
/**
|
|
1024
|
-
* A token that you provide to identify the request to create your Amazon Kendra experience. Multiple calls to the CreateExperience
|
|
1097
|
+
* A token that you provide to identify the request to create your Amazon Kendra experience. Multiple calls to the CreateExperience API with the same client token creates only one Amazon Kendra experience.
|
|
1025
1098
|
*/
|
|
1026
1099
|
ClientToken?: ClientTokenName;
|
|
1027
1100
|
}
|
|
@@ -1061,7 +1134,7 @@ declare namespace Kendra {
|
|
|
1061
1134
|
*/
|
|
1062
1135
|
FileFormat?: FaqFileFormat;
|
|
1063
1136
|
/**
|
|
1064
|
-
* A token that you provide to identify the request to create a FAQ. Multiple calls to the CreateFaqRequest
|
|
1137
|
+
* A token that you provide to identify the request to create a FAQ. Multiple calls to the CreateFaqRequest API with the same client token will create only one FAQ.
|
|
1065
1138
|
*/
|
|
1066
1139
|
ClientToken?: ClientTokenName;
|
|
1067
1140
|
/**
|
|
@@ -1085,11 +1158,11 @@ declare namespace Kendra {
|
|
|
1085
1158
|
*/
|
|
1086
1159
|
Edition?: IndexEdition;
|
|
1087
1160
|
/**
|
|
1088
|
-
* An Identity and Access Management(IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role
|
|
1161
|
+
* An Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role you use when you call the BatchPutDocument API to index documents from an Amazon S3 bucket.
|
|
1089
1162
|
*/
|
|
1090
1163
|
RoleArn: RoleArn;
|
|
1091
1164
|
/**
|
|
1092
|
-
* The identifier of the
|
|
1165
|
+
* The identifier of the KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.
|
|
1093
1166
|
*/
|
|
1094
1167
|
ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
1095
1168
|
/**
|
|
@@ -1097,7 +1170,7 @@ declare namespace Kendra {
|
|
|
1097
1170
|
*/
|
|
1098
1171
|
Description?: Description;
|
|
1099
1172
|
/**
|
|
1100
|
-
* A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex
|
|
1173
|
+
* A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.
|
|
1101
1174
|
*/
|
|
1102
1175
|
ClientToken?: ClientTokenName;
|
|
1103
1176
|
/**
|
|
@@ -1145,7 +1218,7 @@ declare namespace Kendra {
|
|
|
1145
1218
|
*/
|
|
1146
1219
|
ClientToken?: ClientTokenName;
|
|
1147
1220
|
/**
|
|
1148
|
-
* The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket. You need permissions to the role ARN (Amazon Resource Name). The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.
|
|
1221
|
+
* The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket. You need permissions to the role ARN (Amazon Web Services Resource Name). The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.
|
|
1149
1222
|
*/
|
|
1150
1223
|
RoleArn: RoleArn;
|
|
1151
1224
|
/**
|
|
@@ -1185,7 +1258,7 @@ declare namespace Kendra {
|
|
|
1185
1258
|
*/
|
|
1186
1259
|
SourceS3Path: S3Path;
|
|
1187
1260
|
/**
|
|
1188
|
-
* A token that you provide to identify the request to create a thesaurus. Multiple calls to the CreateThesaurus
|
|
1261
|
+
* A token that you provide to identify the request to create a thesaurus. Multiple calls to the CreateThesaurus API with the same client token will create only one thesaurus.
|
|
1189
1262
|
*/
|
|
1190
1263
|
ClientToken?: ClientTokenName;
|
|
1191
1264
|
}
|
|
@@ -1215,42 +1288,62 @@ declare namespace Kendra {
|
|
|
1215
1288
|
}
|
|
1216
1289
|
export interface DataSourceConfiguration {
|
|
1217
1290
|
/**
|
|
1218
|
-
* Provides information to
|
|
1291
|
+
* Provides the configuration information to connect to an Amazon S3 bucket as your data source.
|
|
1219
1292
|
*/
|
|
1220
1293
|
S3Configuration?: S3DataSourceConfiguration;
|
|
1221
1294
|
/**
|
|
1222
|
-
* Provides information
|
|
1295
|
+
* Provides the configuration information to connect to Microsoft SharePoint as your data source.
|
|
1223
1296
|
*/
|
|
1224
1297
|
SharePointConfiguration?: SharePointConfiguration;
|
|
1225
1298
|
/**
|
|
1226
|
-
* Provides information
|
|
1299
|
+
* Provides the configuration information to connect to a database as your data source.
|
|
1227
1300
|
*/
|
|
1228
1301
|
DatabaseConfiguration?: DatabaseConfiguration;
|
|
1229
1302
|
/**
|
|
1230
|
-
* Provides configuration information
|
|
1303
|
+
* Provides the configuration information to connect to Salesforce as your data source.
|
|
1231
1304
|
*/
|
|
1232
1305
|
SalesforceConfiguration?: SalesforceConfiguration;
|
|
1233
1306
|
/**
|
|
1234
|
-
* Provides configuration
|
|
1307
|
+
* Provides the configuration information to connect to Microsoft OneDrive as your data source.
|
|
1235
1308
|
*/
|
|
1236
1309
|
OneDriveConfiguration?: OneDriveConfiguration;
|
|
1237
1310
|
/**
|
|
1238
|
-
* Provides configuration
|
|
1311
|
+
* Provides the configuration information to connect to ServiceNow as your data source.
|
|
1239
1312
|
*/
|
|
1240
1313
|
ServiceNowConfiguration?: ServiceNowConfiguration;
|
|
1241
1314
|
/**
|
|
1242
|
-
* Provides configuration information
|
|
1315
|
+
* Provides the configuration information to connect to Confluence as your data source.
|
|
1243
1316
|
*/
|
|
1244
1317
|
ConfluenceConfiguration?: ConfluenceConfiguration;
|
|
1245
1318
|
/**
|
|
1246
|
-
* Provides configuration
|
|
1319
|
+
* Provides the configuration information to connect to Google Drive as your data source.
|
|
1247
1320
|
*/
|
|
1248
1321
|
GoogleDriveConfiguration?: GoogleDriveConfiguration;
|
|
1249
1322
|
WebCrawlerConfiguration?: WebCrawlerConfiguration;
|
|
1250
1323
|
/**
|
|
1251
|
-
* Provides the configuration information to connect to WorkDocs as your data source.
|
|
1324
|
+
* Provides the configuration information to connect to Amazon WorkDocs as your data source.
|
|
1252
1325
|
*/
|
|
1253
1326
|
WorkDocsConfiguration?: WorkDocsConfiguration;
|
|
1327
|
+
/**
|
|
1328
|
+
* Provides the configuration information to connect to Amazon FSx as your data source.
|
|
1329
|
+
*/
|
|
1330
|
+
FsxConfiguration?: FsxConfiguration;
|
|
1331
|
+
/**
|
|
1332
|
+
* Provides the configuration information to connect to Slack as your data source.
|
|
1333
|
+
*/
|
|
1334
|
+
SlackConfiguration?: SlackConfiguration;
|
|
1335
|
+
/**
|
|
1336
|
+
* Provides the configuration information to connect to Box as your data source.
|
|
1337
|
+
*/
|
|
1338
|
+
BoxConfiguration?: BoxConfiguration;
|
|
1339
|
+
/**
|
|
1340
|
+
* Provides the configuration information to connect to Quip as your data source.
|
|
1341
|
+
*/
|
|
1342
|
+
QuipConfiguration?: QuipConfiguration;
|
|
1343
|
+
/**
|
|
1344
|
+
* Provides the configuration information to connect to Jira as your data source.
|
|
1345
|
+
*/
|
|
1346
|
+
JiraConfiguration?: JiraConfiguration;
|
|
1254
1347
|
}
|
|
1255
1348
|
export type DataSourceDateFieldFormat = string;
|
|
1256
1349
|
export type DataSourceFieldName = string;
|
|
@@ -1308,11 +1401,11 @@ declare namespace Kendra {
|
|
|
1308
1401
|
*/
|
|
1309
1402
|
ExecutionId?: String;
|
|
1310
1403
|
/**
|
|
1311
|
-
* The UNIX datetime that the synchronization job
|
|
1404
|
+
* The UNIX datetime that the synchronization job started.
|
|
1312
1405
|
*/
|
|
1313
1406
|
StartTime?: Timestamp;
|
|
1314
1407
|
/**
|
|
1315
|
-
* The UNIX datetime that the synchronization job
|
|
1408
|
+
* The UNIX datetime that the synchronization job completed.
|
|
1316
1409
|
*/
|
|
1317
1410
|
EndTime?: Timestamp;
|
|
1318
1411
|
/**
|
|
@@ -1324,7 +1417,7 @@ declare namespace Kendra {
|
|
|
1324
1417
|
*/
|
|
1325
1418
|
ErrorMessage?: ErrorMessage;
|
|
1326
1419
|
/**
|
|
1327
|
-
* If the Status field is set to FAILED, the ErrorCode field
|
|
1420
|
+
* If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.
|
|
1328
1421
|
*/
|
|
1329
1422
|
ErrorCode?: ErrorCode;
|
|
1330
1423
|
/**
|
|
@@ -1386,7 +1479,7 @@ declare namespace Kendra {
|
|
|
1386
1479
|
IndexFieldName: IndexFieldName;
|
|
1387
1480
|
}
|
|
1388
1481
|
export type DataSourceToIndexFieldMappingList = DataSourceToIndexFieldMapping[];
|
|
1389
|
-
export type DataSourceType = "S3"|"SHAREPOINT"|"DATABASE"|"SALESFORCE"|"ONEDRIVE"|"SERVICENOW"|"CUSTOM"|"CONFLUENCE"|"GOOGLEDRIVE"|"WEBCRAWLER"|"WORKDOCS"|string;
|
|
1482
|
+
export type DataSourceType = "S3"|"SHAREPOINT"|"DATABASE"|"SALESFORCE"|"ONEDRIVE"|"SERVICENOW"|"CUSTOM"|"CONFLUENCE"|"GOOGLEDRIVE"|"WEBCRAWLER"|"WORKDOCS"|"FSX"|"SLACK"|"BOX"|"QUIP"|"JIRA"|string;
|
|
1390
1483
|
export interface DataSourceVpcConfiguration {
|
|
1391
1484
|
/**
|
|
1392
1485
|
* A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.
|
|
@@ -1403,7 +1496,7 @@ declare namespace Kendra {
|
|
|
1403
1496
|
*/
|
|
1404
1497
|
DatabaseEngineType: DatabaseEngineType;
|
|
1405
1498
|
/**
|
|
1406
|
-
*
|
|
1499
|
+
* Configuration information that's required to connect to a database.
|
|
1407
1500
|
*/
|
|
1408
1501
|
ConnectionConfiguration: ConnectionConfiguration;
|
|
1409
1502
|
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
@@ -1528,7 +1621,7 @@ declare namespace Kendra {
|
|
|
1528
1621
|
*/
|
|
1529
1622
|
Type?: DataSourceType;
|
|
1530
1623
|
/**
|
|
1531
|
-
*
|
|
1624
|
+
* Describes how the data source is configured. The specific information in the description depends on the data source provider.
|
|
1532
1625
|
*/
|
|
1533
1626
|
Configuration?: DataSourceConfiguration;
|
|
1534
1627
|
/**
|
|
@@ -1548,7 +1641,7 @@ declare namespace Kendra {
|
|
|
1548
1641
|
*/
|
|
1549
1642
|
Status?: DataSourceStatus;
|
|
1550
1643
|
/**
|
|
1551
|
-
* The schedule
|
|
1644
|
+
* The schedule for Amazon Kendra to update the index.
|
|
1552
1645
|
*/
|
|
1553
1646
|
Schedule?: ScanSchedule;
|
|
1554
1647
|
/**
|
|
@@ -1616,7 +1709,7 @@ declare namespace Kendra {
|
|
|
1616
1709
|
*/
|
|
1617
1710
|
Status?: ExperienceStatus;
|
|
1618
1711
|
/**
|
|
1619
|
-
* Shows the Amazon Resource Name (ARN) of a role with permission to access Query
|
|
1712
|
+
* Shows the Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and Amazon Web Services SSO that stores your user and group information.
|
|
1620
1713
|
*/
|
|
1621
1714
|
RoleArn?: RoleArn;
|
|
1622
1715
|
/**
|
|
@@ -1683,7 +1776,7 @@ declare namespace Kendra {
|
|
|
1683
1776
|
}
|
|
1684
1777
|
export interface DescribeIndexRequest {
|
|
1685
1778
|
/**
|
|
1686
|
-
* The
|
|
1779
|
+
* The identifier of the index to describe.
|
|
1687
1780
|
*/
|
|
1688
1781
|
Id: IndexId;
|
|
1689
1782
|
}
|
|
@@ -1693,7 +1786,7 @@ declare namespace Kendra {
|
|
|
1693
1786
|
*/
|
|
1694
1787
|
Name?: IndexName;
|
|
1695
1788
|
/**
|
|
1696
|
-
* The
|
|
1789
|
+
* The identifier of the index.
|
|
1697
1790
|
*/
|
|
1698
1791
|
Id?: IndexId;
|
|
1699
1792
|
/**
|
|
@@ -1705,7 +1798,7 @@ declare namespace Kendra {
|
|
|
1705
1798
|
*/
|
|
1706
1799
|
RoleArn?: RoleArn;
|
|
1707
1800
|
/**
|
|
1708
|
-
* The identifier of the KMScustomer master key (CMK) used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.
|
|
1801
|
+
* The identifier of the KMScustomer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.
|
|
1709
1802
|
*/
|
|
1710
1803
|
ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
1711
1804
|
/**
|
|
@@ -1713,7 +1806,7 @@ declare namespace Kendra {
|
|
|
1713
1806
|
*/
|
|
1714
1807
|
Status?: IndexStatus;
|
|
1715
1808
|
/**
|
|
1716
|
-
* The description
|
|
1809
|
+
* The description for the index.
|
|
1717
1810
|
*/
|
|
1718
1811
|
Description?: Description;
|
|
1719
1812
|
/**
|
|
@@ -1733,11 +1826,11 @@ declare namespace Kendra {
|
|
|
1733
1826
|
*/
|
|
1734
1827
|
IndexStatistics?: IndexStatistics;
|
|
1735
1828
|
/**
|
|
1736
|
-
* When
|
|
1829
|
+
* When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
|
|
1737
1830
|
*/
|
|
1738
1831
|
ErrorMessage?: ErrorMessage;
|
|
1739
1832
|
/**
|
|
1740
|
-
* For Enterprise
|
|
1833
|
+
* For Enterprise Edition indexes, you can choose to use additional capacity to meet the needs of your application. This contains the capacity units used for the index. A query or document storage capacity of zero indicates that the index is using the default capacity. For more information on the default capacity for an index and adjusting this, see Adjusting capacity.
|
|
1741
1834
|
*/
|
|
1742
1835
|
CapacityUnits?: CapacityUnitsConfiguration;
|
|
1743
1836
|
/**
|
|
@@ -1853,7 +1946,7 @@ declare namespace Kendra {
|
|
|
1853
1946
|
}
|
|
1854
1947
|
export interface DescribeQuerySuggestionsConfigResponse {
|
|
1855
1948
|
/**
|
|
1856
|
-
* Shows whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode. By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig
|
|
1949
|
+
* Shows whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode. By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig API.
|
|
1857
1950
|
*/
|
|
1858
1951
|
Mode?: Mode;
|
|
1859
1952
|
/**
|
|
@@ -2002,12 +2095,12 @@ declare namespace Kendra {
|
|
|
2002
2095
|
*/
|
|
2003
2096
|
Title?: Title;
|
|
2004
2097
|
/**
|
|
2005
|
-
* The contents of the document. Documents passed to the Blob parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Kendra
|
|
2098
|
+
* The contents of the document. Documents passed to the Blob parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Kendra APIs. If you are calling the Amazon Kendra endpoint directly using REST, you must base64 encode the contents before sending.
|
|
2006
2099
|
*/
|
|
2007
2100
|
Blob?: _Blob;
|
|
2008
2101
|
S3Path?: S3Path;
|
|
2009
2102
|
/**
|
|
2010
|
-
* Custom attributes to apply to the document. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response.
|
|
2103
|
+
* Custom attributes to apply to the document. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response. For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.
|
|
2011
2104
|
*/
|
|
2012
2105
|
Attributes?: DocumentAttributeList;
|
|
2013
2106
|
/**
|
|
@@ -2086,13 +2179,17 @@ declare namespace Kendra {
|
|
|
2086
2179
|
}
|
|
2087
2180
|
export interface DocumentAttributeValueCountPair {
|
|
2088
2181
|
/**
|
|
2089
|
-
* The value of the attribute. For example, "HR.
|
|
2182
|
+
* The value of the attribute. For example, "HR".
|
|
2090
2183
|
*/
|
|
2091
2184
|
DocumentAttributeValue?: DocumentAttributeValue;
|
|
2092
2185
|
/**
|
|
2093
2186
|
* The number of documents in the response that have the attribute value for the key.
|
|
2094
2187
|
*/
|
|
2095
2188
|
Count?: Integer;
|
|
2189
|
+
/**
|
|
2190
|
+
* Contains the results of a document attribute that is a nested facet. A FacetResult contains the counts for each facet nested within a facet. For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.
|
|
2191
|
+
*/
|
|
2192
|
+
FacetResults?: FacetResultList;
|
|
2096
2193
|
}
|
|
2097
2194
|
export type DocumentAttributeValueCountPairList = DocumentAttributeValueCountPair[];
|
|
2098
2195
|
export type DocumentAttributeValueType = "STRING_VALUE"|"STRING_LIST_VALUE"|"LONG_VALUE"|"DATE_VALUE"|string;
|
|
@@ -2147,9 +2244,11 @@ declare namespace Kendra {
|
|
|
2147
2244
|
*/
|
|
2148
2245
|
S3Prefix?: S3ObjectKey;
|
|
2149
2246
|
}
|
|
2247
|
+
export type Domain = string;
|
|
2150
2248
|
export type Duration = string;
|
|
2151
2249
|
export type Endpoint = string;
|
|
2152
2250
|
export type EndpointType = "HOME"|string;
|
|
2251
|
+
export type EnterpriseId = string;
|
|
2153
2252
|
export interface EntityConfiguration {
|
|
2154
2253
|
/**
|
|
2155
2254
|
* The identifier of a user or group in your Amazon Web Services SSO identity source. For example, a user ID could be an email.
|
|
@@ -2203,7 +2302,7 @@ declare namespace Kendra {
|
|
|
2203
2302
|
export type ExcludeUserAccountsList = UserAccount[];
|
|
2204
2303
|
export interface ExperienceConfiguration {
|
|
2205
2304
|
/**
|
|
2206
|
-
* The identifiers of your data sources and FAQs. Or, you can specify that you want to use documents indexed via the BatchPutDocument
|
|
2305
|
+
* The identifiers of your data sources and FAQs. Or, you can specify that you want to use documents indexed via the BatchPutDocument API. This is the content you want to use for your Amazon Kendra experience.
|
|
2207
2306
|
*/
|
|
2208
2307
|
ContentSourceConfiguration?: ContentSourceConfiguration;
|
|
2209
2308
|
/**
|
|
@@ -2268,6 +2367,14 @@ declare namespace Kendra {
|
|
|
2268
2367
|
* The unique key for the document attribute.
|
|
2269
2368
|
*/
|
|
2270
2369
|
DocumentAttributeKey?: DocumentAttributeKey;
|
|
2370
|
+
/**
|
|
2371
|
+
* An array of document attributes that are nested facets within a facet. For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. This helps your users further narrow their search. You can only have one nested facet within a facet. If you want to increase this limit, contact Support.
|
|
2372
|
+
*/
|
|
2373
|
+
Facets?: FacetList;
|
|
2374
|
+
/**
|
|
2375
|
+
* Maximum number of facet values per facet. The default is 10. You can use this to limit the number of facet values to less than 10. If you want to increase the default, contact Support.
|
|
2376
|
+
*/
|
|
2377
|
+
MaxResults?: TopDocumentAttributeValueCountPairsSize;
|
|
2271
2378
|
}
|
|
2272
2379
|
export type FacetList = Facet[];
|
|
2273
2380
|
export interface FacetResult {
|
|
@@ -2340,6 +2447,40 @@ declare namespace Kendra {
|
|
|
2340
2447
|
}
|
|
2341
2448
|
export type FaqSummaryItems = FaqSummary[];
|
|
2342
2449
|
export type FeedbackToken = string;
|
|
2450
|
+
export type FileSystemId = string;
|
|
2451
|
+
export type FolderId = string;
|
|
2452
|
+
export type FolderIdList = FolderId[];
|
|
2453
|
+
export interface FsxConfiguration {
|
|
2454
|
+
/**
|
|
2455
|
+
* The identifier of the Amazon FSx file system. You can find your file system ID on the file system dashboard in the Amazon FSx console. For information on how to create a file system in Amazon FSx console, using Windows File Server as an example, see Amazon FSx Getting started guide.
|
|
2456
|
+
*/
|
|
2457
|
+
FileSystemId: FileSystemId;
|
|
2458
|
+
/**
|
|
2459
|
+
* The Amazon FSx file system type. Windows is currently the only supported type.
|
|
2460
|
+
*/
|
|
2461
|
+
FileSystemType: FsxFileSystemType;
|
|
2462
|
+
/**
|
|
2463
|
+
* Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx. Your Amazon FSx instance must reside inside your VPC.
|
|
2464
|
+
*/
|
|
2465
|
+
VpcConfiguration: DataSourceVpcConfiguration;
|
|
2466
|
+
/**
|
|
2467
|
+
* The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Amazon FSx file system. Windows is currently the only supported type. The secret must contain a JSON structure with the following keys: username—The Active Directory user name, along with the Domain Name System (DNS) domain name. For example, user@corp.example.com. The Active Directory user account must have read and mounting access to the Amazon FSx file system for Windows. password—The password of the Active Directory user account with read and mounting access to the Amazon FSx Windows file system.
|
|
2468
|
+
*/
|
|
2469
|
+
SecretArn?: SecretArn;
|
|
2470
|
+
/**
|
|
2471
|
+
* A list of regular expression patterns to include certain files in your Amazon FSx file system. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
|
|
2472
|
+
*/
|
|
2473
|
+
InclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
|
2474
|
+
/**
|
|
2475
|
+
* A list of regular expression patterns to exclude certain files in your Amazon FSx file system. Files that match the patterns are excluded from the index. Files that don't match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
|
|
2476
|
+
*/
|
|
2477
|
+
ExclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
|
2478
|
+
/**
|
|
2479
|
+
* A list of DataSourceToIndexFieldMapping objects that map Amazon FSx data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Amazon FSx fields. For more information, see Mapping data source fields. The Amazon FSx data source field names must exist in your Amazon FSx custom metadata.
|
|
2480
|
+
*/
|
|
2481
|
+
FieldMappings?: DataSourceToIndexFieldMappingList;
|
|
2482
|
+
}
|
|
2483
|
+
export type FsxFileSystemType = "WINDOWS"|string;
|
|
2343
2484
|
export interface GetQuerySuggestionsRequest {
|
|
2344
2485
|
/**
|
|
2345
2486
|
* The identifier of the index you want to get query suggestions from.
|
|
@@ -2410,15 +2551,15 @@ declare namespace Kendra {
|
|
|
2410
2551
|
*/
|
|
2411
2552
|
SecretArn: SecretArn;
|
|
2412
2553
|
/**
|
|
2413
|
-
* A list of regular expression patterns
|
|
2554
|
+
* A list of regular expression patterns to include certain items in your Google Drive, including shared drives and users' My Drives. Items that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
|
|
2414
2555
|
*/
|
|
2415
2556
|
InclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
|
2416
2557
|
/**
|
|
2417
|
-
* A list of regular expression patterns
|
|
2558
|
+
* A list of regular expression patterns to exclude certain items in your Google Drive, including shared drives and users' My Drives. Items that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
|
|
2418
2559
|
*/
|
|
2419
2560
|
ExclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
|
2420
2561
|
/**
|
|
2421
|
-
*
|
|
2562
|
+
* Maps Google Drive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Google Drive fields. For more information, see Mapping data source fields. The Google Drive data source field names must exist in your Google Drive custom metadata.
|
|
2422
2563
|
*/
|
|
2423
2564
|
FieldMappings?: DataSourceToIndexFieldMappingList;
|
|
2424
2565
|
/**
|
|
@@ -2530,11 +2671,11 @@ declare namespace Kendra {
|
|
|
2530
2671
|
export type Importance = number;
|
|
2531
2672
|
export interface IndexConfigurationSummary {
|
|
2532
2673
|
/**
|
|
2533
|
-
* The
|
|
2674
|
+
* The identifier of the index.
|
|
2534
2675
|
*/
|
|
2535
2676
|
Name?: IndexName;
|
|
2536
2677
|
/**
|
|
2537
|
-
* A unique identifier for the index. Use this to identify the index when you are using
|
|
2678
|
+
* A unique identifier for the index. Use this to identify the index when you are using APIs such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.
|
|
2538
2679
|
*/
|
|
2539
2680
|
Id?: IndexId;
|
|
2540
2681
|
/**
|
|
@@ -2546,7 +2687,7 @@ declare namespace Kendra {
|
|
|
2546
2687
|
*/
|
|
2547
2688
|
CreatedAt: Timestamp;
|
|
2548
2689
|
/**
|
|
2549
|
-
* The Unix timestamp when the index was last updated by the UpdateIndex
|
|
2690
|
+
* The Unix timestamp when the index was last updated by the UpdateIndex API.
|
|
2550
2691
|
*/
|
|
2551
2692
|
UpdatedAt: Timestamp;
|
|
2552
2693
|
/**
|
|
@@ -2590,7 +2731,74 @@ declare namespace Kendra {
|
|
|
2590
2731
|
export type InlineCustomDocumentEnrichmentConfigurationList = InlineCustomDocumentEnrichmentConfiguration[];
|
|
2591
2732
|
export type Integer = number;
|
|
2592
2733
|
export type Interval = "THIS_MONTH"|"THIS_WEEK"|"ONE_WEEK_AGO"|"TWO_WEEKS_AGO"|"ONE_MONTH_AGO"|"TWO_MONTHS_AGO"|string;
|
|
2734
|
+
export type IssueSubEntity = "COMMENTS"|"ATTACHMENTS"|"WORKLOGS"|string;
|
|
2735
|
+
export type IssueSubEntityFilter = IssueSubEntity[];
|
|
2736
|
+
export type IssueType = String[];
|
|
2593
2737
|
export type Issuer = string;
|
|
2738
|
+
export type JiraAccountUrl = string;
|
|
2739
|
+
export interface JiraConfiguration {
|
|
2740
|
+
/**
|
|
2741
|
+
* The URL of the Jira account. For example, company.attlassian.net or https://jira.company.com. You can find your Jira account URL in the URL of your profile page for Jira desktop.
|
|
2742
|
+
*/
|
|
2743
|
+
JiraAccountUrl: JiraAccountUrl;
|
|
2744
|
+
/**
|
|
2745
|
+
* The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Jira data source. The secret must contain a JSON structure with the following keys: jira-id—The Active Directory user name, along with the Domain Name System (DNS) domain name. For example, user@corp.example.com. jiraCredentials—The password of the Jira account user.
|
|
2746
|
+
*/
|
|
2747
|
+
SecretArn: SecretArn;
|
|
2748
|
+
/**
|
|
2749
|
+
* Specify to use the change log option to update your index.
|
|
2750
|
+
*/
|
|
2751
|
+
UseChangeLog?: Boolean;
|
|
2752
|
+
/**
|
|
2753
|
+
* Specify which projects to crawl in your Jira data source. You can specify one or more Jira project IDs.
|
|
2754
|
+
*/
|
|
2755
|
+
Project?: Project;
|
|
2756
|
+
/**
|
|
2757
|
+
* Specify which issue types to crawl in your Jira data source. You can specify one or more of these options to crawl.
|
|
2758
|
+
*/
|
|
2759
|
+
IssueType?: IssueType;
|
|
2760
|
+
/**
|
|
2761
|
+
* Specify which statuses to crawl in your Jira data source. You can specify one or more of these options to crawl.
|
|
2762
|
+
*/
|
|
2763
|
+
Status?: JiraStatus;
|
|
2764
|
+
/**
|
|
2765
|
+
* Specify whether to crawl comments, attachments, and work logs. You can specify one or more of these options.
|
|
2766
|
+
*/
|
|
2767
|
+
IssueSubEntityFilter?: IssueSubEntityFilter;
|
|
2768
|
+
/**
|
|
2769
|
+
* A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Jira attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Jira fields. For more information, see Mapping data source fields. The Jira data source field names must exist in your Jira custom metadata.
|
|
2770
|
+
*/
|
|
2771
|
+
AttachmentFieldMappings?: DataSourceToIndexFieldMappingList;
|
|
2772
|
+
/**
|
|
2773
|
+
* A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Jira comments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Jira fields. For more information, see Mapping data source fields. The Jira data source field names must exist in your Jira custom metadata.
|
|
2774
|
+
*/
|
|
2775
|
+
CommentFieldMappings?: DataSourceToIndexFieldMappingList;
|
|
2776
|
+
/**
|
|
2777
|
+
* A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Jira issues to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Jira fields. For more information, see Mapping data source fields. The Jira data source field names must exist in your Jira custom metadata.
|
|
2778
|
+
*/
|
|
2779
|
+
IssueFieldMappings?: DataSourceToIndexFieldMappingList;
|
|
2780
|
+
/**
|
|
2781
|
+
* A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Jira projects to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Jira fields. For more information, see Mapping data source fields. The Jira data source field names must exist in your Jira custom metadata.
|
|
2782
|
+
*/
|
|
2783
|
+
ProjectFieldMappings?: DataSourceToIndexFieldMappingList;
|
|
2784
|
+
/**
|
|
2785
|
+
* A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Jira work logs to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Jira fields. For more information, see Mapping data source fields. The Jira data source field names must exist in your Jira custom metadata.
|
|
2786
|
+
*/
|
|
2787
|
+
WorkLogFieldMappings?: DataSourceToIndexFieldMappingList;
|
|
2788
|
+
/**
|
|
2789
|
+
* A list of regular expression patterns to include certain file paths, file names, and file types in your Jira data source. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
|
|
2790
|
+
*/
|
|
2791
|
+
InclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
|
2792
|
+
/**
|
|
2793
|
+
* A list of regular expression patterns to exclude certain file paths, file names, and file types in your Jira data source. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
|
|
2794
|
+
*/
|
|
2795
|
+
ExclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
|
2796
|
+
/**
|
|
2797
|
+
* Configuration information for an Amazon Virtual Private Cloud to connect to your Jira. Your Jira account must reside inside your VPC.
|
|
2798
|
+
*/
|
|
2799
|
+
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
2800
|
+
}
|
|
2801
|
+
export type JiraStatus = String[];
|
|
2594
2802
|
export interface JsonTokenTypeConfiguration {
|
|
2595
2803
|
/**
|
|
2596
2804
|
* The user name attribute field.
|
|
@@ -2839,7 +3047,7 @@ declare namespace Kendra {
|
|
|
2839
3047
|
}
|
|
2840
3048
|
export interface ListIndicesResponse {
|
|
2841
3049
|
/**
|
|
2842
|
-
* An array of summary information
|
|
3050
|
+
* An array of summary information on the configuration of one or more indexes.
|
|
2843
3051
|
*/
|
|
2844
3052
|
IndexConfigurationSummaryItems?: IndexConfigurationSummaryList;
|
|
2845
3053
|
/**
|
|
@@ -2909,6 +3117,7 @@ declare namespace Kendra {
|
|
|
2909
3117
|
ThesaurusSummaryItems?: ThesaurusSummaryItems;
|
|
2910
3118
|
}
|
|
2911
3119
|
export type Long = number;
|
|
3120
|
+
export type LookBackPeriod = number;
|
|
2912
3121
|
export type MaxContentSizePerPageInMegaBytes = number;
|
|
2913
3122
|
export type MaxLinksPerPage = number;
|
|
2914
3123
|
export type MaxResultsIntegerForListDataSourceSyncJobsRequest = number;
|
|
@@ -2962,15 +3171,15 @@ declare namespace Kendra {
|
|
|
2962
3171
|
*/
|
|
2963
3172
|
OneDriveUsers: OneDriveUsers;
|
|
2964
3173
|
/**
|
|
2965
|
-
* A list of regular expression patterns. Documents that match the
|
|
3174
|
+
* A list of regular expression patterns to include certain documents in your OneDrive. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index. The pattern is applied to the file name.
|
|
2966
3175
|
*/
|
|
2967
3176
|
InclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
|
2968
3177
|
/**
|
|
2969
|
-
*
|
|
3178
|
+
* A list of regular expression patterns to exclude certain documents in your OneDrive. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index. The pattern is applied to the file name.
|
|
2970
3179
|
*/
|
|
2971
3180
|
ExclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
|
2972
3181
|
/**
|
|
2973
|
-
* A list of DataSourceToIndexFieldMapping objects that map
|
|
3182
|
+
* A list of DataSourceToIndexFieldMapping objects that map OneDrive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to OneDrive fields. For more information, see Mapping data source fields. The OneDrive data source field names must exist in your OneDrive custom metadata.
|
|
2974
3183
|
*/
|
|
2975
3184
|
FieldMappings?: DataSourceToIndexFieldMappingList;
|
|
2976
3185
|
/**
|
|
@@ -3036,6 +3245,8 @@ declare namespace Kendra {
|
|
|
3036
3245
|
export type PrincipalName = string;
|
|
3037
3246
|
export type PrincipalOrderingId = number;
|
|
3038
3247
|
export type PrincipalType = "USER"|"GROUP"|string;
|
|
3248
|
+
export type PrivateChannelFilter = String[];
|
|
3249
|
+
export type Project = String[];
|
|
3039
3250
|
export interface ProxyConfiguration {
|
|
3040
3251
|
/**
|
|
3041
3252
|
* The name of the website host you want to connect to via a web proxy server. For example, the host name of https://a.example.com/page1.html is "a.example.com".
|
|
@@ -3050,6 +3261,7 @@ declare namespace Kendra {
|
|
|
3050
3261
|
*/
|
|
3051
3262
|
Credentials?: SecretArn;
|
|
3052
3263
|
}
|
|
3264
|
+
export type PublicChannelFilter = String[];
|
|
3053
3265
|
export interface PutPrincipalMappingRequest {
|
|
3054
3266
|
/**
|
|
3055
3267
|
* The identifier of the index you want to map users to their groups.
|
|
@@ -3081,7 +3293,7 @@ declare namespace Kendra {
|
|
|
3081
3293
|
export type QueryIdentifiersEnclosingOption = "DOUBLE_QUOTES"|"NONE"|string;
|
|
3082
3294
|
export interface QueryRequest {
|
|
3083
3295
|
/**
|
|
3084
|
-
* The unique identifier of the index to search. The identifier is returned in the response from the CreateIndex
|
|
3296
|
+
* The unique identifier of the index to search. The identifier is returned in the response from the CreateIndex API.
|
|
3085
3297
|
*/
|
|
3086
3298
|
IndexId: IndexId;
|
|
3087
3299
|
/**
|
|
@@ -3093,11 +3305,11 @@ declare namespace Kendra {
|
|
|
3093
3305
|
*/
|
|
3094
3306
|
AttributeFilter?: AttributeFilter;
|
|
3095
3307
|
/**
|
|
3096
|
-
* An array of documents attributes. Amazon Kendra returns a count for each attribute key specified.
|
|
3308
|
+
* An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. This helps your users narrow their search.
|
|
3097
3309
|
*/
|
|
3098
3310
|
Facets?: FacetList;
|
|
3099
3311
|
/**
|
|
3100
|
-
* An array of document attributes to include in the response.
|
|
3312
|
+
* An array of document attributes to include in the response. You can limit the response to include certain document attributes. By default all document attributes are included in the response.
|
|
3101
3313
|
*/
|
|
3102
3314
|
RequestedDocumentAttributes?: DocumentAttributeKeyList;
|
|
3103
3315
|
/**
|
|
@@ -3128,6 +3340,10 @@ declare namespace Kendra {
|
|
|
3128
3340
|
* Provides an identifier for a specific user. The VisitorId should be a unique identifier, such as a GUID. Don't use personally identifiable information, such as the user's email address, as the VisitorId.
|
|
3129
3341
|
*/
|
|
3130
3342
|
VisitorId?: VisitorId;
|
|
3343
|
+
/**
|
|
3344
|
+
* Enables suggested spell corrections for queries.
|
|
3345
|
+
*/
|
|
3346
|
+
SpellCorrectionConfiguration?: SpellCorrectionConfiguration;
|
|
3131
3347
|
}
|
|
3132
3348
|
export interface QueryResult {
|
|
3133
3349
|
/**
|
|
@@ -3150,6 +3366,10 @@ declare namespace Kendra {
|
|
|
3150
3366
|
* A list of warning codes and their messages on problems with your query. Amazon Kendra currently only supports one type of warning, which is a warning on invalid syntax used in the query. For examples of invalid query syntax, see Searching with advanced query syntax.
|
|
3151
3367
|
*/
|
|
3152
3368
|
Warnings?: WarningList;
|
|
3369
|
+
/**
|
|
3370
|
+
* A list of information related to suggested spell corrections for a query.
|
|
3371
|
+
*/
|
|
3372
|
+
SpellCorrectedQueries?: SpellCorrectedQueryList;
|
|
3153
3373
|
}
|
|
3154
3374
|
export interface QueryResultItem {
|
|
3155
3375
|
/**
|
|
@@ -3181,7 +3401,7 @@ declare namespace Kendra {
|
|
|
3181
3401
|
*/
|
|
3182
3402
|
DocumentURI?: Url;
|
|
3183
3403
|
/**
|
|
3184
|
-
* An array of document attributes
|
|
3404
|
+
* An array of document attributes assigned to a document in the search results. For example, the document author (_author) or the source URI (_source_uri) of the document.
|
|
3185
3405
|
*/
|
|
3186
3406
|
DocumentAttributes?: DocumentAttributeList;
|
|
3187
3407
|
/**
|
|
@@ -3228,6 +3448,56 @@ declare namespace Kendra {
|
|
|
3228
3448
|
export type QuerySuggestionsId = string;
|
|
3229
3449
|
export type QuerySuggestionsStatus = "ACTIVE"|"UPDATING"|string;
|
|
3230
3450
|
export type QueryText = string;
|
|
3451
|
+
export interface QuipConfiguration {
|
|
3452
|
+
/**
|
|
3453
|
+
* The Quip site domain.
|
|
3454
|
+
*/
|
|
3455
|
+
Domain: Domain;
|
|
3456
|
+
/**
|
|
3457
|
+
* The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs that are required to connect to your Quip. The secret must contain a JSON structure with the following keys: accessToken—The token created in Quip. For more information, see Authentication for a Quip data source.
|
|
3458
|
+
*/
|
|
3459
|
+
SecretArn: SecretArn;
|
|
3460
|
+
/**
|
|
3461
|
+
* Specify whether to crawl file comments in Quip. You can specify one or more of these options.
|
|
3462
|
+
*/
|
|
3463
|
+
CrawlFileComments?: Boolean;
|
|
3464
|
+
/**
|
|
3465
|
+
* Specify whether to crawl chat rooms in Quip. You can specify one or more of these options.
|
|
3466
|
+
*/
|
|
3467
|
+
CrawlChatRooms?: Boolean;
|
|
3468
|
+
/**
|
|
3469
|
+
* Specify whether to crawl attachments in Quip. You can specify one or more of these options.
|
|
3470
|
+
*/
|
|
3471
|
+
CrawlAttachments?: Boolean;
|
|
3472
|
+
/**
|
|
3473
|
+
* The identifier of the Quip folder IDs to index.
|
|
3474
|
+
*/
|
|
3475
|
+
FolderIds?: FolderIdList;
|
|
3476
|
+
/**
|
|
3477
|
+
* A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip threads to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.
|
|
3478
|
+
*/
|
|
3479
|
+
ThreadFieldMappings?: DataSourceToIndexFieldMappingList;
|
|
3480
|
+
/**
|
|
3481
|
+
* A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip messages to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.
|
|
3482
|
+
*/
|
|
3483
|
+
MessageFieldMappings?: DataSourceToIndexFieldMappingList;
|
|
3484
|
+
/**
|
|
3485
|
+
* A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.
|
|
3486
|
+
*/
|
|
3487
|
+
AttachmentFieldMappings?: DataSourceToIndexFieldMappingList;
|
|
3488
|
+
/**
|
|
3489
|
+
* A list of regular expression patterns to include certain files in your Quip file system. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence, and the file isn't included in the index.
|
|
3490
|
+
*/
|
|
3491
|
+
InclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
|
3492
|
+
/**
|
|
3493
|
+
* A list of regular expression patterns to exclude certain files in your Quip file system. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence, and the file isn't included in the index.
|
|
3494
|
+
*/
|
|
3495
|
+
ExclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
|
3496
|
+
/**
|
|
3497
|
+
* Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip. For more information, see Configuring a VPC.
|
|
3498
|
+
*/
|
|
3499
|
+
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
3500
|
+
}
|
|
3231
3501
|
export type ReadAccessType = "ALLOW"|"DENY"|string;
|
|
3232
3502
|
export interface Relevance {
|
|
3233
3503
|
/**
|
|
@@ -3330,15 +3600,15 @@ declare namespace Kendra {
|
|
|
3330
3600
|
*/
|
|
3331
3601
|
SecretArn: SecretArn;
|
|
3332
3602
|
/**
|
|
3333
|
-
*
|
|
3603
|
+
* Configuration of the Salesforce standard objects that Amazon Kendra indexes.
|
|
3334
3604
|
*/
|
|
3335
3605
|
StandardObjectConfigurations?: SalesforceStandardObjectConfigurationList;
|
|
3336
3606
|
/**
|
|
3337
|
-
*
|
|
3607
|
+
* Configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both.
|
|
3338
3608
|
*/
|
|
3339
3609
|
KnowledgeArticleConfiguration?: SalesforceKnowledgeArticleConfiguration;
|
|
3340
3610
|
/**
|
|
3341
|
-
*
|
|
3611
|
+
* Configuration information for Salesforce chatter feeds.
|
|
3342
3612
|
*/
|
|
3343
3613
|
ChatterFeedConfiguration?: SalesforceChatterFeedConfiguration;
|
|
3344
3614
|
/**
|
|
@@ -3346,15 +3616,15 @@ declare namespace Kendra {
|
|
|
3346
3616
|
*/
|
|
3347
3617
|
CrawlAttachments?: Boolean;
|
|
3348
3618
|
/**
|
|
3349
|
-
*
|
|
3619
|
+
* Configuration information for processing attachments to Salesforce standard objects.
|
|
3350
3620
|
*/
|
|
3351
3621
|
StandardObjectAttachmentConfiguration?: SalesforceStandardObjectAttachmentConfiguration;
|
|
3352
3622
|
/**
|
|
3353
|
-
* A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion
|
|
3623
|
+
* A list of regular expression patterns to include certain documents in your Salesforce. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index. The pattern is applied to the name of the attached file.
|
|
3354
3624
|
*/
|
|
3355
3625
|
IncludeAttachmentFilePatterns?: DataSourceInclusionsExclusionsStrings;
|
|
3356
3626
|
/**
|
|
3357
|
-
* A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern
|
|
3627
|
+
* A list of regular expression patterns to exclude certain documents in your Salesforce. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index. The pattern is applied to the name of the attached file.
|
|
3358
3628
|
*/
|
|
3359
3629
|
ExcludeAttachmentFilePatterns?: DataSourceInclusionsExclusionsStrings;
|
|
3360
3630
|
}
|
|
@@ -3372,7 +3642,7 @@ declare namespace Kendra {
|
|
|
3372
3642
|
*/
|
|
3373
3643
|
DocumentTitleFieldName?: DataSourceFieldName;
|
|
3374
3644
|
/**
|
|
3375
|
-
*
|
|
3645
|
+
* Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The Salesforce data source field names must exist in your Salesforce custom metadata.
|
|
3376
3646
|
*/
|
|
3377
3647
|
FieldMappings?: DataSourceToIndexFieldMappingList;
|
|
3378
3648
|
}
|
|
@@ -3384,11 +3654,11 @@ declare namespace Kendra {
|
|
|
3384
3654
|
*/
|
|
3385
3655
|
IncludedStates: SalesforceKnowledgeArticleStateList;
|
|
3386
3656
|
/**
|
|
3387
|
-
*
|
|
3657
|
+
* Configuration information for standard Salesforce knowledge articles.
|
|
3388
3658
|
*/
|
|
3389
3659
|
StandardKnowledgeArticleTypeConfiguration?: SalesforceStandardKnowledgeArticleTypeConfiguration;
|
|
3390
3660
|
/**
|
|
3391
|
-
*
|
|
3661
|
+
* Configuration information for custom Salesforce knowledge articles.
|
|
3392
3662
|
*/
|
|
3393
3663
|
CustomKnowledgeArticleTypeConfigurations?: SalesforceCustomKnowledgeArticleTypeConfigurationList;
|
|
3394
3664
|
}
|
|
@@ -3404,7 +3674,7 @@ declare namespace Kendra {
|
|
|
3404
3674
|
*/
|
|
3405
3675
|
DocumentTitleFieldName?: DataSourceFieldName;
|
|
3406
3676
|
/**
|
|
3407
|
-
*
|
|
3677
|
+
* Maps attributes or field names of the knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The Salesforce data source field names must exist in your Salesforce custom metadata.
|
|
3408
3678
|
*/
|
|
3409
3679
|
FieldMappings?: DataSourceToIndexFieldMappingList;
|
|
3410
3680
|
}
|
|
@@ -3432,7 +3702,7 @@ declare namespace Kendra {
|
|
|
3432
3702
|
*/
|
|
3433
3703
|
DocumentTitleFieldName?: DataSourceFieldName;
|
|
3434
3704
|
/**
|
|
3435
|
-
*
|
|
3705
|
+
* Maps attributes or field names of the standard object to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The Salesforce data source field names must exist in your Salesforce custom metadata.
|
|
3436
3706
|
*/
|
|
3437
3707
|
FieldMappings?: DataSourceToIndexFieldMappingList;
|
|
3438
3708
|
}
|
|
@@ -3500,15 +3770,15 @@ declare namespace Kendra {
|
|
|
3500
3770
|
*/
|
|
3501
3771
|
ServiceNowBuildVersion: ServiceNowBuildVersionType;
|
|
3502
3772
|
/**
|
|
3503
|
-
*
|
|
3773
|
+
* Configuration information for crawling knowledge articles in the ServiceNow site.
|
|
3504
3774
|
*/
|
|
3505
3775
|
KnowledgeArticleConfiguration?: ServiceNowKnowledgeArticleConfiguration;
|
|
3506
3776
|
/**
|
|
3507
|
-
*
|
|
3777
|
+
* Configuration information for crawling service catalogs in the ServiceNow site.
|
|
3508
3778
|
*/
|
|
3509
3779
|
ServiceCatalogConfiguration?: ServiceNowServiceCatalogConfiguration;
|
|
3510
3780
|
/**
|
|
3511
|
-
*
|
|
3781
|
+
* The type of authentication used to connect to the ServiceNow instance. If you choose HTTP_BASIC, Amazon Kendra is authenticated using the user name and password provided in the Secrets Manager secret in the SecretArn field. When you choose OAUTH2, Amazon Kendra is authenticated using the OAuth token and secret provided in the Secrets Manager secret, and the user name and password are used to determine which information Amazon Kendra has access to. When you use OAUTH2 authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source.
|
|
3512
3782
|
*/
|
|
3513
3783
|
AuthenticationType?: ServiceNowAuthenticationType;
|
|
3514
3784
|
}
|
|
@@ -3519,11 +3789,11 @@ declare namespace Kendra {
|
|
|
3519
3789
|
*/
|
|
3520
3790
|
CrawlAttachments?: Boolean;
|
|
3521
3791
|
/**
|
|
3522
|
-
*
|
|
3792
|
+
* A list of regular expression patterns to include certain attachments of knowledge articles in your ServiceNow. Item that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index. The regex is applied to the field specified in the PatternTargetField.
|
|
3523
3793
|
*/
|
|
3524
3794
|
IncludeAttachmentFilePatterns?: DataSourceInclusionsExclusionsStrings;
|
|
3525
3795
|
/**
|
|
3526
|
-
*
|
|
3796
|
+
* A list of regular expression patterns to exclude certain attachments of knowledge articles in your ServiceNow. Item that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index. The regex is applied to the field specified in the PatternTargetField.
|
|
3527
3797
|
*/
|
|
3528
3798
|
ExcludeAttachmentFilePatterns?: DataSourceInclusionsExclusionsStrings;
|
|
3529
3799
|
/**
|
|
@@ -3535,7 +3805,7 @@ declare namespace Kendra {
|
|
|
3535
3805
|
*/
|
|
3536
3806
|
DocumentTitleFieldName?: DataSourceFieldName;
|
|
3537
3807
|
/**
|
|
3538
|
-
*
|
|
3808
|
+
* Maps attributes or field names of knoweldge articles to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to ServiceNow fields. For more information, see Mapping data source fields. The ServiceNow data source field names must exist in your ServiceNow custom metadata.
|
|
3539
3809
|
*/
|
|
3540
3810
|
FieldMappings?: DataSourceToIndexFieldMappingList;
|
|
3541
3811
|
/**
|
|
@@ -3550,11 +3820,11 @@ declare namespace Kendra {
|
|
|
3550
3820
|
*/
|
|
3551
3821
|
CrawlAttachments?: Boolean;
|
|
3552
3822
|
/**
|
|
3553
|
-
* A list of regular expression patterns.
|
|
3823
|
+
* A list of regular expression patterns to include certain attachments of catalogs in your ServiceNow. Item that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index. The regex is applied to the file name of the attachment.
|
|
3554
3824
|
*/
|
|
3555
3825
|
IncludeAttachmentFilePatterns?: DataSourceInclusionsExclusionsStrings;
|
|
3556
3826
|
/**
|
|
3557
|
-
* A list of regular expression patterns.
|
|
3827
|
+
* A list of regular expression patterns to exclude certain attachments of catalogs in your ServiceNow. Item that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index. The regex is applied to the file name of the attachment.
|
|
3558
3828
|
*/
|
|
3559
3829
|
ExcludeAttachmentFilePatterns?: DataSourceInclusionsExclusionsStrings;
|
|
3560
3830
|
/**
|
|
@@ -3566,7 +3836,7 @@ declare namespace Kendra {
|
|
|
3566
3836
|
*/
|
|
3567
3837
|
DocumentTitleFieldName?: DataSourceFieldName;
|
|
3568
3838
|
/**
|
|
3569
|
-
*
|
|
3839
|
+
* Maps attributes or field names of catalogs to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to ServiceNow fields. For more information, see Mapping data source fields. The ServiceNow data source field names must exist in your ServiceNow custom metadata.
|
|
3570
3840
|
*/
|
|
3571
3841
|
FieldMappings?: DataSourceToIndexFieldMappingList;
|
|
3572
3842
|
}
|
|
@@ -3588,20 +3858,20 @@ declare namespace Kendra {
|
|
|
3588
3858
|
*/
|
|
3589
3859
|
CrawlAttachments?: Boolean;
|
|
3590
3860
|
/**
|
|
3591
|
-
*
|
|
3861
|
+
* TRUE to use the SharePoint change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint.
|
|
3592
3862
|
*/
|
|
3593
3863
|
UseChangeLog?: Boolean;
|
|
3594
3864
|
/**
|
|
3595
|
-
* A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion
|
|
3865
|
+
* A list of regular expression patterns to include certain documents in your SharePoint. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index. The regex is applied to the display URL of the SharePoint document.
|
|
3596
3866
|
*/
|
|
3597
3867
|
InclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
|
3598
3868
|
/**
|
|
3599
|
-
* A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern
|
|
3869
|
+
* A list of regular expression patterns to exclude certain documents in your SharePoint. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index. The regex is applied to the display URL of the SharePoint document.
|
|
3600
3870
|
*/
|
|
3601
3871
|
ExclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
|
3602
3872
|
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
3603
3873
|
/**
|
|
3604
|
-
* A list of DataSourceToIndexFieldMapping objects that map
|
|
3874
|
+
* A list of DataSourceToIndexFieldMapping objects that map SharePoint data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to SharePoint fields. For more information, see Mapping data source fields. The SharePoint data source field names must exist in your SharePoint custom metadata.
|
|
3605
3875
|
*/
|
|
3606
3876
|
FieldMappings?: DataSourceToIndexFieldMappingList;
|
|
3607
3877
|
/**
|
|
@@ -3617,6 +3887,7 @@ declare namespace Kendra {
|
|
|
3617
3887
|
export type SharePointUrlList = Url[];
|
|
3618
3888
|
export type SharePointVersion = "SHAREPOINT_2013"|"SHAREPOINT_2016"|"SHAREPOINT_ONLINE"|string;
|
|
3619
3889
|
export type SharedDriveId = string;
|
|
3890
|
+
export type SinceCrawlDate = string;
|
|
3620
3891
|
export type SiteMap = string;
|
|
3621
3892
|
export interface SiteMapsConfiguration {
|
|
3622
3893
|
/**
|
|
@@ -3625,6 +3896,66 @@ declare namespace Kendra {
|
|
|
3625
3896
|
SiteMaps: SiteMapsList;
|
|
3626
3897
|
}
|
|
3627
3898
|
export type SiteMapsList = SiteMap[];
|
|
3899
|
+
export interface SlackConfiguration {
|
|
3900
|
+
/**
|
|
3901
|
+
* The identifier of the team in the Slack workspace. For example, T0123456789. You can find your team ID in the URL of the main page of your Slack workspace. When you log in to Slack via a browser, you are directed to the URL of the main page. For example, https://app.slack.com/client/T0123456789/....
|
|
3902
|
+
*/
|
|
3903
|
+
TeamId: TeamId;
|
|
3904
|
+
/**
|
|
3905
|
+
* The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Slack workspace team. The secret must contain a JSON structure with the following keys: slackToken—The user or bot token created in Slack. For more information on creating a token in Slack, see Authentication for a Slack data source.
|
|
3906
|
+
*/
|
|
3907
|
+
SecretArn: SecretArn;
|
|
3908
|
+
/**
|
|
3909
|
+
* Configuration information for an Amazon Virtual Private Cloud to connect to your Slack. For more information, see Configuring a VPC.
|
|
3910
|
+
*/
|
|
3911
|
+
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
3912
|
+
/**
|
|
3913
|
+
* Specify whether to index public channels, private channels, group messages, and direct messages. You can specify one or more of these options.
|
|
3914
|
+
*/
|
|
3915
|
+
SlackEntityList: SlackEntityList;
|
|
3916
|
+
/**
|
|
3917
|
+
* TRUE to use the Slack change log to determine which documents require updating in the index. Depending on the Slack change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Slack.
|
|
3918
|
+
*/
|
|
3919
|
+
UseChangeLog?: Boolean;
|
|
3920
|
+
/**
|
|
3921
|
+
* TRUE to index bot messages from your Slack workspace team.
|
|
3922
|
+
*/
|
|
3923
|
+
CrawlBotMessage?: Boolean;
|
|
3924
|
+
/**
|
|
3925
|
+
* TRUE to exclude archived messages to index from your Slack workspace team.
|
|
3926
|
+
*/
|
|
3927
|
+
ExcludeArchived?: Boolean;
|
|
3928
|
+
/**
|
|
3929
|
+
* The date to start crawling your data from your Slack workspace team. The date must follow this format: yyyy-mm-dd.
|
|
3930
|
+
*/
|
|
3931
|
+
SinceCrawlDate: SinceCrawlDate;
|
|
3932
|
+
/**
|
|
3933
|
+
* The number of hours for change log to look back from when you last synchronized your data. You can look back up to 7 days or 168 hours. Change log updates your index only if new content was added since you last synced your data. Updated or deleted content from before you last synced does not get updated in your index. To capture updated or deleted content before you last synced, set the LookBackPeriod to the number of hours you want change log to look back.
|
|
3934
|
+
*/
|
|
3935
|
+
LookBackPeriod?: LookBackPeriod;
|
|
3936
|
+
/**
|
|
3937
|
+
* The list of private channel names from your Slack workspace team. You use this if you want to index specific private channels, not all private channels. You can also use regular expression patterns to filter private channels.
|
|
3938
|
+
*/
|
|
3939
|
+
PrivateChannelFilter?: PrivateChannelFilter;
|
|
3940
|
+
/**
|
|
3941
|
+
* The list of public channel names to index from your Slack workspace team. You use this if you want to index specific public channels, not all public channels. You can also use regular expression patterns to filter public channels.
|
|
3942
|
+
*/
|
|
3943
|
+
PublicChannelFilter?: PublicChannelFilter;
|
|
3944
|
+
/**
|
|
3945
|
+
* A list of regular expression patterns to include certain attached files in your Slack workspace team. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
|
|
3946
|
+
*/
|
|
3947
|
+
InclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
|
3948
|
+
/**
|
|
3949
|
+
* A list of regular expression patterns to exclude certain attached files in your Slack workspace team. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
|
|
3950
|
+
*/
|
|
3951
|
+
ExclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
|
3952
|
+
/**
|
|
3953
|
+
* A list of DataSourceToIndexFieldMapping objects that map Slack data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Slack fields. For more information, see Mapping data source fields. The Slack data source field names must exist in your Slack custom metadata.
|
|
3954
|
+
*/
|
|
3955
|
+
FieldMappings?: DataSourceToIndexFieldMappingList;
|
|
3956
|
+
}
|
|
3957
|
+
export type SlackEntity = "PUBLIC_CHANNEL"|"PRIVATE_CHANNEL"|"GROUP_MESSAGE"|"DIRECT_MESSAGE"|string;
|
|
3958
|
+
export type SlackEntityList = SlackEntity[];
|
|
3628
3959
|
export type SnapshotsDataHeaderFields = String[];
|
|
3629
3960
|
export type SnapshotsDataRecord = String[];
|
|
3630
3961
|
export type SnapshotsDataRecords = SnapshotsDataRecord[];
|
|
@@ -3639,6 +3970,23 @@ declare namespace Kendra {
|
|
|
3639
3970
|
*/
|
|
3640
3971
|
SortOrder: SortOrder;
|
|
3641
3972
|
}
|
|
3973
|
+
export interface SpellCorrectedQuery {
|
|
3974
|
+
/**
|
|
3975
|
+
* The query with the suggested spell corrections.
|
|
3976
|
+
*/
|
|
3977
|
+
SuggestedQueryText?: SuggestedQueryText;
|
|
3978
|
+
/**
|
|
3979
|
+
* The corrected misspelled word or words in a query.
|
|
3980
|
+
*/
|
|
3981
|
+
Corrections?: CorrectionList;
|
|
3982
|
+
}
|
|
3983
|
+
export type SpellCorrectedQueryList = SpellCorrectedQuery[];
|
|
3984
|
+
export interface SpellCorrectionConfiguration {
|
|
3985
|
+
/**
|
|
3986
|
+
* TRUE to suggest spell corrections for queries.
|
|
3987
|
+
*/
|
|
3988
|
+
IncludeQuerySpellCheckSuggestions: Boolean;
|
|
3989
|
+
}
|
|
3642
3990
|
export interface SqlConfiguration {
|
|
3643
3991
|
/**
|
|
3644
3992
|
* Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when making a database query. By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source configuration. It does not change the case of identifiers or enclose them in quotes. PostgreSQL internally converts uppercase characters to lower case characters in identifiers unless they are quoted. Choosing this option encloses identifiers in quotes so that PostgreSQL does not convert the character's case. For MySQL databases, you must enable the ansi_quotes option when you set this field to DOUBLE_QUOTES.
|
|
@@ -3697,7 +4045,7 @@ declare namespace Kendra {
|
|
|
3697
4045
|
*/
|
|
3698
4046
|
IndexId: IndexId;
|
|
3699
4047
|
/**
|
|
3700
|
-
* The identifier of the specific query for which you are submitting feedback. The query ID is returned in the response to the Query
|
|
4048
|
+
* The identifier of the specific query for which you are submitting feedback. The query ID is returned in the response to the Query API.
|
|
3701
4049
|
*/
|
|
3702
4050
|
QueryId: QueryId;
|
|
3703
4051
|
/**
|
|
@@ -3711,6 +4059,7 @@ declare namespace Kendra {
|
|
|
3711
4059
|
}
|
|
3712
4060
|
export type SubnetId = string;
|
|
3713
4061
|
export type SubnetIdList = SubnetId[];
|
|
4062
|
+
export type SuggestedQueryText = string;
|
|
3714
4063
|
export interface Suggestion {
|
|
3715
4064
|
/**
|
|
3716
4065
|
* The unique UUID (universally unique identifier) of a single query suggestion.
|
|
@@ -3777,6 +4126,7 @@ declare namespace Kendra {
|
|
|
3777
4126
|
export interface TagResourceResponse {
|
|
3778
4127
|
}
|
|
3779
4128
|
export type TagValue = string;
|
|
4129
|
+
export type TeamId = string;
|
|
3780
4130
|
export type TenantDomain = string;
|
|
3781
4131
|
export interface TextDocumentStatistics {
|
|
3782
4132
|
/**
|
|
@@ -3837,6 +4187,7 @@ declare namespace Kendra {
|
|
|
3837
4187
|
export type Timestamp = Date;
|
|
3838
4188
|
export type Title = string;
|
|
3839
4189
|
export type Token = string;
|
|
4190
|
+
export type TopDocumentAttributeValueCountPairsSize = number;
|
|
3840
4191
|
export interface UntagResourceRequest {
|
|
3841
4192
|
/**
|
|
3842
4193
|
* The Amazon Resource Name (ARN) of the index, FAQ, or data source to remove the tag from.
|
|
@@ -3863,7 +4214,7 @@ declare namespace Kendra {
|
|
|
3863
4214
|
*/
|
|
3864
4215
|
IndexId: IndexId;
|
|
3865
4216
|
/**
|
|
3866
|
-
* Configuration information for an Amazon Kendra data source.
|
|
4217
|
+
* Configuration information for an Amazon Kendra data source you want to update.
|
|
3867
4218
|
*/
|
|
3868
4219
|
Configuration?: DataSourceConfiguration;
|
|
3869
4220
|
/**
|
|
@@ -3901,11 +4252,11 @@ declare namespace Kendra {
|
|
|
3901
4252
|
*/
|
|
3902
4253
|
IndexId: IndexId;
|
|
3903
4254
|
/**
|
|
3904
|
-
* The Amazon Resource Name (ARN) of a role with permission to access Query
|
|
4255
|
+
* The Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and Amazon Web Services SSO that stores your user and group information. For more information, see IAM roles for Amazon Kendra.
|
|
3905
4256
|
*/
|
|
3906
4257
|
RoleArn?: RoleArn;
|
|
3907
4258
|
/**
|
|
3908
|
-
*
|
|
4259
|
+
* Configuration information for your Amazon Kendra you want to update.
|
|
3909
4260
|
*/
|
|
3910
4261
|
Configuration?: ExperienceConfiguration;
|
|
3911
4262
|
/**
|
|
@@ -3931,11 +4282,11 @@ declare namespace Kendra {
|
|
|
3931
4282
|
*/
|
|
3932
4283
|
Description?: Description;
|
|
3933
4284
|
/**
|
|
3934
|
-
* The document metadata to update.
|
|
4285
|
+
* The document metadata you want to update.
|
|
3935
4286
|
*/
|
|
3936
4287
|
DocumentMetadataConfigurationUpdates?: DocumentMetadataConfigurationList;
|
|
3937
4288
|
/**
|
|
3938
|
-
* Sets the number of additional storage and query capacity units that should be used by the index. You can change the capacity of the index up to 5 times per day. If you are using extra storage units, you can't reduce the storage capacity below
|
|
4289
|
+
* Sets the number of additional document storage and query capacity units that should be used by the index. You can change the capacity of the index up to 5 times per day, or make 5 API calls. If you are using extra storage units, you can't reduce the storage capacity below what is required to meet the storage needs for your index.
|
|
3939
4290
|
*/
|
|
3940
4291
|
CapacityUnits?: CapacityUnitsConfiguration;
|
|
3941
4292
|
/**
|
|
@@ -4029,11 +4380,11 @@ declare namespace Kendra {
|
|
|
4029
4380
|
export type Url = string;
|
|
4030
4381
|
export interface Urls {
|
|
4031
4382
|
/**
|
|
4032
|
-
*
|
|
4383
|
+
* Configuration of the seed or starting point URLs of the websites you want to crawl. You can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the webpages link to. You can list up to 100 seed URLs.
|
|
4033
4384
|
*/
|
|
4034
4385
|
SeedUrlConfiguration?: SeedUrlConfiguration;
|
|
4035
4386
|
/**
|
|
4036
|
-
*
|
|
4387
|
+
* Configuration of the sitemap URLs of the websites you want to crawl. Only URLs belonging to the same website host names are crawled. You can list up to three sitemap URLs.
|
|
4037
4388
|
*/
|
|
4038
4389
|
SiteMapsConfiguration?: SiteMapsConfiguration;
|
|
4039
4390
|
}
|
|
@@ -4122,19 +4473,19 @@ declare namespace Kendra {
|
|
|
4122
4473
|
*/
|
|
4123
4474
|
MaxUrlsPerMinuteCrawlRate?: MaxUrlsPerMinuteCrawlRate;
|
|
4124
4475
|
/**
|
|
4125
|
-
*
|
|
4476
|
+
* A list of regular expression patterns to include certain URLs to crawl. URLs that match the patterns are included in the index. URLs that don't match the patterns are excluded from the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.
|
|
4126
4477
|
*/
|
|
4127
4478
|
UrlInclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
|
4128
4479
|
/**
|
|
4129
|
-
*
|
|
4480
|
+
* A list of regular expression patterns to exclude certain URLs to crawl. URLs that match the patterns are excluded from the index. URLs that don't match the patterns are included in the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.
|
|
4130
4481
|
*/
|
|
4131
4482
|
UrlExclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
|
4132
4483
|
/**
|
|
4133
|
-
*
|
|
4484
|
+
* Configuration information required to connect to your internal websites via a web proxy. You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS. Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in Secrets Manager.
|
|
4134
4485
|
*/
|
|
4135
4486
|
ProxyConfiguration?: ProxyConfiguration;
|
|
4136
4487
|
/**
|
|
4137
|
-
*
|
|
4488
|
+
* Configuration information required to connect to websites using authentication. You can connect to websites using basic authentication of user name and password. You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS. You use a secret in Secrets Manager to store your authentication credentials.
|
|
4138
4489
|
*/
|
|
4139
4490
|
AuthenticationConfiguration?: AuthenticationConfiguration;
|
|
4140
4491
|
}
|
|
@@ -4149,19 +4500,19 @@ declare namespace Kendra {
|
|
|
4149
4500
|
*/
|
|
4150
4501
|
CrawlComments?: Boolean;
|
|
4151
4502
|
/**
|
|
4152
|
-
* TRUE to use the change
|
|
4503
|
+
* TRUE to use the Amazon WorkDocs change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Amazon WorkDocs.
|
|
4153
4504
|
*/
|
|
4154
4505
|
UseChangeLog?: Boolean;
|
|
4155
4506
|
/**
|
|
4156
|
-
* A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion
|
|
4507
|
+
* A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
|
|
4157
4508
|
*/
|
|
4158
4509
|
InclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
|
4159
4510
|
/**
|
|
4160
|
-
* A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion
|
|
4511
|
+
* A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
|
|
4161
4512
|
*/
|
|
4162
4513
|
ExclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
|
4163
4514
|
/**
|
|
4164
|
-
* A list of DataSourceToIndexFieldMapping objects that map Amazon WorkDocs
|
|
4515
|
+
* A list of DataSourceToIndexFieldMapping objects that map Amazon WorkDocs data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Amazon WorkDocs fields. For more information, see Mapping data source fields. The Amazon WorkDocs data source field names must exist in your Amazon WorkDocs custom metadata.
|
|
4165
4516
|
*/
|
|
4166
4517
|
FieldMappings?: DataSourceToIndexFieldMappingList;
|
|
4167
4518
|
}
|