cdk-docker-image-deployment 0.0.577 → 0.0.579
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/.jsii +5 -5
- package/lib/destination.js +1 -1
- package/lib/docker-image-deployment.js +1 -1
- package/lib/source.js +1 -1
- package/node_modules/@types/aws-lambda/README.md +2 -2
- package/node_modules/@types/aws-lambda/index.d.ts +1 -0
- package/node_modules/@types/aws-lambda/package.json +8 -3
- package/node_modules/@types/aws-lambda/trigger/api-gateway-authorizer.d.ts +3 -1
- package/node_modules/@types/aws-lambda/trigger/appsync-resolver.d.ts +5 -0
- package/node_modules/@types/aws-lambda/trigger/cdk-custom-resource.d.ts +133 -42
- package/node_modules/@types/aws-lambda/trigger/cloudformation-custom-resource.d.ts +196 -30
- package/node_modules/@types/aws-lambda/trigger/cognito-user-pool-trigger/define-auth-challenge.d.ts +1 -1
- package/node_modules/@types/aws-lambda/trigger/transfer-family-authorizer.d.ts +2 -1
- package/node_modules/aws-sdk/README.md +1 -1
- package/node_modules/aws-sdk/apis/accessanalyzer-2019-11-01.examples.json +196 -0
- package/node_modules/aws-sdk/apis/accessanalyzer-2019-11-01.min.json +254 -111
- package/node_modules/aws-sdk/apis/accessanalyzer-2019-11-01.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/account-2021-02-01.min.json +101 -19
- package/node_modules/aws-sdk/apis/acm-2015-12-08.min.json +7 -1
- package/node_modules/aws-sdk/apis/acm-pca-2017-08-22.min.json +20 -13
- package/node_modules/aws-sdk/apis/acm-pca-2017-08-22.paginators.json +4 -4
- package/node_modules/aws-sdk/apis/acm-pca-2017-08-22.waiters2.json +15 -0
- package/node_modules/aws-sdk/apis/amplify-2017-07-25.min.json +79 -55
- package/node_modules/aws-sdk/apis/apigateway-2015-07-09.min.json +7 -1
- package/node_modules/aws-sdk/apis/appintegrations-2020-07-29.min.json +121 -11
- package/node_modules/aws-sdk/apis/application-autoscaling-2016-02-06.min.json +7 -1
- package/node_modules/aws-sdk/apis/application-signals-2024-04-15.min.json +990 -0
- package/node_modules/aws-sdk/apis/application-signals-2024-04-15.paginators.json +34 -0
- package/node_modules/aws-sdk/apis/appstream-2016-12-01.min.json +188 -45
- package/node_modules/aws-sdk/apis/appsync-2017-07-25.min.json +4 -1
- package/node_modules/aws-sdk/apis/appsync-2017-07-25.paginators.json +60 -0
- package/node_modules/aws-sdk/apis/apptest-2022-12-06.min.json +1917 -0
- package/node_modules/aws-sdk/apis/apptest-2022-12-06.paginators.json +40 -0
- package/node_modules/aws-sdk/apis/apptest-2022-12-06.waiters2.json +5 -0
- package/node_modules/aws-sdk/apis/arc-zonal-shift-2022-10-30.min.json +62 -10
- package/node_modules/aws-sdk/apis/artifact-2018-05-10.examples.json +113 -0
- package/node_modules/aws-sdk/apis/artifact-2018-05-10.min.json +47 -41
- package/node_modules/aws-sdk/apis/artifact-2018-05-10.waiters2.json +5 -0
- package/node_modules/aws-sdk/apis/athena-2017-05-18.min.json +7 -1
- package/node_modules/aws-sdk/apis/auditmanager-2017-07-25.min.json +57 -38
- package/node_modules/aws-sdk/apis/autoscaling-2011-01-01.min.json +40 -34
- package/node_modules/aws-sdk/apis/b2bi-2022-06-23.min.json +8 -1
- package/node_modules/aws-sdk/apis/batch-2016-08-10.min.json +115 -60
- package/node_modules/aws-sdk/apis/bedrock-2023-04-20.min.json +326 -88
- package/node_modules/aws-sdk/apis/bedrock-2023-04-20.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/bedrock-agent-2023-06-05.min.json +2122 -231
- package/node_modules/aws-sdk/apis/bedrock-agent-2023-06-05.paginators.json +24 -0
- package/node_modules/aws-sdk/apis/bedrock-agent-runtime-2023-07-26.min.json +894 -243
- package/node_modules/aws-sdk/apis/bedrock-agent-runtime-2023-07-26.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/bedrock-runtime-2023-09-30.min.json +921 -45
- package/node_modules/aws-sdk/apis/budgets-2016-10-20.min.json +102 -21
- package/node_modules/aws-sdk/apis/chatbot-2017-10-11.min.json +138 -24
- package/node_modules/aws-sdk/apis/chime-sdk-media-pipelines-2021-07-15.min.json +10 -1
- package/node_modules/aws-sdk/apis/chime-sdk-voice-2022-08-03.min.json +6 -2
- package/node_modules/aws-sdk/apis/cleanrooms-2022-02-17.min.json +1329 -202
- package/node_modules/aws-sdk/apis/cleanrooms-2022-02-17.paginators.json +18 -0
- package/node_modules/aws-sdk/apis/cleanroomsml-2023-09-06.min.json +305 -287
- package/node_modules/aws-sdk/apis/cleanroomsml-2023-09-06.waiters2.json +5 -0
- package/node_modules/aws-sdk/apis/cloudformation-2010-05-15.min.json +48 -43
- package/node_modules/aws-sdk/apis/cloudfront-2020-05-31.min.json +7 -1
- package/node_modules/aws-sdk/apis/cloudhsmv2-2017-04-28.min.json +79 -20
- package/node_modules/aws-sdk/apis/cloudtrail-2013-11-01.min.json +44 -24
- package/node_modules/aws-sdk/apis/codeartifact-2018-09-22.min.json +7 -1
- package/node_modules/aws-sdk/apis/codebuild-2016-10-06.min.json +80 -38
- package/node_modules/aws-sdk/apis/codecommit-2015-04-13.min.json +7 -1
- package/node_modules/aws-sdk/apis/codedeploy-2014-10-06.min.json +7 -1
- package/node_modules/aws-sdk/apis/codeguru-security-2018-05-10.min.json +6 -0
- package/node_modules/aws-sdk/apis/codepipeline-2015-07-09.min.json +446 -95
- package/node_modules/aws-sdk/apis/codepipeline-2015-07-09.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/cognito-identity-2014-06-30.min.json +23 -5
- package/node_modules/aws-sdk/apis/cognito-idp-2016-04-18.min.json +292 -187
- package/node_modules/aws-sdk/apis/compute-optimizer-2019-11-01.min.json +447 -134
- package/node_modules/aws-sdk/apis/config-2014-11-12.min.json +7 -1
- package/node_modules/aws-sdk/apis/connect-2017-08-08.min.json +1537 -546
- package/node_modules/aws-sdk/apis/connect-2017-08-08.paginators.json +42 -0
- package/node_modules/aws-sdk/apis/connect-contact-lens-2020-08-21.min.json +18 -1
- package/node_modules/aws-sdk/apis/connectcases-2022-10-03.min.json +205 -63
- package/node_modules/aws-sdk/apis/controlcatalog-2018-05-10.min.json +134 -40
- package/node_modules/aws-sdk/apis/controlcatalog-2018-05-10.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/controlcatalog-2018-05-10.waiters2.json +5 -0
- package/node_modules/aws-sdk/apis/controltower-2018-05-10.min.json +150 -5
- package/node_modules/aws-sdk/apis/controltower-2018-05-10.paginators.json +12 -0
- package/node_modules/aws-sdk/apis/cost-optimization-hub-2022-07-26.min.json +320 -262
- package/node_modules/aws-sdk/apis/cost-optimization-hub-2022-07-26.waiters2.json +5 -0
- package/node_modules/aws-sdk/apis/cur-2017-01-06.min.json +7 -1
- package/node_modules/aws-sdk/apis/customer-profiles-2020-08-15.min.json +52 -25
- package/node_modules/aws-sdk/apis/datasync-2018-11-09.min.json +3 -0
- package/node_modules/aws-sdk/apis/datazone-2018-05-10.min.json +2116 -480
- package/node_modules/aws-sdk/apis/datazone-2018-05-10.paginators.json +24 -0
- package/node_modules/aws-sdk/apis/devicefarm-2015-06-23.min.json +7 -1
- package/node_modules/aws-sdk/apis/directconnect-2012-10-25.min.json +7 -1
- package/node_modules/aws-sdk/apis/discovery-2015-11-01.min.json +3 -0
- package/node_modules/aws-sdk/apis/dms-2016-01-01.min.json +7 -1
- package/node_modules/aws-sdk/apis/docdb-2014-10-31.min.json +7 -1
- package/node_modules/aws-sdk/apis/ds-2015-04-16.min.json +7 -1
- package/node_modules/aws-sdk/apis/dynamodb-2011-12-05.min.json +7 -1
- package/node_modules/aws-sdk/apis/dynamodb-2012-08-10.min.json +256 -181
- package/node_modules/aws-sdk/apis/ec2-2016-11-15.min.json +1675 -1320
- package/node_modules/aws-sdk/apis/ecr-2015-09-21.examples.json +186 -0
- package/node_modules/aws-sdk/apis/ecr-2015-09-21.min.json +222 -21
- package/node_modules/aws-sdk/apis/ecr-2015-09-21.paginators.json +9 -0
- package/node_modules/aws-sdk/apis/ecs-2014-11-13.min.json +290 -256
- package/node_modules/aws-sdk/apis/eks-2017-11-01.min.json +169 -84
- package/node_modules/aws-sdk/apis/elasticache-2015-02-02.min.json +7 -1
- package/node_modules/aws-sdk/apis/elasticbeanstalk-2010-12-01.min.json +7 -1
- package/node_modules/aws-sdk/apis/elasticfilesystem-2015-02-01.min.json +7 -1
- package/node_modules/aws-sdk/apis/elasticloadbalancing-2012-06-01.min.json +7 -1
- package/node_modules/aws-sdk/apis/elasticloadbalancingv2-2015-12-01.examples.json +33 -0
- package/node_modules/aws-sdk/apis/elasticloadbalancingv2-2015-12-01.min.json +116 -73
- package/node_modules/aws-sdk/apis/elasticmapreduce-2009-03-31.min.json +15 -3
- package/node_modules/aws-sdk/apis/elastictranscoder-2012-09-25.min.json +7 -1
- package/node_modules/aws-sdk/apis/email-2010-12-01.min.json +7 -1
- package/node_modules/aws-sdk/apis/emr-serverless-2021-07-13.min.json +172 -14
- package/node_modules/aws-sdk/apis/emr-serverless-2021-07-13.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/entityresolution-2018-05-10.min.json +162 -94
- package/node_modules/aws-sdk/apis/es-2015-01-01.min.json +7 -1
- package/node_modules/aws-sdk/apis/eventbridge-2015-10-07.min.json +91 -29
- package/node_modules/aws-sdk/apis/firehose-2015-08-04.min.json +361 -167
- package/node_modules/aws-sdk/apis/fis-2020-12-01.min.json +19 -5
- package/node_modules/aws-sdk/apis/fms-2018-01-01.min.json +63 -59
- package/node_modules/aws-sdk/apis/fsx-2018-03-01.min.json +206 -164
- package/node_modules/aws-sdk/apis/gamelift-2015-10-01.min.json +7 -1
- package/node_modules/aws-sdk/apis/globalaccelerator-2018-08-08.min.json +13 -1
- package/node_modules/aws-sdk/apis/glue-2017-03-31.min.json +1227 -583
- package/node_modules/aws-sdk/apis/glue-2017-03-31.paginators.json +22 -8
- package/node_modules/aws-sdk/apis/grafana-2020-08-18.min.json +317 -15
- package/node_modules/aws-sdk/apis/grafana-2020-08-18.paginators.json +12 -0
- package/node_modules/aws-sdk/apis/greengrassv2-2020-11-30.min.json +17 -3
- package/node_modules/aws-sdk/apis/groundstation-2019-05-23.min.json +7 -1
- package/node_modules/aws-sdk/apis/guardduty-2017-11-28.min.json +429 -124
- package/node_modules/aws-sdk/apis/iam-2010-05-08.min.json +7 -1
- package/node_modules/aws-sdk/apis/imagebuilder-2019-12-02.min.json +3 -0
- package/node_modules/aws-sdk/apis/inspector2-2020-06-08.min.json +122 -96
- package/node_modules/aws-sdk/apis/iotfleetwise-2021-06-17.min.json +18 -10
- package/node_modules/aws-sdk/apis/iotsitewise-2019-12-02.min.json +113 -98
- package/node_modules/aws-sdk/apis/iottwinmaker-2021-11-29.min.json +3 -1
- package/node_modules/aws-sdk/apis/iotwireless-2020-11-22.min.json +7 -1
- package/node_modules/aws-sdk/apis/ivs-2020-07-14.min.json +159 -154
- package/node_modules/aws-sdk/apis/ivs-realtime-2020-07-14.min.json +396 -242
- package/node_modules/aws-sdk/apis/ivs-realtime-2020-07-14.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/ivs-realtime-2020-07-14.waiters2.json +5 -0
- package/node_modules/aws-sdk/apis/ivschat-2020-07-14.min.json +144 -139
- package/node_modules/aws-sdk/apis/ivschat-2020-07-14.waiters2.json +5 -0
- package/node_modules/aws-sdk/apis/kafka-2018-11-14.min.json +36 -6
- package/node_modules/aws-sdk/apis/kinesis-2013-12-02.min.json +7 -1
- package/node_modules/aws-sdk/apis/kinesis-video-webrtc-storage-2018-05-10.min.json +17 -0
- package/node_modules/aws-sdk/apis/kinesisanalyticsv2-2018-05-23.min.json +266 -110
- package/node_modules/aws-sdk/apis/kinesisanalyticsv2-2018-05-23.paginators.json +24 -0
- package/node_modules/aws-sdk/apis/kms-2014-11-01.examples.json +31 -0
- package/node_modules/aws-sdk/apis/kms-2014-11-01.min.json +79 -23
- package/node_modules/aws-sdk/apis/lakeformation-2017-03-31.min.json +43 -25
- package/node_modules/aws-sdk/apis/launch-wizard-2018-05-10.min.json +159 -0
- package/node_modules/aws-sdk/apis/license-manager-linux-subscriptions-2018-05-10.min.json +236 -16
- package/node_modules/aws-sdk/apis/license-manager-linux-subscriptions-2018-05-10.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/lightsail-2016-11-28.min.json +11 -2
- package/node_modules/aws-sdk/apis/location-2020-11-19.min.json +1036 -754
- package/node_modules/aws-sdk/apis/location-2020-11-19.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/logs-2014-03-28.min.json +7 -1
- package/node_modules/aws-sdk/apis/macie2-2020-01-01.min.json +254 -143
- package/node_modules/aws-sdk/apis/macie2-2020-01-01.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/mailmanager-2023-10-17.min.json +1836 -0
- package/node_modules/aws-sdk/apis/mailmanager-2023-10-17.paginators.json +58 -0
- package/node_modules/aws-sdk/apis/managedblockchain-2018-09-24.min.json +3 -0
- package/node_modules/aws-sdk/apis/mediaconnect-2018-11-14.min.json +106 -94
- package/node_modules/aws-sdk/apis/mediaconvert-2017-08-29.min.json +208 -131
- package/node_modules/aws-sdk/apis/mediaconvert-2017-08-29.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/medialive-2017-10-14.min.json +488 -364
- package/node_modules/aws-sdk/apis/mediapackagev2-2022-12-25.examples.json +1271 -0
- package/node_modules/aws-sdk/apis/mediapackagev2-2022-12-25.min.json +105 -71
- package/node_modules/aws-sdk/apis/medical-imaging-2023-07-19.min.json +80 -37
- package/node_modules/aws-sdk/apis/memorydb-2021-01-01.min.json +7 -1
- package/node_modules/aws-sdk/apis/metadata.json +24 -12
- package/node_modules/aws-sdk/apis/models.lex.v2-2020-08-07.min.json +374 -346
- package/node_modules/aws-sdk/apis/monitoring-2010-08-01.min.json +7 -1
- package/node_modules/aws-sdk/apis/mq-2017-11-27.min.json +4 -4
- package/node_modules/aws-sdk/apis/mwaa-2020-07-01.min.json +178 -158
- package/node_modules/aws-sdk/apis/network-firewall-2020-11-12.min.json +7 -1
- package/node_modules/aws-sdk/apis/networkmanager-2019-07-05.min.json +320 -176
- package/node_modules/aws-sdk/apis/omics-2022-11-28.min.json +36 -22
- package/node_modules/aws-sdk/apis/opensearch-2021-01-01.min.json +190 -115
- package/node_modules/aws-sdk/apis/opsworks-2013-02-18.min.json +3 -0
- package/node_modules/aws-sdk/apis/organizations-2016-11-28.min.json +7 -1
- package/node_modules/aws-sdk/apis/osis-2022-01-01.min.json +77 -28
- package/node_modules/aws-sdk/apis/outposts-2019-12-03.min.json +11 -2
- package/node_modules/aws-sdk/apis/payment-cryptography-2021-09-14.min.json +10 -1
- package/node_modules/aws-sdk/apis/payment-cryptography-data-2022-02-03.min.json +544 -383
- package/node_modules/aws-sdk/apis/payment-cryptography-data-2022-02-03.waiters2.json +5 -0
- package/node_modules/aws-sdk/apis/pca-connector-scep-2018-05-10.min.json +456 -0
- package/node_modules/aws-sdk/apis/pca-connector-scep-2018-05-10.paginators.json +16 -0
- package/node_modules/aws-sdk/apis/pca-connector-scep-2018-05-10.waiters2.json +5 -0
- package/node_modules/aws-sdk/apis/personalize-2018-05-22.min.json +153 -44
- package/node_modules/aws-sdk/apis/personalize-runtime-2018-05-22.min.json +9 -1
- package/node_modules/aws-sdk/apis/pi-2018-02-27.min.json +28 -18
- package/node_modules/aws-sdk/apis/pinpoint-2016-12-01.min.json +403 -378
- package/node_modules/aws-sdk/apis/pinpoint-sms-voice-v2-2022-03-31.min.json +527 -99
- package/node_modules/aws-sdk/apis/pinpoint-sms-voice-v2-2022-03-31.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/pipes-2015-10-07.min.json +632 -555
- package/node_modules/aws-sdk/apis/pipes-2015-10-07.waiters2.json +5 -0
- package/node_modules/aws-sdk/apis/polly-2016-06-10.min.json +7 -1
- package/node_modules/aws-sdk/apis/qapps-2023-11-27.examples.json +583 -0
- package/node_modules/aws-sdk/apis/qapps-2023-11-27.min.json +1312 -0
- package/node_modules/aws-sdk/apis/{mobile-2017-07-01.paginators.json → qapps-2023-11-27.paginators.json} +6 -4
- package/node_modules/aws-sdk/apis/qapps-2023-11-27.waiters2.json +5 -0
- package/node_modules/aws-sdk/apis/qbusiness-2023-11-27.examples.json +2 -3
- package/node_modules/aws-sdk/apis/qbusiness-2023-11-27.min.json +813 -689
- package/node_modules/aws-sdk/apis/qbusiness-2023-11-27.paginators.json +1 -1
- package/node_modules/aws-sdk/apis/qbusiness-2023-11-27.waiters2.json +5 -0
- package/node_modules/aws-sdk/apis/qconnect-2020-10-19.min.json +335 -108
- package/node_modules/aws-sdk/apis/qconnect-2020-10-19.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/quicksight-2018-04-01.min.json +2113 -1354
- package/node_modules/aws-sdk/apis/rds-2013-01-10.min.json +4 -1
- package/node_modules/aws-sdk/apis/rds-2013-02-12.min.json +4 -1
- package/node_modules/aws-sdk/apis/rds-2013-09-09.min.json +4 -1
- package/node_modules/aws-sdk/apis/rds-2014-09-01.min.json +4 -1
- package/node_modules/aws-sdk/apis/rds-2014-10-31.min.json +34 -10
- package/node_modules/aws-sdk/apis/redshift-2012-12-01.min.json +7 -1
- package/node_modules/aws-sdk/apis/redshift-serverless-2021-04-21.min.json +32 -22
- package/node_modules/aws-sdk/apis/rekognition-2016-06-27.min.json +15 -3
- package/node_modules/aws-sdk/apis/resiliencehub-2020-04-30.min.json +473 -144
- package/node_modules/aws-sdk/apis/resiliencehub-2020-04-30.paginators.json +12 -0
- package/node_modules/aws-sdk/apis/rolesanywhere-2018-05-10.min.json +16 -1
- package/node_modules/aws-sdk/apis/route53-2013-04-01.min.json +7 -1
- package/node_modules/aws-sdk/apis/route53domains-2014-05-15.min.json +7 -1
- package/node_modules/aws-sdk/apis/route53profiles-2018-05-10.min.json +3 -0
- package/node_modules/aws-sdk/apis/route53resolver-2018-04-01.min.json +62 -53
- package/node_modules/aws-sdk/apis/s3-2006-03-01.examples.json +76 -76
- package/node_modules/aws-sdk/apis/s3-2006-03-01.min.json +46 -5
- package/node_modules/aws-sdk/apis/sagemaker-2017-07-24.min.json +1993 -1207
- package/node_modules/aws-sdk/apis/sagemaker-2017-07-24.paginators.json +12 -0
- package/node_modules/aws-sdk/apis/secretsmanager-2017-10-17.min.json +11 -1
- package/node_modules/aws-sdk/apis/securityhub-2018-10-26.min.json +7 -1
- package/node_modules/aws-sdk/apis/securitylake-2018-05-10.min.json +7 -1
- package/node_modules/aws-sdk/apis/sesv2-2019-09-27.min.json +148 -136
- package/node_modules/aws-sdk/apis/shield-2016-06-02.min.json +7 -1
- package/node_modules/aws-sdk/apis/signer-2017-08-25.min.json +3 -0
- package/node_modules/aws-sdk/apis/snowball-2016-06-30.min.json +7 -1
- package/node_modules/aws-sdk/apis/sns-2010-03-31.min.json +7 -1
- package/node_modules/aws-sdk/apis/sqs-2012-11-05.min.json +24 -14
- package/node_modules/aws-sdk/apis/ssm-2014-11-06.min.json +14 -3
- package/node_modules/aws-sdk/apis/ssm-quicksetup-2018-05-10.examples.json +5 -0
- package/node_modules/aws-sdk/apis/ssm-quicksetup-2018-05-10.min.json +454 -0
- package/node_modules/aws-sdk/apis/ssm-quicksetup-2018-05-10.paginators.json +10 -0
- package/node_modules/aws-sdk/apis/ssm-sap-2018-05-10.min.json +95 -0
- package/node_modules/aws-sdk/apis/ssm-sap-2018-05-10.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/sso-oidc-2019-06-10.examples.json +9 -0
- package/node_modules/aws-sdk/apis/sso-oidc-2019-06-10.min.json +32 -9
- package/node_modules/aws-sdk/apis/states-2016-11-23.min.json +167 -129
- package/node_modules/aws-sdk/apis/storagegateway-2013-06-30.min.json +30 -14
- package/node_modules/aws-sdk/apis/support-2013-04-15.min.json +4 -1
- package/node_modules/aws-sdk/apis/swf-2012-01-25.min.json +104 -68
- package/node_modules/aws-sdk/apis/taxsettings-2018-05-10.examples.json +5 -0
- package/node_modules/aws-sdk/apis/taxsettings-2018-05-10.min.json +661 -0
- package/node_modules/aws-sdk/apis/taxsettings-2018-05-10.paginators.json +10 -0
- package/node_modules/aws-sdk/apis/timestream-query-2018-11-01.min.json +75 -24
- package/node_modules/aws-sdk/apis/tnb-2008-10-21.min.json +90 -23
- package/node_modules/aws-sdk/apis/transcribe-2017-10-26.min.json +101 -76
- package/node_modules/aws-sdk/apis/transfer-2018-11-05.min.json +19 -8
- package/node_modules/aws-sdk/apis/trustedadvisor-2022-09-15.min.json +107 -46
- package/node_modules/aws-sdk/apis/verifiedpermissions-2021-12-01.min.json +345 -83
- package/node_modules/aws-sdk/apis/waf-2015-08-24.min.json +7 -1
- package/node_modules/aws-sdk/apis/waf-regional-2016-11-28.min.json +7 -1
- package/node_modules/aws-sdk/apis/wafv2-2019-07-29.min.json +46 -33
- package/node_modules/aws-sdk/apis/workspaces-2015-04-08.min.json +513 -76
- package/node_modules/aws-sdk/apis/workspaces-thin-client-2023-08-22.min.json +33 -13
- package/node_modules/aws-sdk/apis/workspaces-web-2020-07-08.min.json +8 -1
- package/node_modules/aws-sdk/clients/accessanalyzer.d.ts +162 -3
- package/node_modules/aws-sdk/clients/account.d.ts +84 -9
- package/node_modules/aws-sdk/clients/acm.d.ts +8 -8
- package/node_modules/aws-sdk/clients/acmpca.d.ts +28 -28
- package/node_modules/aws-sdk/clients/all.d.ts +7 -4
- package/node_modules/aws-sdk/clients/all.js +8 -5
- package/node_modules/aws-sdk/clients/amplify.d.ts +35 -15
- package/node_modules/aws-sdk/clients/appintegrations.d.ts +122 -13
- package/node_modules/aws-sdk/clients/applicationautoscaling.d.ts +43 -43
- package/node_modules/aws-sdk/clients/applicationsignals.d.ts +964 -0
- package/node_modules/aws-sdk/clients/applicationsignals.js +18 -0
- package/node_modules/aws-sdk/clients/appstream.d.ts +208 -9
- package/node_modules/aws-sdk/clients/apptest.d.ts +2019 -0
- package/node_modules/aws-sdk/clients/apptest.js +19 -0
- package/node_modules/aws-sdk/clients/arczonalshift.d.ts +66 -29
- package/node_modules/aws-sdk/clients/artifact.d.ts +68 -64
- package/node_modules/aws-sdk/clients/artifact.js +1 -0
- package/node_modules/aws-sdk/clients/athena.d.ts +5 -5
- package/node_modules/aws-sdk/clients/auditmanager.d.ts +45 -33
- package/node_modules/aws-sdk/clients/autoscaling.d.ts +71 -70
- package/node_modules/aws-sdk/clients/b2bi.d.ts +8 -8
- package/node_modules/aws-sdk/clients/batch.d.ts +54 -1
- package/node_modules/aws-sdk/clients/bedrock.d.ts +289 -26
- package/node_modules/aws-sdk/clients/bedrockagent.d.ts +2327 -211
- package/node_modules/aws-sdk/clients/bedrockagentruntime.d.ts +707 -29
- package/node_modules/aws-sdk/clients/bedrockruntime.d.ts +855 -7
- package/node_modules/aws-sdk/clients/budgets.d.ts +84 -1
- package/node_modules/aws-sdk/clients/chatbot.d.ts +100 -0
- package/node_modules/aws-sdk/clients/chimesdkmediapipelines.d.ts +19 -15
- package/node_modules/aws-sdk/clients/chimesdkvoice.d.ts +9 -9
- package/node_modules/aws-sdk/clients/cleanrooms.d.ts +1079 -16
- package/node_modules/aws-sdk/clients/cleanroomsml.d.ts +284 -257
- package/node_modules/aws-sdk/clients/cleanroomsml.js +1 -0
- package/node_modules/aws-sdk/clients/cloudformation.d.ts +11 -2
- package/node_modules/aws-sdk/clients/cloudfront.d.ts +7 -7
- package/node_modules/aws-sdk/clients/cloudhsmv2.d.ts +134 -34
- package/node_modules/aws-sdk/clients/cloudtrail.d.ts +29 -12
- package/node_modules/aws-sdk/clients/codeartifact.d.ts +28 -28
- package/node_modules/aws-sdk/clients/codebuild.d.ts +79 -32
- package/node_modules/aws-sdk/clients/codegurusecurity.d.ts +60 -55
- package/node_modules/aws-sdk/clients/codepipeline.d.ts +485 -5
- package/node_modules/aws-sdk/clients/cognitoidentityserviceprovider.d.ts +92 -55
- package/node_modules/aws-sdk/clients/computeoptimizer.d.ts +451 -49
- package/node_modules/aws-sdk/clients/connect.d.ts +1213 -69
- package/node_modules/aws-sdk/clients/connectcases.d.ts +124 -1
- package/node_modules/aws-sdk/clients/connectcontactlens.d.ts +24 -3
- package/node_modules/aws-sdk/clients/controlcatalog.d.ts +116 -24
- package/node_modules/aws-sdk/clients/controlcatalog.js +1 -0
- package/node_modules/aws-sdk/clients/controltower.d.ts +244 -44
- package/node_modules/aws-sdk/clients/costoptimizationhub.d.ts +398 -330
- package/node_modules/aws-sdk/clients/costoptimizationhub.js +1 -0
- package/node_modules/aws-sdk/clients/customerprofiles.d.ts +35 -5
- package/node_modules/aws-sdk/clients/datasync.d.ts +7 -7
- package/node_modules/aws-sdk/clients/datazone.d.ts +1917 -100
- package/node_modules/aws-sdk/clients/directconnect.d.ts +40 -25
- package/node_modules/aws-sdk/clients/dynamodb.d.ts +116 -47
- package/node_modules/aws-sdk/clients/ec2.d.ts +729 -308
- package/node_modules/aws-sdk/clients/ecr.d.ts +296 -8
- package/node_modules/aws-sdk/clients/ecs.d.ts +47 -5
- package/node_modules/aws-sdk/clients/eks.d.ts +127 -22
- package/node_modules/aws-sdk/clients/elasticache.d.ts +198 -198
- package/node_modules/aws-sdk/clients/elbv2.d.ts +59 -13
- package/node_modules/aws-sdk/clients/emr.d.ts +12 -4
- package/node_modules/aws-sdk/clients/emrserverless.d.ts +191 -0
- package/node_modules/aws-sdk/clients/entityresolution.d.ts +105 -22
- package/node_modules/aws-sdk/clients/eventbridge.d.ts +111 -20
- package/node_modules/aws-sdk/clients/firehose.d.ts +214 -10
- package/node_modules/aws-sdk/clients/fis.d.ts +21 -0
- package/node_modules/aws-sdk/clients/fms.d.ts +12 -7
- package/node_modules/aws-sdk/clients/fsx.d.ts +84 -36
- package/node_modules/aws-sdk/clients/globalaccelerator.d.ts +8 -0
- package/node_modules/aws-sdk/clients/glue.d.ts +981 -24
- package/node_modules/aws-sdk/clients/grafana.d.ts +297 -11
- package/node_modules/aws-sdk/clients/greengrassv2.d.ts +15 -5
- package/node_modules/aws-sdk/clients/guardduty.d.ts +277 -5
- package/node_modules/aws-sdk/clients/inspector2.d.ts +49 -3
- package/node_modules/aws-sdk/clients/iotfleetwise.d.ts +11 -1
- package/node_modules/aws-sdk/clients/iotsitewise.d.ts +37 -25
- package/node_modules/aws-sdk/clients/iottwinmaker.d.ts +1 -1
- package/node_modules/aws-sdk/clients/iotwireless.d.ts +2 -2
- package/node_modules/aws-sdk/clients/ivs.d.ts +229 -229
- package/node_modules/aws-sdk/clients/ivschat.d.ts +166 -166
- package/node_modules/aws-sdk/clients/ivschat.js +1 -0
- package/node_modules/aws-sdk/clients/ivsrealtime.d.ts +433 -235
- package/node_modules/aws-sdk/clients/ivsrealtime.js +1 -0
- package/node_modules/aws-sdk/clients/kafka.d.ts +35 -0
- package/node_modules/aws-sdk/clients/kinesisanalyticsv2.d.ts +147 -3
- package/node_modules/aws-sdk/clients/kinesisvideowebrtcstorage.d.ts +21 -2
- package/node_modules/aws-sdk/clients/kms.d.ts +78 -12
- package/node_modules/aws-sdk/clients/lakeformation.d.ts +17 -0
- package/node_modules/aws-sdk/clients/launchwizard.d.ts +181 -8
- package/node_modules/aws-sdk/clients/lexmodelsv2.d.ts +45 -5
- package/node_modules/aws-sdk/clients/licensemanagerlinuxsubscriptions.d.ts +249 -10
- package/node_modules/aws-sdk/clients/lightsail.d.ts +29 -25
- package/node_modules/aws-sdk/clients/location.d.ts +981 -677
- package/node_modules/aws-sdk/clients/macie2.d.ts +149 -44
- package/node_modules/aws-sdk/clients/mailmanager.d.ts +2320 -0
- package/node_modules/aws-sdk/clients/mailmanager.js +18 -0
- package/node_modules/aws-sdk/clients/managedblockchain.d.ts +4 -4
- package/node_modules/aws-sdk/clients/mediaconnect.d.ts +13 -0
- package/node_modules/aws-sdk/clients/mediaconvert.d.ts +77 -6
- package/node_modules/aws-sdk/clients/medialive.d.ts +114 -4
- package/node_modules/aws-sdk/clients/mediapackagev2.d.ts +58 -5
- package/node_modules/aws-sdk/clients/medicalimaging.d.ts +45 -2
- package/node_modules/aws-sdk/clients/memorydb.d.ts +9 -9
- package/node_modules/aws-sdk/clients/mq.d.ts +15 -15
- package/node_modules/aws-sdk/clients/mwaa.d.ts +215 -189
- package/node_modules/aws-sdk/clients/networkfirewall.d.ts +7 -7
- package/node_modules/aws-sdk/clients/networkmanager.d.ts +237 -11
- package/node_modules/aws-sdk/clients/omics.d.ts +89 -53
- package/node_modules/aws-sdk/clients/opensearch.d.ts +120 -3
- package/node_modules/aws-sdk/clients/opsworks.d.ts +117 -117
- package/node_modules/aws-sdk/clients/organizations.d.ts +2 -2
- package/node_modules/aws-sdk/clients/osis.d.ts +89 -5
- package/node_modules/aws-sdk/clients/outposts.d.ts +5 -0
- package/node_modules/aws-sdk/clients/paymentcryptography.d.ts +3 -3
- package/node_modules/aws-sdk/clients/paymentcryptographydata.d.ts +358 -311
- package/node_modules/aws-sdk/clients/paymentcryptographydata.js +1 -0
- package/node_modules/aws-sdk/clients/pcaconnectorscep.d.ts +486 -0
- package/node_modules/aws-sdk/clients/pcaconnectorscep.js +19 -0
- package/node_modules/aws-sdk/clients/personalize.d.ts +160 -1
- package/node_modules/aws-sdk/clients/personalizeruntime.d.ts +6 -0
- package/node_modules/aws-sdk/clients/pi.d.ts +18 -11
- package/node_modules/aws-sdk/clients/pinpoint.d.ts +27 -0
- package/node_modules/aws-sdk/clients/pinpointsmsvoicev2.d.ts +567 -61
- package/node_modules/aws-sdk/clients/pipes.d.ts +455 -348
- package/node_modules/aws-sdk/clients/pipes.js +1 -0
- package/node_modules/aws-sdk/clients/polly.d.ts +9 -9
- package/node_modules/aws-sdk/clients/qapps.d.ts +1442 -0
- package/node_modules/aws-sdk/clients/qapps.js +19 -0
- package/node_modules/aws-sdk/clients/qbusiness.d.ts +855 -699
- package/node_modules/aws-sdk/clients/qbusiness.js +1 -0
- package/node_modules/aws-sdk/clients/qconnect.d.ts +219 -1
- package/node_modules/aws-sdk/clients/quicksight.d.ts +901 -14
- package/node_modules/aws-sdk/clients/rds.d.ts +90 -30
- package/node_modules/aws-sdk/clients/redshift.d.ts +16 -16
- package/node_modules/aws-sdk/clients/redshiftserverless.d.ts +37 -10
- package/node_modules/aws-sdk/clients/rekognition.d.ts +11 -3
- package/node_modules/aws-sdk/clients/resiliencehub.d.ts +385 -29
- package/node_modules/aws-sdk/clients/rolesanywhere.d.ts +12 -0
- package/node_modules/aws-sdk/clients/route53profiles.d.ts +4 -4
- package/node_modules/aws-sdk/clients/route53resolver.d.ts +18 -5
- package/node_modules/aws-sdk/clients/s3.d.ts +34 -10
- package/node_modules/aws-sdk/clients/sagemaker.d.ts +1123 -67
- package/node_modules/aws-sdk/clients/secretsmanager.d.ts +23 -18
- package/node_modules/aws-sdk/clients/securityhub.d.ts +71 -71
- package/node_modules/aws-sdk/clients/securitylake.d.ts +3 -3
- package/node_modules/aws-sdk/clients/sesv2.d.ts +28 -10
- package/node_modules/aws-sdk/clients/signer.d.ts +3 -3
- package/node_modules/aws-sdk/clients/sns.d.ts +7 -7
- package/node_modules/aws-sdk/clients/sqs.d.ts +24 -19
- package/node_modules/aws-sdk/clients/ssm.d.ts +16 -16
- package/node_modules/aws-sdk/clients/ssmquicksetup.d.ts +495 -0
- package/node_modules/aws-sdk/clients/ssmquicksetup.js +18 -0
- package/node_modules/aws-sdk/clients/ssmsap.d.ts +121 -1
- package/node_modules/aws-sdk/clients/ssooidc.d.ts +32 -4
- package/node_modules/aws-sdk/clients/stepfunctions.d.ts +67 -9
- package/node_modules/aws-sdk/clients/storagegateway.d.ts +37 -22
- package/node_modules/aws-sdk/clients/support.d.ts +1 -1
- package/node_modules/aws-sdk/clients/swf.d.ts +38 -2
- package/node_modules/aws-sdk/clients/taxsettings.d.ts +809 -0
- package/node_modules/aws-sdk/clients/taxsettings.js +18 -0
- package/node_modules/aws-sdk/clients/timestreamquery.d.ts +54 -0
- package/node_modules/aws-sdk/clients/tnb.d.ts +95 -18
- package/node_modules/aws-sdk/clients/transcribeservice.d.ts +32 -0
- package/node_modules/aws-sdk/clients/transfer.d.ts +5 -5
- package/node_modules/aws-sdk/clients/trustedadvisor.d.ts +66 -2
- package/node_modules/aws-sdk/clients/verifiedpermissions.d.ts +300 -14
- package/node_modules/aws-sdk/clients/vpclattice.d.ts +81 -81
- package/node_modules/aws-sdk/clients/wafv2.d.ts +35 -5
- package/node_modules/aws-sdk/clients/workspaces.d.ts +603 -11
- package/node_modules/aws-sdk/clients/workspacesthinclient.d.ts +15 -0
- package/node_modules/aws-sdk/clients/workspacesweb.d.ts +21 -1
- package/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js +9 -5
- package/node_modules/aws-sdk/dist/aws-sdk-react-native.js +2357 -2099
- package/node_modules/aws-sdk/dist/aws-sdk.js +7454 -4038
- package/node_modules/aws-sdk/dist/aws-sdk.min.js +108 -106
- package/node_modules/aws-sdk/lib/config_service_placeholders.d.ts +14 -8
- package/node_modules/aws-sdk/lib/core.js +1 -1
- package/node_modules/aws-sdk/lib/credentials/cognito_identity_credentials.js +9 -0
- package/node_modules/aws-sdk/lib/credentials/sso_credentials.js +1 -1
- package/node_modules/aws-sdk/lib/credentials/token_file_web_identity_credentials.d.ts +2 -2
- package/node_modules/aws-sdk/lib/dynamodb/document_client.d.ts +86 -17
- package/node_modules/aws-sdk/lib/metadata_service.d.ts +4 -0
- package/node_modules/aws-sdk/lib/metadata_service.js +1 -2
- package/node_modules/aws-sdk/lib/protocol/rest_json.js +2 -1
- package/node_modules/aws-sdk/lib/query/query_param_serializer.js +3 -1
- package/node_modules/aws-sdk/lib/region_config.js +2 -1
- package/node_modules/aws-sdk/lib/services/s3.js +56 -7
- package/node_modules/aws-sdk/lib/shared-ini/ini-loader.d.ts +24 -1
- package/node_modules/aws-sdk/lib/shared-ini/ini-loader.js +0 -6
- package/node_modules/aws-sdk/package.json +1 -1
- package/node_modules/aws-sdk/scripts/region-checker/allowlist.js +11 -10
- package/node_modules/xml2js/node_modules/sax/LICENSE +2 -2
- package/node_modules/xml2js/node_modules/sax/README.md +3 -0
- package/node_modules/xml2js/node_modules/sax/lib/sax.js +33 -10
- package/node_modules/xml2js/node_modules/sax/package.json +1 -1
- package/package.json +17 -11
- package/node_modules/aws-sdk/apis/alexaforbusiness-2017-11-09.min.json +0 -2905
- package/node_modules/aws-sdk/apis/alexaforbusiness-2017-11-09.paginators.json +0 -94
- package/node_modules/aws-sdk/apis/backupstorage-2018-04-10.min.json +0 -522
- package/node_modules/aws-sdk/apis/backupstorage-2018-04-10.paginators.json +0 -14
- package/node_modules/aws-sdk/apis/honeycode-2020-03-01.min.json +0 -962
- package/node_modules/aws-sdk/apis/honeycode-2020-03-01.paginators.json +0 -27
- package/node_modules/aws-sdk/apis/mobile-2017-07-01.min.json +0 -341
- package/node_modules/aws-sdk/clients/alexaforbusiness.d.ts +0 -3862
- package/node_modules/aws-sdk/clients/alexaforbusiness.js +0 -18
- package/node_modules/aws-sdk/clients/backupstorage.d.ts +0 -469
- package/node_modules/aws-sdk/clients/backupstorage.js +0 -18
- package/node_modules/aws-sdk/clients/honeycode.d.ts +0 -910
- package/node_modules/aws-sdk/clients/honeycode.js +0 -18
- package/node_modules/aws-sdk/clients/mobile.d.ts +0 -333
- package/node_modules/aws-sdk/clients/mobile.js +0 -18
- /package/node_modules/aws-sdk/apis/{alexaforbusiness-2017-11-09.examples.json → application-signals-2024-04-15.examples.json} +0 -0
- /package/node_modules/aws-sdk/apis/{backupstorage-2018-04-10.examples.json → apptest-2022-12-06.examples.json} +0 -0
- /package/node_modules/aws-sdk/apis/{honeycode-2020-03-01.examples.json → mailmanager-2023-10-17.examples.json} +0 -0
- /package/node_modules/aws-sdk/apis/{mobile-2017-07-01.examples.json → pca-connector-scep-2018-05-10.examples.json} +0 -0
|
@@ -147,6 +147,14 @@ declare class Connect extends Service {
|
|
|
147
147
|
* This API is in preview release for Amazon Connect and is subject to change. Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.
|
|
148
148
|
*/
|
|
149
149
|
batchDisassociateAnalyticsDataSet(callback?: (err: AWSError, data: Connect.Types.BatchDisassociateAnalyticsDataSetResponse) => void): Request<Connect.Types.BatchDisassociateAnalyticsDataSetResponse, AWSError>;
|
|
150
|
+
/**
|
|
151
|
+
* Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.
|
|
152
|
+
*/
|
|
153
|
+
batchGetAttachedFileMetadata(params: Connect.Types.BatchGetAttachedFileMetadataRequest, callback?: (err: AWSError, data: Connect.Types.BatchGetAttachedFileMetadataResponse) => void): Request<Connect.Types.BatchGetAttachedFileMetadataResponse, AWSError>;
|
|
154
|
+
/**
|
|
155
|
+
* Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.
|
|
156
|
+
*/
|
|
157
|
+
batchGetAttachedFileMetadata(callback?: (err: AWSError, data: Connect.Types.BatchGetAttachedFileMetadataResponse) => void): Request<Connect.Types.BatchGetAttachedFileMetadataResponse, AWSError>;
|
|
150
158
|
/**
|
|
151
159
|
* Retrieve the flow associations for the given resources.
|
|
152
160
|
*/
|
|
@@ -164,13 +172,21 @@ declare class Connect extends Service {
|
|
|
164
172
|
*/
|
|
165
173
|
batchPutContact(callback?: (err: AWSError, data: Connect.Types.BatchPutContactResponse) => void): Request<Connect.Types.BatchPutContactResponse, AWSError>;
|
|
166
174
|
/**
|
|
167
|
-
* Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created. For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide. You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation. If you plan to claim and release numbers frequently
|
|
175
|
+
* Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created. For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide. You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation. If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired. For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
|
|
168
176
|
*/
|
|
169
177
|
claimPhoneNumber(params: Connect.Types.ClaimPhoneNumberRequest, callback?: (err: AWSError, data: Connect.Types.ClaimPhoneNumberResponse) => void): Request<Connect.Types.ClaimPhoneNumberResponse, AWSError>;
|
|
170
178
|
/**
|
|
171
|
-
* Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created. For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide. You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation. If you plan to claim and release numbers frequently
|
|
179
|
+
* Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created. For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide. You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation. If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired. For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
|
|
172
180
|
*/
|
|
173
181
|
claimPhoneNumber(callback?: (err: AWSError, data: Connect.Types.ClaimPhoneNumberResponse) => void): Request<Connect.Types.ClaimPhoneNumberResponse, AWSError>;
|
|
182
|
+
/**
|
|
183
|
+
* Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
|
|
184
|
+
*/
|
|
185
|
+
completeAttachedFileUpload(params: Connect.Types.CompleteAttachedFileUploadRequest, callback?: (err: AWSError, data: Connect.Types.CompleteAttachedFileUploadResponse) => void): Request<Connect.Types.CompleteAttachedFileUploadResponse, AWSError>;
|
|
186
|
+
/**
|
|
187
|
+
* Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
|
|
188
|
+
*/
|
|
189
|
+
completeAttachedFileUpload(callback?: (err: AWSError, data: Connect.Types.CompleteAttachedFileUploadResponse) => void): Request<Connect.Types.CompleteAttachedFileUploadResponse, AWSError>;
|
|
174
190
|
/**
|
|
175
191
|
* This API is in preview release for Amazon Connect and is subject to change. Creates an agent status for the specified Amazon Connect instance.
|
|
176
192
|
*/
|
|
@@ -212,11 +228,11 @@ declare class Connect extends Service {
|
|
|
212
228
|
*/
|
|
213
229
|
createHoursOfOperation(callback?: (err: AWSError, data: Connect.Types.CreateHoursOfOperationResponse) => void): Request<Connect.Types.CreateHoursOfOperationResponse, AWSError>;
|
|
214
230
|
/**
|
|
215
|
-
* This API is in preview release for Amazon Connect and is subject to change. Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect. Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
|
|
231
|
+
* This API is in preview release for Amazon Connect and is subject to change. Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect. For more information, see Create an Amazon Connect instance in the Amazon Connect Administrator Guide. Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
|
|
216
232
|
*/
|
|
217
233
|
createInstance(params: Connect.Types.CreateInstanceRequest, callback?: (err: AWSError, data: Connect.Types.CreateInstanceResponse) => void): Request<Connect.Types.CreateInstanceResponse, AWSError>;
|
|
218
234
|
/**
|
|
219
|
-
* This API is in preview release for Amazon Connect and is subject to change. Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect. Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
|
|
235
|
+
* This API is in preview release for Amazon Connect and is subject to change. Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect. For more information, see Create an Amazon Connect instance in the Amazon Connect Administrator Guide. Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
|
|
220
236
|
*/
|
|
221
237
|
createInstance(callback?: (err: AWSError, data: Connect.Types.CreateInstanceResponse) => void): Request<Connect.Types.CreateInstanceResponse, AWSError>;
|
|
222
238
|
/**
|
|
@@ -244,19 +260,19 @@ declare class Connect extends Service {
|
|
|
244
260
|
*/
|
|
245
261
|
createPersistentContactAssociation(callback?: (err: AWSError, data: Connect.Types.CreatePersistentContactAssociationResponse) => void): Request<Connect.Types.CreatePersistentContactAssociationResponse, AWSError>;
|
|
246
262
|
/**
|
|
247
|
-
* Creates a new predefined attribute for the specified Amazon Connect instance.
|
|
263
|
+
* Creates a new predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.
|
|
248
264
|
*/
|
|
249
265
|
createPredefinedAttribute(params: Connect.Types.CreatePredefinedAttributeRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
250
266
|
/**
|
|
251
|
-
* Creates a new predefined attribute for the specified Amazon Connect instance.
|
|
267
|
+
* Creates a new predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.
|
|
252
268
|
*/
|
|
253
269
|
createPredefinedAttribute(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
254
270
|
/**
|
|
255
|
-
* Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator
|
|
271
|
+
* Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator Guide.
|
|
256
272
|
*/
|
|
257
273
|
createPrompt(params: Connect.Types.CreatePromptRequest, callback?: (err: AWSError, data: Connect.Types.CreatePromptResponse) => void): Request<Connect.Types.CreatePromptResponse, AWSError>;
|
|
258
274
|
/**
|
|
259
|
-
* Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator
|
|
275
|
+
* Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator Guide.
|
|
260
276
|
*/
|
|
261
277
|
createPrompt(callback?: (err: AWSError, data: Connect.Types.CreatePromptResponse) => void): Request<Connect.Types.CreatePromptResponse, AWSError>;
|
|
262
278
|
/**
|
|
@@ -292,11 +308,11 @@ declare class Connect extends Service {
|
|
|
292
308
|
*/
|
|
293
309
|
createRule(callback?: (err: AWSError, data: Connect.Types.CreateRuleResponse) => void): Request<Connect.Types.CreateRuleResponse, AWSError>;
|
|
294
310
|
/**
|
|
295
|
-
* Creates a security profile.
|
|
311
|
+
* Creates a security profile. For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
|
|
296
312
|
*/
|
|
297
313
|
createSecurityProfile(params: Connect.Types.CreateSecurityProfileRequest, callback?: (err: AWSError, data: Connect.Types.CreateSecurityProfileResponse) => void): Request<Connect.Types.CreateSecurityProfileResponse, AWSError>;
|
|
298
314
|
/**
|
|
299
|
-
* Creates a security profile.
|
|
315
|
+
* Creates a security profile. For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
|
|
300
316
|
*/
|
|
301
317
|
createSecurityProfile(callback?: (err: AWSError, data: Connect.Types.CreateSecurityProfileResponse) => void): Request<Connect.Types.CreateSecurityProfileResponse, AWSError>;
|
|
302
318
|
/**
|
|
@@ -371,6 +387,14 @@ declare class Connect extends Service {
|
|
|
371
387
|
* Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.
|
|
372
388
|
*/
|
|
373
389
|
deactivateEvaluationForm(callback?: (err: AWSError, data: Connect.Types.DeactivateEvaluationFormResponse) => void): Request<Connect.Types.DeactivateEvaluationFormResponse, AWSError>;
|
|
390
|
+
/**
|
|
391
|
+
* Deletes an attached file along with the underlying S3 Object. The attached file is permanently deleted if S3 bucket versioning is not enabled.
|
|
392
|
+
*/
|
|
393
|
+
deleteAttachedFile(params: Connect.Types.DeleteAttachedFileRequest, callback?: (err: AWSError, data: Connect.Types.DeleteAttachedFileResponse) => void): Request<Connect.Types.DeleteAttachedFileResponse, AWSError>;
|
|
394
|
+
/**
|
|
395
|
+
* Deletes an attached file along with the underlying S3 Object. The attached file is permanently deleted if S3 bucket versioning is not enabled.
|
|
396
|
+
*/
|
|
397
|
+
deleteAttachedFile(callback?: (err: AWSError, data: Connect.Types.DeleteAttachedFileResponse) => void): Request<Connect.Types.DeleteAttachedFileResponse, AWSError>;
|
|
374
398
|
/**
|
|
375
399
|
* Deletes a contact evaluation in the specified Amazon Connect instance.
|
|
376
400
|
*/
|
|
@@ -412,11 +436,11 @@ declare class Connect extends Service {
|
|
|
412
436
|
*/
|
|
413
437
|
deleteHoursOfOperation(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
414
438
|
/**
|
|
415
|
-
* This API is in preview release for Amazon Connect and is subject to change. Deletes the Amazon Connect instance. Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
|
|
439
|
+
* This API is in preview release for Amazon Connect and is subject to change. Deletes the Amazon Connect instance. For more information, see Delete your Amazon Connect instance in the Amazon Connect Administrator Guide. Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
|
|
416
440
|
*/
|
|
417
441
|
deleteInstance(params: Connect.Types.DeleteInstanceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
418
442
|
/**
|
|
419
|
-
* This API is in preview release for Amazon Connect and is subject to change. Deletes the Amazon Connect instance. Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
|
|
443
|
+
* This API is in preview release for Amazon Connect and is subject to change. Deletes the Amazon Connect instance. For more information, see Delete your Amazon Connect instance in the Amazon Connect Administrator Guide. Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
|
|
420
444
|
*/
|
|
421
445
|
deleteInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
422
446
|
/**
|
|
@@ -444,11 +468,11 @@ declare class Connect extends Service {
|
|
|
444
468
|
*/
|
|
445
469
|
deletePrompt(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
446
470
|
/**
|
|
447
|
-
* Deletes a queue.
|
|
471
|
+
* Deletes a queue. It isn't possible to delete a queue by using the Amazon Connect admin website.
|
|
448
472
|
*/
|
|
449
473
|
deleteQueue(params: Connect.Types.DeleteQueueRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
450
474
|
/**
|
|
451
|
-
* Deletes a queue.
|
|
475
|
+
* Deletes a queue. It isn't possible to delete a queue by using the Amazon Connect admin website.
|
|
452
476
|
*/
|
|
453
477
|
deleteQueue(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
454
478
|
/**
|
|
@@ -555,6 +579,14 @@ declare class Connect extends Service {
|
|
|
555
579
|
* This API is in preview release for Amazon Connect and is subject to change. Describes an agent status.
|
|
556
580
|
*/
|
|
557
581
|
describeAgentStatus(callback?: (err: AWSError, data: Connect.Types.DescribeAgentStatusResponse) => void): Request<Connect.Types.DescribeAgentStatusResponse, AWSError>;
|
|
582
|
+
/**
|
|
583
|
+
* This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support. Describes the target authentication profile.
|
|
584
|
+
*/
|
|
585
|
+
describeAuthenticationProfile(params: Connect.Types.DescribeAuthenticationProfileRequest, callback?: (err: AWSError, data: Connect.Types.DescribeAuthenticationProfileResponse) => void): Request<Connect.Types.DescribeAuthenticationProfileResponse, AWSError>;
|
|
586
|
+
/**
|
|
587
|
+
* This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support. Describes the target authentication profile.
|
|
588
|
+
*/
|
|
589
|
+
describeAuthenticationProfile(callback?: (err: AWSError, data: Connect.Types.DescribeAuthenticationProfileResponse) => void): Request<Connect.Types.DescribeAuthenticationProfileResponse, AWSError>;
|
|
558
590
|
/**
|
|
559
591
|
* This API is in preview release for Amazon Connect and is subject to change. Describes the specified contact. Contact information remains available in Amazon Connect for 24 months, and then it is deleted. Only data from November 12, 2021, and later is returned by this API.
|
|
560
592
|
*/
|
|
@@ -572,19 +604,19 @@ declare class Connect extends Service {
|
|
|
572
604
|
*/
|
|
573
605
|
describeContactEvaluation(callback?: (err: AWSError, data: Connect.Types.DescribeContactEvaluationResponse) => void): Request<Connect.Types.DescribeContactEvaluationResponse, AWSError>;
|
|
574
606
|
/**
|
|
575
|
-
* Describes the specified flow. You can also create and update flows using the Amazon Connect Flow language.
|
|
607
|
+
* Describes the specified flow. You can also create and update flows using the Amazon Connect Flow language. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published. In the response, Status indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. SAVED does not initiate validation of the content. SAVED | PUBLISHED
|
|
576
608
|
*/
|
|
577
609
|
describeContactFlow(params: Connect.Types.DescribeContactFlowRequest, callback?: (err: AWSError, data: Connect.Types.DescribeContactFlowResponse) => void): Request<Connect.Types.DescribeContactFlowResponse, AWSError>;
|
|
578
610
|
/**
|
|
579
|
-
* Describes the specified flow. You can also create and update flows using the Amazon Connect Flow language.
|
|
611
|
+
* Describes the specified flow. You can also create and update flows using the Amazon Connect Flow language. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published. In the response, Status indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. SAVED does not initiate validation of the content. SAVED | PUBLISHED
|
|
580
612
|
*/
|
|
581
613
|
describeContactFlow(callback?: (err: AWSError, data: Connect.Types.DescribeContactFlowResponse) => void): Request<Connect.Types.DescribeContactFlowResponse, AWSError>;
|
|
582
614
|
/**
|
|
583
|
-
* Describes the specified flow module.
|
|
615
|
+
* Describes the specified flow module. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.
|
|
584
616
|
*/
|
|
585
617
|
describeContactFlowModule(params: Connect.Types.DescribeContactFlowModuleRequest, callback?: (err: AWSError, data: Connect.Types.DescribeContactFlowModuleResponse) => void): Request<Connect.Types.DescribeContactFlowModuleResponse, AWSError>;
|
|
586
618
|
/**
|
|
587
|
-
* Describes the specified flow module.
|
|
619
|
+
* Describes the specified flow module. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.
|
|
588
620
|
*/
|
|
589
621
|
describeContactFlowModule(callback?: (err: AWSError, data: Connect.Types.DescribeContactFlowModuleResponse) => void): Request<Connect.Types.DescribeContactFlowModuleResponse, AWSError>;
|
|
590
622
|
/**
|
|
@@ -636,11 +668,11 @@ declare class Connect extends Service {
|
|
|
636
668
|
*/
|
|
637
669
|
describePhoneNumber(callback?: (err: AWSError, data: Connect.Types.DescribePhoneNumberResponse) => void): Request<Connect.Types.DescribePhoneNumberResponse, AWSError>;
|
|
638
670
|
/**
|
|
639
|
-
* Describes a predefined attribute for the specified Amazon Connect instance.
|
|
671
|
+
* Describes a predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.
|
|
640
672
|
*/
|
|
641
673
|
describePredefinedAttribute(params: Connect.Types.DescribePredefinedAttributeRequest, callback?: (err: AWSError, data: Connect.Types.DescribePredefinedAttributeResponse) => void): Request<Connect.Types.DescribePredefinedAttributeResponse, AWSError>;
|
|
642
674
|
/**
|
|
643
|
-
* Describes a predefined attribute for the specified Amazon Connect instance.
|
|
675
|
+
* Describes a predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.
|
|
644
676
|
*/
|
|
645
677
|
describePredefinedAttribute(callback?: (err: AWSError, data: Connect.Types.DescribePredefinedAttributeResponse) => void): Request<Connect.Types.DescribePredefinedAttributeResponse, AWSError>;
|
|
646
678
|
/**
|
|
@@ -684,11 +716,11 @@ declare class Connect extends Service {
|
|
|
684
716
|
*/
|
|
685
717
|
describeRule(callback?: (err: AWSError, data: Connect.Types.DescribeRuleResponse) => void): Request<Connect.Types.DescribeRuleResponse, AWSError>;
|
|
686
718
|
/**
|
|
687
|
-
* Gets basic information about the security
|
|
719
|
+
* Gets basic information about the security profile. For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
|
|
688
720
|
*/
|
|
689
721
|
describeSecurityProfile(params: Connect.Types.DescribeSecurityProfileRequest, callback?: (err: AWSError, data: Connect.Types.DescribeSecurityProfileResponse) => void): Request<Connect.Types.DescribeSecurityProfileResponse, AWSError>;
|
|
690
722
|
/**
|
|
691
|
-
* Gets basic information about the security
|
|
723
|
+
* Gets basic information about the security profile. For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
|
|
692
724
|
*/
|
|
693
725
|
describeSecurityProfile(callback?: (err: AWSError, data: Connect.Types.DescribeSecurityProfileResponse) => void): Request<Connect.Types.DescribeSecurityProfileResponse, AWSError>;
|
|
694
726
|
/**
|
|
@@ -851,6 +883,14 @@ declare class Connect extends Service {
|
|
|
851
883
|
* Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a MISSED, ERROR, ENDED, or REJECTED state in the Agent Event Stream.
|
|
852
884
|
*/
|
|
853
885
|
dismissUserContact(callback?: (err: AWSError, data: Connect.Types.DismissUserContactResponse) => void): Request<Connect.Types.DismissUserContactResponse, AWSError>;
|
|
886
|
+
/**
|
|
887
|
+
* Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is APPROVED.
|
|
888
|
+
*/
|
|
889
|
+
getAttachedFile(params: Connect.Types.GetAttachedFileRequest, callback?: (err: AWSError, data: Connect.Types.GetAttachedFileResponse) => void): Request<Connect.Types.GetAttachedFileResponse, AWSError>;
|
|
890
|
+
/**
|
|
891
|
+
* Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is APPROVED.
|
|
892
|
+
*/
|
|
893
|
+
getAttachedFile(callback?: (err: AWSError, data: Connect.Types.GetAttachedFileResponse) => void): Request<Connect.Types.GetAttachedFileResponse, AWSError>;
|
|
854
894
|
/**
|
|
855
895
|
* Retrieves the contact attributes for the specified contact.
|
|
856
896
|
*/
|
|
@@ -900,11 +940,11 @@ declare class Connect extends Service {
|
|
|
900
940
|
*/
|
|
901
941
|
getMetricData(callback?: (err: AWSError, data: Connect.Types.GetMetricDataResponse) => void): Request<Connect.Types.GetMetricDataResponse, AWSError>;
|
|
902
942
|
/**
|
|
903
|
-
* Gets metric data from the specified Amazon Connect instance. GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Historical metrics definitions in the Amazon Connect Administrator
|
|
943
|
+
* Gets metric data from the specified Amazon Connect instance. GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Historical metrics definitions in the Amazon Connect Administrator Guide.
|
|
904
944
|
*/
|
|
905
945
|
getMetricDataV2(params: Connect.Types.GetMetricDataV2Request, callback?: (err: AWSError, data: Connect.Types.GetMetricDataV2Response) => void): Request<Connect.Types.GetMetricDataV2Response, AWSError>;
|
|
906
946
|
/**
|
|
907
|
-
* Gets metric data from the specified Amazon Connect instance. GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Historical metrics definitions in the Amazon Connect Administrator
|
|
947
|
+
* Gets metric data from the specified Amazon Connect instance. GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Historical metrics definitions in the Amazon Connect Administrator Guide.
|
|
908
948
|
*/
|
|
909
949
|
getMetricDataV2(callback?: (err: AWSError, data: Connect.Types.GetMetricDataV2Response) => void): Request<Connect.Types.GetMetricDataV2Response, AWSError>;
|
|
910
950
|
/**
|
|
@@ -932,11 +972,11 @@ declare class Connect extends Service {
|
|
|
932
972
|
*/
|
|
933
973
|
getTrafficDistribution(callback?: (err: AWSError, data: Connect.Types.GetTrafficDistributionResponse) => void): Request<Connect.Types.GetTrafficDistributionResponse, AWSError>;
|
|
934
974
|
/**
|
|
935
|
-
* Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.
|
|
975
|
+
* Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created. Call the DescribePhoneNumber API to verify the status of a previous ImportPhoneNumber operation. If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired. For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services Support ticket.
|
|
936
976
|
*/
|
|
937
977
|
importPhoneNumber(params: Connect.Types.ImportPhoneNumberRequest, callback?: (err: AWSError, data: Connect.Types.ImportPhoneNumberResponse) => void): Request<Connect.Types.ImportPhoneNumberResponse, AWSError>;
|
|
938
978
|
/**
|
|
939
|
-
* Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.
|
|
979
|
+
* Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created. Call the DescribePhoneNumber API to verify the status of a previous ImportPhoneNumber operation. If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired. For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services Support ticket.
|
|
940
980
|
*/
|
|
941
981
|
importPhoneNumber(callback?: (err: AWSError, data: Connect.Types.ImportPhoneNumberResponse) => void): Request<Connect.Types.ImportPhoneNumberResponse, AWSError>;
|
|
942
982
|
/**
|
|
@@ -963,6 +1003,14 @@ declare class Connect extends Service {
|
|
|
963
1003
|
* This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all approved origins associated with the instance.
|
|
964
1004
|
*/
|
|
965
1005
|
listApprovedOrigins(callback?: (err: AWSError, data: Connect.Types.ListApprovedOriginsResponse) => void): Request<Connect.Types.ListApprovedOriginsResponse, AWSError>;
|
|
1006
|
+
/**
|
|
1007
|
+
* This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support. Provides summary information about the authentication profiles in a specified Amazon Connect instance.
|
|
1008
|
+
*/
|
|
1009
|
+
listAuthenticationProfiles(params: Connect.Types.ListAuthenticationProfilesRequest, callback?: (err: AWSError, data: Connect.Types.ListAuthenticationProfilesResponse) => void): Request<Connect.Types.ListAuthenticationProfilesResponse, AWSError>;
|
|
1010
|
+
/**
|
|
1011
|
+
* This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support. Provides summary information about the authentication profiles in a specified Amazon Connect instance.
|
|
1012
|
+
*/
|
|
1013
|
+
listAuthenticationProfiles(callback?: (err: AWSError, data: Connect.Types.ListAuthenticationProfilesResponse) => void): Request<Connect.Types.ListAuthenticationProfilesResponse, AWSError>;
|
|
966
1014
|
/**
|
|
967
1015
|
* This API is in preview release for Amazon Connect and is subject to change. For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to returns both Amazon Lex V1 and V2 bots.
|
|
968
1016
|
*/
|
|
@@ -1108,11 +1156,11 @@ declare class Connect extends Service {
|
|
|
1108
1156
|
*/
|
|
1109
1157
|
listPhoneNumbersV2(callback?: (err: AWSError, data: Connect.Types.ListPhoneNumbersV2Response) => void): Request<Connect.Types.ListPhoneNumbersV2Response, AWSError>;
|
|
1110
1158
|
/**
|
|
1111
|
-
* Lists predefined attributes for the specified Amazon Connect instance.
|
|
1159
|
+
* Lists predefined attributes for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.
|
|
1112
1160
|
*/
|
|
1113
1161
|
listPredefinedAttributes(params: Connect.Types.ListPredefinedAttributesRequest, callback?: (err: AWSError, data: Connect.Types.ListPredefinedAttributesResponse) => void): Request<Connect.Types.ListPredefinedAttributesResponse, AWSError>;
|
|
1114
1162
|
/**
|
|
1115
|
-
* Lists predefined attributes for the specified Amazon Connect instance.
|
|
1163
|
+
* Lists predefined attributes for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.
|
|
1116
1164
|
*/
|
|
1117
1165
|
listPredefinedAttributes(callback?: (err: AWSError, data: Connect.Types.ListPredefinedAttributesResponse) => void): Request<Connect.Types.ListPredefinedAttributesResponse, AWSError>;
|
|
1118
1166
|
/**
|
|
@@ -1196,19 +1244,19 @@ declare class Connect extends Service {
|
|
|
1196
1244
|
*/
|
|
1197
1245
|
listSecurityProfileApplications(callback?: (err: AWSError, data: Connect.Types.ListSecurityProfileApplicationsResponse) => void): Request<Connect.Types.ListSecurityProfileApplicationsResponse, AWSError>;
|
|
1198
1246
|
/**
|
|
1199
|
-
* Lists the permissions granted to a security profile.
|
|
1247
|
+
* Lists the permissions granted to a security profile. For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
|
|
1200
1248
|
*/
|
|
1201
1249
|
listSecurityProfilePermissions(params: Connect.Types.ListSecurityProfilePermissionsRequest, callback?: (err: AWSError, data: Connect.Types.ListSecurityProfilePermissionsResponse) => void): Request<Connect.Types.ListSecurityProfilePermissionsResponse, AWSError>;
|
|
1202
1250
|
/**
|
|
1203
|
-
* Lists the permissions granted to a security profile.
|
|
1251
|
+
* Lists the permissions granted to a security profile. For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
|
|
1204
1252
|
*/
|
|
1205
1253
|
listSecurityProfilePermissions(callback?: (err: AWSError, data: Connect.Types.ListSecurityProfilePermissionsResponse) => void): Request<Connect.Types.ListSecurityProfilePermissionsResponse, AWSError>;
|
|
1206
1254
|
/**
|
|
1207
|
-
* Provides summary information about the security profiles for the specified Amazon Connect instance. For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide.
|
|
1255
|
+
* Provides summary information about the security profiles for the specified Amazon Connect instance. For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
|
|
1208
1256
|
*/
|
|
1209
1257
|
listSecurityProfiles(params: Connect.Types.ListSecurityProfilesRequest, callback?: (err: AWSError, data: Connect.Types.ListSecurityProfilesResponse) => void): Request<Connect.Types.ListSecurityProfilesResponse, AWSError>;
|
|
1210
1258
|
/**
|
|
1211
|
-
* Provides summary information about the security profiles for the specified Amazon Connect instance. For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide.
|
|
1259
|
+
* Provides summary information about the security profiles for the specified Amazon Connect instance. For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
|
|
1212
1260
|
*/
|
|
1213
1261
|
listSecurityProfiles(callback?: (err: AWSError, data: Connect.Types.ListSecurityProfilesResponse) => void): Request<Connect.Types.ListSecurityProfilesResponse, AWSError>;
|
|
1214
1262
|
/**
|
|
@@ -1316,11 +1364,11 @@ declare class Connect extends Service {
|
|
|
1316
1364
|
*/
|
|
1317
1365
|
putUserStatus(callback?: (err: AWSError, data: Connect.Types.PutUserStatusResponse) => void): Request<Connect.Types.PutUserStatusResponse, AWSError>;
|
|
1318
1366
|
/**
|
|
1319
|
-
* Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed. To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Amazon Connect admin website. After releasing a phone number, the phone number enters into a cooldown period
|
|
1367
|
+
* Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed. To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Amazon Connect admin website. After releasing a phone number, the phone number enters into a cooldown period for up to 180 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support. If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired. For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
|
|
1320
1368
|
*/
|
|
1321
1369
|
releasePhoneNumber(params: Connect.Types.ReleasePhoneNumberRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1322
1370
|
/**
|
|
1323
|
-
* Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed. To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Amazon Connect admin website. After releasing a phone number, the phone number enters into a cooldown period
|
|
1371
|
+
* Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed. To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Amazon Connect admin website. After releasing a phone number, the phone number enters into a cooldown period for up to 180 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support. If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired. For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
|
|
1324
1372
|
*/
|
|
1325
1373
|
releasePhoneNumber(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1326
1374
|
/**
|
|
@@ -1347,6 +1395,14 @@ declare class Connect extends Service {
|
|
|
1347
1395
|
* When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume. Voice and screen recordings are supported.
|
|
1348
1396
|
*/
|
|
1349
1397
|
resumeContactRecording(callback?: (err: AWSError, data: Connect.Types.ResumeContactRecordingResponse) => void): Request<Connect.Types.ResumeContactRecordingResponse, AWSError>;
|
|
1398
|
+
/**
|
|
1399
|
+
* Searches AgentStatuses in an Amazon Connect instance, with optional filtering.
|
|
1400
|
+
*/
|
|
1401
|
+
searchAgentStatuses(params: Connect.Types.SearchAgentStatusesRequest, callback?: (err: AWSError, data: Connect.Types.SearchAgentStatusesResponse) => void): Request<Connect.Types.SearchAgentStatusesResponse, AWSError>;
|
|
1402
|
+
/**
|
|
1403
|
+
* Searches AgentStatuses in an Amazon Connect instance, with optional filtering.
|
|
1404
|
+
*/
|
|
1405
|
+
searchAgentStatuses(callback?: (err: AWSError, data: Connect.Types.SearchAgentStatusesResponse) => void): Request<Connect.Types.SearchAgentStatusesResponse, AWSError>;
|
|
1350
1406
|
/**
|
|
1351
1407
|
* Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with the traffic distribution group.
|
|
1352
1408
|
*/
|
|
@@ -1355,6 +1411,22 @@ declare class Connect extends Service {
|
|
|
1355
1411
|
* Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with the traffic distribution group.
|
|
1356
1412
|
*/
|
|
1357
1413
|
searchAvailablePhoneNumbers(callback?: (err: AWSError, data: Connect.Types.SearchAvailablePhoneNumbersResponse) => void): Request<Connect.Types.SearchAvailablePhoneNumbersResponse, AWSError>;
|
|
1414
|
+
/**
|
|
1415
|
+
* Searches the flow modules in an Amazon Connect instance, with optional filtering.
|
|
1416
|
+
*/
|
|
1417
|
+
searchContactFlowModules(params: Connect.Types.SearchContactFlowModulesRequest, callback?: (err: AWSError, data: Connect.Types.SearchContactFlowModulesResponse) => void): Request<Connect.Types.SearchContactFlowModulesResponse, AWSError>;
|
|
1418
|
+
/**
|
|
1419
|
+
* Searches the flow modules in an Amazon Connect instance, with optional filtering.
|
|
1420
|
+
*/
|
|
1421
|
+
searchContactFlowModules(callback?: (err: AWSError, data: Connect.Types.SearchContactFlowModulesResponse) => void): Request<Connect.Types.SearchContactFlowModulesResponse, AWSError>;
|
|
1422
|
+
/**
|
|
1423
|
+
* Searches the contact flows in an Amazon Connect instance, with optional filtering.
|
|
1424
|
+
*/
|
|
1425
|
+
searchContactFlows(params: Connect.Types.SearchContactFlowsRequest, callback?: (err: AWSError, data: Connect.Types.SearchContactFlowsResponse) => void): Request<Connect.Types.SearchContactFlowsResponse, AWSError>;
|
|
1426
|
+
/**
|
|
1427
|
+
* Searches the contact flows in an Amazon Connect instance, with optional filtering.
|
|
1428
|
+
*/
|
|
1429
|
+
searchContactFlows(callback?: (err: AWSError, data: Connect.Types.SearchContactFlowsResponse) => void): Request<Connect.Types.SearchContactFlowsResponse, AWSError>;
|
|
1358
1430
|
/**
|
|
1359
1431
|
* Searches contacts in an Amazon Connect instance.
|
|
1360
1432
|
*/
|
|
@@ -1372,11 +1444,11 @@ declare class Connect extends Service {
|
|
|
1372
1444
|
*/
|
|
1373
1445
|
searchHoursOfOperations(callback?: (err: AWSError, data: Connect.Types.SearchHoursOfOperationsResponse) => void): Request<Connect.Types.SearchHoursOfOperationsResponse, AWSError>;
|
|
1374
1446
|
/**
|
|
1375
|
-
*
|
|
1447
|
+
* Searches predefined attributes that meet certain criteria. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.
|
|
1376
1448
|
*/
|
|
1377
1449
|
searchPredefinedAttributes(params: Connect.Types.SearchPredefinedAttributesRequest, callback?: (err: AWSError, data: Connect.Types.SearchPredefinedAttributesResponse) => void): Request<Connect.Types.SearchPredefinedAttributesResponse, AWSError>;
|
|
1378
1450
|
/**
|
|
1379
|
-
*
|
|
1451
|
+
* Searches predefined attributes that meet certain criteria. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.
|
|
1380
1452
|
*/
|
|
1381
1453
|
searchPredefinedAttributes(callback?: (err: AWSError, data: Connect.Types.SearchPredefinedAttributesResponse) => void): Request<Connect.Types.SearchPredefinedAttributesResponse, AWSError>;
|
|
1382
1454
|
/**
|
|
@@ -1420,13 +1492,21 @@ declare class Connect extends Service {
|
|
|
1420
1492
|
*/
|
|
1421
1493
|
searchRoutingProfiles(callback?: (err: AWSError, data: Connect.Types.SearchRoutingProfilesResponse) => void): Request<Connect.Types.SearchRoutingProfilesResponse, AWSError>;
|
|
1422
1494
|
/**
|
|
1423
|
-
* Searches security profiles in an Amazon Connect instance, with optional filtering.
|
|
1495
|
+
* Searches security profiles in an Amazon Connect instance, with optional filtering. For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
|
|
1424
1496
|
*/
|
|
1425
1497
|
searchSecurityProfiles(params: Connect.Types.SearchSecurityProfilesRequest, callback?: (err: AWSError, data: Connect.Types.SearchSecurityProfilesResponse) => void): Request<Connect.Types.SearchSecurityProfilesResponse, AWSError>;
|
|
1426
1498
|
/**
|
|
1427
|
-
* Searches security profiles in an Amazon Connect instance, with optional filtering.
|
|
1499
|
+
* Searches security profiles in an Amazon Connect instance, with optional filtering. For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
|
|
1428
1500
|
*/
|
|
1429
1501
|
searchSecurityProfiles(callback?: (err: AWSError, data: Connect.Types.SearchSecurityProfilesResponse) => void): Request<Connect.Types.SearchSecurityProfilesResponse, AWSError>;
|
|
1502
|
+
/**
|
|
1503
|
+
* Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering. The UserHierarchyGroup with "LevelId": "0" is the foundation for building levels on top of an instance. It is not user-definable, nor is it visible in the UI.
|
|
1504
|
+
*/
|
|
1505
|
+
searchUserHierarchyGroups(params: Connect.Types.SearchUserHierarchyGroupsRequest, callback?: (err: AWSError, data: Connect.Types.SearchUserHierarchyGroupsResponse) => void): Request<Connect.Types.SearchUserHierarchyGroupsResponse, AWSError>;
|
|
1506
|
+
/**
|
|
1507
|
+
* Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering. The UserHierarchyGroup with "LevelId": "0" is the foundation for building levels on top of an instance. It is not user-definable, nor is it visible in the UI.
|
|
1508
|
+
*/
|
|
1509
|
+
searchUserHierarchyGroups(callback?: (err: AWSError, data: Connect.Types.SearchUserHierarchyGroupsResponse) => void): Request<Connect.Types.SearchUserHierarchyGroupsResponse, AWSError>;
|
|
1430
1510
|
/**
|
|
1431
1511
|
* Searches users in an Amazon Connect instance, with optional filtering. AfterContactWorkTimeLimit is returned in milliseconds.
|
|
1432
1512
|
*/
|
|
@@ -1452,11 +1532,19 @@ declare class Connect extends Service {
|
|
|
1452
1532
|
*/
|
|
1453
1533
|
sendChatIntegrationEvent(callback?: (err: AWSError, data: Connect.Types.SendChatIntegrationEventResponse) => void): Request<Connect.Types.SendChatIntegrationEventResponse, AWSError>;
|
|
1454
1534
|
/**
|
|
1455
|
-
*
|
|
1535
|
+
* Provides a pre-signed Amazon S3 URL in response for uploading your content. You may only use this API to upload attachments to an Amazon Connect Case.
|
|
1536
|
+
*/
|
|
1537
|
+
startAttachedFileUpload(params: Connect.Types.StartAttachedFileUploadRequest, callback?: (err: AWSError, data: Connect.Types.StartAttachedFileUploadResponse) => void): Request<Connect.Types.StartAttachedFileUploadResponse, AWSError>;
|
|
1538
|
+
/**
|
|
1539
|
+
* Provides a pre-signed Amazon S3 URL in response for uploading your content. You may only use this API to upload attachments to an Amazon Connect Case.
|
|
1540
|
+
*/
|
|
1541
|
+
startAttachedFileUpload(callback?: (err: AWSError, data: Connect.Types.StartAttachedFileUploadResponse) => void): Request<Connect.Types.StartAttachedFileUploadResponse, AWSError>;
|
|
1542
|
+
/**
|
|
1543
|
+
* Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service. When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS. A 429 error occurs in the following situations: API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception. The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException. If you use the ChatDurationInMinutes parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support. For more information about chat, see the following topics in the Amazon Connect Administrator Guide: Concepts: Web and mobile messaging capabilities in Amazon Connect Amazon Connect Chat security best practices
|
|
1456
1544
|
*/
|
|
1457
1545
|
startChatContact(params: Connect.Types.StartChatContactRequest, callback?: (err: AWSError, data: Connect.Types.StartChatContactResponse) => void): Request<Connect.Types.StartChatContactResponse, AWSError>;
|
|
1458
1546
|
/**
|
|
1459
|
-
* Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service. When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS. A 429 error occurs in the following situations: API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception. The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException. If you use the ChatDurationInMinutes parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support. For more information about chat, see
|
|
1547
|
+
* Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service. When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS. A 429 error occurs in the following situations: API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception. The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException. If you use the ChatDurationInMinutes parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support. For more information about chat, see the following topics in the Amazon Connect Administrator Guide: Concepts: Web and mobile messaging capabilities in Amazon Connect Amazon Connect Chat security best practices
|
|
1460
1548
|
*/
|
|
1461
1549
|
startChatContact(callback?: (err: AWSError, data: Connect.Types.StartChatContactResponse) => void): Request<Connect.Types.StartChatContactResponse, AWSError>;
|
|
1462
1550
|
/**
|
|
@@ -1476,11 +1564,11 @@ declare class Connect extends Service {
|
|
|
1476
1564
|
*/
|
|
1477
1565
|
startContactRecording(callback?: (err: AWSError, data: Connect.Types.StartContactRecordingResponse) => void): Request<Connect.Types.StartContactRecordingResponse, AWSError>;
|
|
1478
1566
|
/**
|
|
1479
|
-
* Initiates real-time message streaming for a new chat contact. For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.
|
|
1567
|
+
* Initiates real-time message streaming for a new chat contact. For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide. For more information about chat, see the following topics in the Amazon Connect Administrator Guide: Concepts: Web and mobile messaging capabilities in Amazon Connect Amazon Connect Chat security best practices
|
|
1480
1568
|
*/
|
|
1481
1569
|
startContactStreaming(params: Connect.Types.StartContactStreamingRequest, callback?: (err: AWSError, data: Connect.Types.StartContactStreamingResponse) => void): Request<Connect.Types.StartContactStreamingResponse, AWSError>;
|
|
1482
1570
|
/**
|
|
1483
|
-
* Initiates real-time message streaming for a new chat contact. For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.
|
|
1571
|
+
* Initiates real-time message streaming for a new chat contact. For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide. For more information about chat, see the following topics in the Amazon Connect Administrator Guide: Concepts: Web and mobile messaging capabilities in Amazon Connect Amazon Connect Chat security best practices
|
|
1484
1572
|
*/
|
|
1485
1573
|
startContactStreaming(callback?: (err: AWSError, data: Connect.Types.StartContactStreamingResponse) => void): Request<Connect.Types.StartContactStreamingResponse, AWSError>;
|
|
1486
1574
|
/**
|
|
@@ -1508,11 +1596,11 @@ declare class Connect extends Service {
|
|
|
1508
1596
|
*/
|
|
1509
1597
|
startWebRTCContact(callback?: (err: AWSError, data: Connect.Types.StartWebRTCContactResponse) => void): Request<Connect.Types.StartWebRTCContactResponse, AWSError>;
|
|
1510
1598
|
/**
|
|
1511
|
-
* Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods: DISCONNECT TRANSFER QUEUE_TRANSFER Chat and task contacts can be terminated in any state, regardless of initiation method.
|
|
1599
|
+
* Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods: DISCONNECT TRANSFER QUEUE_TRANSFER EXTERNAL_OUTBOUND MONITOR Chat and task contacts can be terminated in any state, regardless of initiation method.
|
|
1512
1600
|
*/
|
|
1513
1601
|
stopContact(params: Connect.Types.StopContactRequest, callback?: (err: AWSError, data: Connect.Types.StopContactResponse) => void): Request<Connect.Types.StopContactResponse, AWSError>;
|
|
1514
1602
|
/**
|
|
1515
|
-
* Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods: DISCONNECT TRANSFER QUEUE_TRANSFER Chat and task contacts can be terminated in any state, regardless of initiation method.
|
|
1603
|
+
* Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods: DISCONNECT TRANSFER QUEUE_TRANSFER EXTERNAL_OUTBOUND MONITOR Chat and task contacts can be terminated in any state, regardless of initiation method.
|
|
1516
1604
|
*/
|
|
1517
1605
|
stopContact(callback?: (err: AWSError, data: Connect.Types.StopContactResponse) => void): Request<Connect.Types.StopContactResponse, AWSError>;
|
|
1518
1606
|
/**
|
|
@@ -1595,6 +1683,14 @@ declare class Connect extends Service {
|
|
|
1595
1683
|
* This API is in preview release for Amazon Connect and is subject to change. Updates agent status.
|
|
1596
1684
|
*/
|
|
1597
1685
|
updateAgentStatus(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1686
|
+
/**
|
|
1687
|
+
* This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support. Updates the selected authentication profile.
|
|
1688
|
+
*/
|
|
1689
|
+
updateAuthenticationProfile(params: Connect.Types.UpdateAuthenticationProfileRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1690
|
+
/**
|
|
1691
|
+
* This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support. Updates the selected authentication profile.
|
|
1692
|
+
*/
|
|
1693
|
+
updateAuthenticationProfile(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1598
1694
|
/**
|
|
1599
1695
|
* This API is in preview release for Amazon Connect and is subject to change. Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request. You can add or update user-defined contact information for both ongoing and completed contacts.
|
|
1600
1696
|
*/
|
|
@@ -1620,11 +1716,11 @@ declare class Connect extends Service {
|
|
|
1620
1716
|
*/
|
|
1621
1717
|
updateContactEvaluation(callback?: (err: AWSError, data: Connect.Types.UpdateContactEvaluationResponse) => void): Request<Connect.Types.UpdateContactEvaluationResponse, AWSError>;
|
|
1622
1718
|
/**
|
|
1623
|
-
* Updates the specified flow. You can also create and update flows using the Amazon Connect Flow language.
|
|
1719
|
+
* Updates the specified flow. You can also create and update flows using the Amazon Connect Flow language. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.
|
|
1624
1720
|
*/
|
|
1625
1721
|
updateContactFlowContent(params: Connect.Types.UpdateContactFlowContentRequest, callback?: (err: AWSError, data: Connect.Types.UpdateContactFlowContentResponse) => void): Request<Connect.Types.UpdateContactFlowContentResponse, AWSError>;
|
|
1626
1722
|
/**
|
|
1627
|
-
* Updates the specified flow. You can also create and update flows using the Amazon Connect Flow language.
|
|
1723
|
+
* Updates the specified flow. You can also create and update flows using the Amazon Connect Flow language. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.
|
|
1628
1724
|
*/
|
|
1629
1725
|
updateContactFlowContent(callback?: (err: AWSError, data: Connect.Types.UpdateContactFlowContentResponse) => void): Request<Connect.Types.UpdateContactFlowContentResponse, AWSError>;
|
|
1630
1726
|
/**
|
|
@@ -1636,11 +1732,11 @@ declare class Connect extends Service {
|
|
|
1636
1732
|
*/
|
|
1637
1733
|
updateContactFlowMetadata(callback?: (err: AWSError, data: Connect.Types.UpdateContactFlowMetadataResponse) => void): Request<Connect.Types.UpdateContactFlowMetadataResponse, AWSError>;
|
|
1638
1734
|
/**
|
|
1639
|
-
* Updates specified flow module for the specified Amazon Connect instance.
|
|
1735
|
+
* Updates specified flow module for the specified Amazon Connect instance. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.
|
|
1640
1736
|
*/
|
|
1641
1737
|
updateContactFlowModuleContent(params: Connect.Types.UpdateContactFlowModuleContentRequest, callback?: (err: AWSError, data: Connect.Types.UpdateContactFlowModuleContentResponse) => void): Request<Connect.Types.UpdateContactFlowModuleContentResponse, AWSError>;
|
|
1642
1738
|
/**
|
|
1643
|
-
* Updates specified flow module for the specified Amazon Connect instance.
|
|
1739
|
+
* Updates specified flow module for the specified Amazon Connect instance. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.
|
|
1644
1740
|
*/
|
|
1645
1741
|
updateContactFlowModuleContent(callback?: (err: AWSError, data: Connect.Types.UpdateContactFlowModuleContentResponse) => void): Request<Connect.Types.UpdateContactFlowModuleContentResponse, AWSError>;
|
|
1646
1742
|
/**
|
|
@@ -1660,11 +1756,11 @@ declare class Connect extends Service {
|
|
|
1660
1756
|
*/
|
|
1661
1757
|
updateContactFlowName(callback?: (err: AWSError, data: Connect.Types.UpdateContactFlowNameResponse) => void): Request<Connect.Types.UpdateContactFlowNameResponse, AWSError>;
|
|
1662
1758
|
/**
|
|
1663
|
-
*
|
|
1759
|
+
* Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block. Either QueuePriority or QueueTimeAdjustmentInSeconds should be provided within the request body, but not both.
|
|
1664
1760
|
*/
|
|
1665
1761
|
updateContactRoutingData(params: Connect.Types.UpdateContactRoutingDataRequest, callback?: (err: AWSError, data: Connect.Types.UpdateContactRoutingDataResponse) => void): Request<Connect.Types.UpdateContactRoutingDataResponse, AWSError>;
|
|
1666
1762
|
/**
|
|
1667
|
-
*
|
|
1763
|
+
* Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block. Either QueuePriority or QueueTimeAdjustmentInSeconds should be provided within the request body, but not both.
|
|
1668
1764
|
*/
|
|
1669
1765
|
updateContactRoutingData(callback?: (err: AWSError, data: Connect.Types.UpdateContactRoutingDataResponse) => void): Request<Connect.Types.UpdateContactRoutingDataResponse, AWSError>;
|
|
1670
1766
|
/**
|
|
@@ -1732,11 +1828,11 @@ declare class Connect extends Service {
|
|
|
1732
1828
|
*/
|
|
1733
1829
|
updatePhoneNumberMetadata(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1734
1830
|
/**
|
|
1735
|
-
* Updates a predefined attribute for the specified Amazon Connect instance.
|
|
1831
|
+
* Updates a predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.
|
|
1736
1832
|
*/
|
|
1737
1833
|
updatePredefinedAttribute(params: Connect.Types.UpdatePredefinedAttributeRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1738
1834
|
/**
|
|
1739
|
-
* Updates a predefined attribute for the specified Amazon Connect instance.
|
|
1835
|
+
* Updates a predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.
|
|
1740
1836
|
*/
|
|
1741
1837
|
updatePredefinedAttribute(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1742
1838
|
/**
|
|
@@ -1852,11 +1948,11 @@ declare class Connect extends Service {
|
|
|
1852
1948
|
*/
|
|
1853
1949
|
updateRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1854
1950
|
/**
|
|
1855
|
-
* Updates a security profile.
|
|
1951
|
+
* Updates a security profile. For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
|
|
1856
1952
|
*/
|
|
1857
1953
|
updateSecurityProfile(params: Connect.Types.UpdateSecurityProfileRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1858
1954
|
/**
|
|
1859
|
-
* Updates a security profile.
|
|
1955
|
+
* Updates a security profile. For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
|
|
1860
1956
|
*/
|
|
1861
1957
|
updateSecurityProfile(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1862
1958
|
/**
|
|
@@ -1959,6 +2055,7 @@ declare class Connect extends Service {
|
|
|
1959
2055
|
declare namespace Connect {
|
|
1960
2056
|
export type ARN = string;
|
|
1961
2057
|
export type AWSAccountId = string;
|
|
2058
|
+
export type AccessTokenDuration = number;
|
|
1962
2059
|
export type ActionSummaries = ActionSummary[];
|
|
1963
2060
|
export interface ActionSummary {
|
|
1964
2061
|
/**
|
|
@@ -2032,6 +2129,12 @@ declare namespace Connect {
|
|
|
2032
2129
|
}
|
|
2033
2130
|
export type AgentContactReferenceList = AgentContactReference[];
|
|
2034
2131
|
export type AgentFirstName = string;
|
|
2132
|
+
export interface AgentHierarchyGroup {
|
|
2133
|
+
/**
|
|
2134
|
+
* The Amazon Resource Name (ARN) of the group.
|
|
2135
|
+
*/
|
|
2136
|
+
Arn?: ARN;
|
|
2137
|
+
}
|
|
2035
2138
|
export interface AgentHierarchyGroups {
|
|
2036
2139
|
/**
|
|
2037
2140
|
* The identifiers for level 1 hierarchy groups.
|
|
@@ -2054,6 +2157,8 @@ declare namespace Connect {
|
|
|
2054
2157
|
*/
|
|
2055
2158
|
L5Ids?: HierarchyGroupIdList;
|
|
2056
2159
|
}
|
|
2160
|
+
export type AgentId = string;
|
|
2161
|
+
export type AgentIds = AgentId[];
|
|
2057
2162
|
export interface AgentInfo {
|
|
2058
2163
|
/**
|
|
2059
2164
|
* The identifier of the agent who accepted the contact.
|
|
@@ -2067,9 +2172,24 @@ declare namespace Connect {
|
|
|
2067
2172
|
* Agent pause duration for a contact in seconds.
|
|
2068
2173
|
*/
|
|
2069
2174
|
AgentPauseDurationInSeconds?: AgentPauseDurationInSeconds;
|
|
2175
|
+
/**
|
|
2176
|
+
* The agent hierarchy groups for the agent.
|
|
2177
|
+
*/
|
|
2178
|
+
HierarchyGroups?: HierarchyGroups;
|
|
2179
|
+
/**
|
|
2180
|
+
* Information regarding Agent’s device.
|
|
2181
|
+
*/
|
|
2182
|
+
DeviceInfo?: DeviceInfo;
|
|
2183
|
+
Capabilities?: ParticipantCapabilities;
|
|
2070
2184
|
}
|
|
2071
2185
|
export type AgentLastName = string;
|
|
2072
2186
|
export type AgentPauseDurationInSeconds = number;
|
|
2187
|
+
export interface AgentQualityMetrics {
|
|
2188
|
+
/**
|
|
2189
|
+
* Information about the audio quality of the Agent
|
|
2190
|
+
*/
|
|
2191
|
+
Audio?: AudioQualityMetricsInfo;
|
|
2192
|
+
}
|
|
2073
2193
|
export type AgentResourceId = string;
|
|
2074
2194
|
export type AgentResourceIdList = AgentResourceId[];
|
|
2075
2195
|
export interface AgentStatus {
|
|
@@ -2116,6 +2236,7 @@ declare namespace Connect {
|
|
|
2116
2236
|
}
|
|
2117
2237
|
export type AgentStatusDescription = string;
|
|
2118
2238
|
export type AgentStatusId = string;
|
|
2239
|
+
export type AgentStatusList = AgentStatus[];
|
|
2119
2240
|
export type AgentStatusName = string;
|
|
2120
2241
|
export type AgentStatusOrderNumber = number;
|
|
2121
2242
|
export interface AgentStatusReference {
|
|
@@ -2132,6 +2253,27 @@ declare namespace Connect {
|
|
|
2132
2253
|
*/
|
|
2133
2254
|
StatusName?: AgentStatusName;
|
|
2134
2255
|
}
|
|
2256
|
+
export type AgentStatusSearchConditionList = AgentStatusSearchCriteria[];
|
|
2257
|
+
export interface AgentStatusSearchCriteria {
|
|
2258
|
+
/**
|
|
2259
|
+
* A list of conditions which would be applied together with an OR condition.
|
|
2260
|
+
*/
|
|
2261
|
+
OrConditions?: AgentStatusSearchConditionList;
|
|
2262
|
+
/**
|
|
2263
|
+
* A leaf node condition which can be used to specify a string condition. The currently supported values for FieldName are name,

 description, state, type, displayOrder,
 and resourceID.
|
|
2264
|
+
*/
|
|
2265
|
+
AndConditions?: AgentStatusSearchConditionList;
|
|
2266
|
+
/**
|
|
2267
|
+
* A leaf node condition which can be used to specify a string condition. The currently supported values for FieldName are name,

 description, state, type, displayOrder,
 and resourceID.
|
|
2268
|
+
*/
|
|
2269
|
+
StringCondition?: StringCondition;
|
|
2270
|
+
}
|
|
2271
|
+
export interface AgentStatusSearchFilter {
|
|
2272
|
+
/**
|
|
2273
|
+
* An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR of AND (List of List) input where: The top level list specifies conditions that need to be applied with OR operator. The inner list specifies conditions that need to be applied with AND operator.
|
|
2274
|
+
*/
|
|
2275
|
+
AttributeFilter?: ControlPlaneAttributeFilter;
|
|
2276
|
+
}
|
|
2135
2277
|
export type AgentStatusState = "ENABLED"|"DISABLED"|string;
|
|
2136
2278
|
export interface AgentStatusSummary {
|
|
2137
2279
|
/**
|
|
@@ -2163,6 +2305,12 @@ declare namespace Connect {
|
|
|
2163
2305
|
export type AgentStatusType = "ROUTABLE"|"CUSTOM"|"OFFLINE"|string;
|
|
2164
2306
|
export type AgentStatusTypes = AgentStatusType[];
|
|
2165
2307
|
export type AgentUsername = string;
|
|
2308
|
+
export interface AgentsCriteria {
|
|
2309
|
+
/**
|
|
2310
|
+
* An object to specify a list of agents, by user ID.
|
|
2311
|
+
*/
|
|
2312
|
+
AgentIds?: AgentIds;
|
|
2313
|
+
}
|
|
2166
2314
|
export type AgentsMinOneMaxHundred = UserId[];
|
|
2167
2315
|
export type AliasArn = string;
|
|
2168
2316
|
export type AllowedAccessControlTags = {[key: string]: SecurityProfilePolicyValue};
|
|
@@ -2206,6 +2354,7 @@ declare namespace Connect {
|
|
|
2206
2354
|
*/
|
|
2207
2355
|
AwaitAnswerMachinePrompt?: Boolean;
|
|
2208
2356
|
}
|
|
2357
|
+
export type AnsweringMachineDetectionStatus = "ANSWERED"|"UNDETECTED"|"ERROR"|"HUMAN_ANSWERED"|"SIT_TONE_DETECTED"|"SIT_TONE_BUSY"|"SIT_TONE_INVALID_NUMBER"|"FAX_MACHINE_DETECTED"|"VOICEMAIL_BEEP"|"VOICEMAIL_NO_BEEP"|"AMD_UNRESOLVED"|"AMD_UNANSWERED"|"AMD_ERROR"|"AMD_NOT_APPLICABLE"|string;
|
|
2209
2358
|
export interface Application {
|
|
2210
2359
|
/**
|
|
2211
2360
|
* Namespace of the application that you want to give access to.
|
|
@@ -2440,7 +2589,66 @@ declare namespace Connect {
|
|
|
2440
2589
|
*/
|
|
2441
2590
|
UserProficiencies: UserProficiencyList;
|
|
2442
2591
|
}
|
|
2592
|
+
export type AssociatedQueueIdList = QueueId[];
|
|
2443
2593
|
export type AssociationId = string;
|
|
2594
|
+
export interface AttachedFile {
|
|
2595
|
+
/**
|
|
2596
|
+
* The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.
|
|
2597
|
+
*/
|
|
2598
|
+
CreationTime: ISO8601Datetime;
|
|
2599
|
+
/**
|
|
2600
|
+
* The unique identifier of the attached file resource (ARN).
|
|
2601
|
+
*/
|
|
2602
|
+
FileArn: ARN;
|
|
2603
|
+
/**
|
|
2604
|
+
* The unique identifier of the attached file resource.
|
|
2605
|
+
*/
|
|
2606
|
+
FileId: FileId;
|
|
2607
|
+
/**
|
|
2608
|
+
* A case-sensitive name of the attached file being uploaded.
|
|
2609
|
+
*/
|
|
2610
|
+
FileName: FileName;
|
|
2611
|
+
/**
|
|
2612
|
+
* The size of the attached file in bytes.
|
|
2613
|
+
*/
|
|
2614
|
+
FileSizeInBytes: FileSizeInBytes;
|
|
2615
|
+
/**
|
|
2616
|
+
* The current status of the attached file.
|
|
2617
|
+
*/
|
|
2618
|
+
FileStatus: FileStatusType;
|
|
2619
|
+
/**
|
|
2620
|
+
* Represents the identity that created the file.
|
|
2621
|
+
*/
|
|
2622
|
+
CreatedBy?: CreatedByInfo;
|
|
2623
|
+
/**
|
|
2624
|
+
* The use case for the file.
|
|
2625
|
+
*/
|
|
2626
|
+
FileUseCaseType?: FileUseCaseType;
|
|
2627
|
+
/**
|
|
2628
|
+
* The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource. This value must be a valid ARN.
|
|
2629
|
+
*/
|
|
2630
|
+
AssociatedResourceArn?: ARN;
|
|
2631
|
+
/**
|
|
2632
|
+
* The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
|
|
2633
|
+
*/
|
|
2634
|
+
Tags?: TagMap;
|
|
2635
|
+
}
|
|
2636
|
+
export interface AttachedFileError {
|
|
2637
|
+
/**
|
|
2638
|
+
* Status code describing the failure.
|
|
2639
|
+
*/
|
|
2640
|
+
ErrorCode?: ErrorCode;
|
|
2641
|
+
/**
|
|
2642
|
+
* Why the attached file couldn't be retrieved.
|
|
2643
|
+
*/
|
|
2644
|
+
ErrorMessage?: ErrorMessage;
|
|
2645
|
+
/**
|
|
2646
|
+
* The unique identifier of the attached file resource.
|
|
2647
|
+
*/
|
|
2648
|
+
FileId?: FileId;
|
|
2649
|
+
}
|
|
2650
|
+
export type AttachedFileErrorsList = AttachedFileError[];
|
|
2651
|
+
export type AttachedFilesList = AttachedFile[];
|
|
2444
2652
|
export type AttachmentName = string;
|
|
2445
2653
|
export interface AttachmentReference {
|
|
2446
2654
|
/**
|
|
@@ -2484,6 +2692,28 @@ declare namespace Connect {
|
|
|
2484
2692
|
TagConditions?: TagAndConditionList;
|
|
2485
2693
|
HierarchyGroupCondition?: HierarchyGroupCondition;
|
|
2486
2694
|
}
|
|
2695
|
+
export interface AttributeCondition {
|
|
2696
|
+
/**
|
|
2697
|
+
* The name of predefined attribute.
|
|
2698
|
+
*/
|
|
2699
|
+
Name?: PredefinedAttributeName;
|
|
2700
|
+
/**
|
|
2701
|
+
* The value of predefined attribute.
|
|
2702
|
+
*/
|
|
2703
|
+
Value?: ProficiencyValue;
|
|
2704
|
+
/**
|
|
2705
|
+
* The proficiency level of the condition.
|
|
2706
|
+
*/
|
|
2707
|
+
ProficiencyLevel?: NullableProficiencyLevel;
|
|
2708
|
+
/**
|
|
2709
|
+
* An object to define AgentsCriteria.
|
|
2710
|
+
*/
|
|
2711
|
+
MatchCriteria?: MatchCriteria;
|
|
2712
|
+
/**
|
|
2713
|
+
* The operator of the condition.
|
|
2714
|
+
*/
|
|
2715
|
+
ComparisonOperator?: ComparisonOperator;
|
|
2716
|
+
}
|
|
2487
2717
|
export type AttributeName = string;
|
|
2488
2718
|
export type AttributeOrConditionList = AttributeAndCondition[];
|
|
2489
2719
|
export type AttributeValue = string;
|
|
@@ -2495,6 +2725,97 @@ declare namespace Connect {
|
|
|
2495
2725
|
*/
|
|
2496
2726
|
EchoReduction?: MeetingFeatureStatus;
|
|
2497
2727
|
}
|
|
2728
|
+
export interface AudioQualityMetricsInfo {
|
|
2729
|
+
/**
|
|
2730
|
+
* Number measuring the estimated quality of the media connection.
|
|
2731
|
+
*/
|
|
2732
|
+
QualityScore?: AudioQualityScore;
|
|
2733
|
+
/**
|
|
2734
|
+
* List of potential issues causing degradation of quality on a media connection. If the service did not detect any potential quality issues the list is empty. Valid values: HighPacketLoss | HighRoundTripTime | HighJitterBuffer
|
|
2735
|
+
*/
|
|
2736
|
+
PotentialQualityIssues?: PotentialAudioQualityIssues;
|
|
2737
|
+
}
|
|
2738
|
+
export type AudioQualityScore = number;
|
|
2739
|
+
export interface AuthenticationProfile {
|
|
2740
|
+
/**
|
|
2741
|
+
* A unique identifier for the authentication profile.
|
|
2742
|
+
*/
|
|
2743
|
+
Id?: AuthenticationProfileId;
|
|
2744
|
+
/**
|
|
2745
|
+
* The Amazon Resource Name (ARN) for the authentication profile.
|
|
2746
|
+
*/
|
|
2747
|
+
Arn?: ARN;
|
|
2748
|
+
/**
|
|
2749
|
+
* The name for the authentication profile.
|
|
2750
|
+
*/
|
|
2751
|
+
Name?: AuthenticationProfileName;
|
|
2752
|
+
/**
|
|
2753
|
+
* The description for the authentication profile.
|
|
2754
|
+
*/
|
|
2755
|
+
Description?: AuthenticationProfileDescription;
|
|
2756
|
+
/**
|
|
2757
|
+
* A list of IP address range strings that are allowed to access the Amazon Connect instance. For more information about how to configure IP addresses, see Configure IP address based access control in the Amazon Connect Administrator Guide.
|
|
2758
|
+
*/
|
|
2759
|
+
AllowedIps?: IpCidrList;
|
|
2760
|
+
/**
|
|
2761
|
+
* A list of IP address range strings that are blocked from accessing the Amazon Connect instance. For more information about how to configure IP addresses, see Configure IP address based access control in the Amazon Connect Administrator Guide.
|
|
2762
|
+
*/
|
|
2763
|
+
BlockedIps?: IpCidrList;
|
|
2764
|
+
/**
|
|
2765
|
+
* Shows whether the authentication profile is the default authentication profile for the Amazon Connect instance. The default authentication profile applies to all agents in an Amazon Connect instance, unless overridden by another authentication profile.
|
|
2766
|
+
*/
|
|
2767
|
+
IsDefault?: Boolean;
|
|
2768
|
+
/**
|
|
2769
|
+
* The timestamp when the authentication profile was created.
|
|
2770
|
+
*/
|
|
2771
|
+
CreatedTime?: Timestamp;
|
|
2772
|
+
/**
|
|
2773
|
+
* The timestamp when the authentication profile was last modified.
|
|
2774
|
+
*/
|
|
2775
|
+
LastModifiedTime?: Timestamp;
|
|
2776
|
+
/**
|
|
2777
|
+
* The Amazon Web Services Region where the authentication profile was last modified.
|
|
2778
|
+
*/
|
|
2779
|
+
LastModifiedRegion?: RegionName;
|
|
2780
|
+
/**
|
|
2781
|
+
* The short lived session duration configuration for users logged in to Amazon Connect, in minutes. This value determines the maximum possible time before an agent is authenticated. For more information, see Configure the session duration in the Amazon Connect Administrator Guide.
|
|
2782
|
+
*/
|
|
2783
|
+
PeriodicSessionDuration?: AccessTokenDuration;
|
|
2784
|
+
/**
|
|
2785
|
+
* The long lived session duration for users logged in to Amazon Connect, in minutes. After this time period, users must log in again. For more information, see Configure the session duration in the Amazon Connect Administrator Guide.
|
|
2786
|
+
*/
|
|
2787
|
+
MaxSessionDuration?: RefreshTokenDuration;
|
|
2788
|
+
}
|
|
2789
|
+
export type AuthenticationProfileDescription = string;
|
|
2790
|
+
export type AuthenticationProfileId = string;
|
|
2791
|
+
export type AuthenticationProfileName = string;
|
|
2792
|
+
export interface AuthenticationProfileSummary {
|
|
2793
|
+
/**
|
|
2794
|
+
* The unique identifier of the authentication profile.
|
|
2795
|
+
*/
|
|
2796
|
+
Id?: AuthenticationProfileId;
|
|
2797
|
+
/**
|
|
2798
|
+
* The Amazon Resource Name (ARN) of the authentication profile summary.
|
|
2799
|
+
*/
|
|
2800
|
+
Arn?: ARN;
|
|
2801
|
+
/**
|
|
2802
|
+
* The name of the authentication profile summary.
|
|
2803
|
+
*/
|
|
2804
|
+
Name?: AuthenticationProfileName;
|
|
2805
|
+
/**
|
|
2806
|
+
* Shows whether the authentication profile is the default authentication profile for the Amazon Connect instance. The default authentication profile applies to all agents in an Amazon Connect instance, unless overridden by another authentication profile.
|
|
2807
|
+
*/
|
|
2808
|
+
IsDefault?: Boolean;
|
|
2809
|
+
/**
|
|
2810
|
+
* The timestamp when the authentication profile summary was last modified.
|
|
2811
|
+
*/
|
|
2812
|
+
LastModifiedTime?: Timestamp;
|
|
2813
|
+
/**
|
|
2814
|
+
* The Amazon Web Services Region when the authentication profile summary was last modified.
|
|
2815
|
+
*/
|
|
2816
|
+
LastModifiedRegion?: RegionName;
|
|
2817
|
+
}
|
|
2818
|
+
export type AuthenticationProfileSummaryList = AuthenticationProfileSummary[];
|
|
2498
2819
|
export type AutoAccept = boolean;
|
|
2499
2820
|
export interface AvailableNumberSummary {
|
|
2500
2821
|
/**
|
|
@@ -2560,6 +2881,30 @@ declare namespace Connect {
|
|
|
2560
2881
|
*/
|
|
2561
2882
|
Errors?: ErrorResults;
|
|
2562
2883
|
}
|
|
2884
|
+
export interface BatchGetAttachedFileMetadataRequest {
|
|
2885
|
+
/**
|
|
2886
|
+
* The unique identifiers of the attached file resource.
|
|
2887
|
+
*/
|
|
2888
|
+
FileIds: FileIdList;
|
|
2889
|
+
/**
|
|
2890
|
+
* The unique identifier of the Connect instance.
|
|
2891
|
+
*/
|
|
2892
|
+
InstanceId: InstanceId;
|
|
2893
|
+
/**
|
|
2894
|
+
* The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource. This value must be a valid ARN.
|
|
2895
|
+
*/
|
|
2896
|
+
AssociatedResourceArn: ARN;
|
|
2897
|
+
}
|
|
2898
|
+
export interface BatchGetAttachedFileMetadataResponse {
|
|
2899
|
+
/**
|
|
2900
|
+
* List of attached files that were successfully retrieved.
|
|
2901
|
+
*/
|
|
2902
|
+
Files?: AttachedFilesList;
|
|
2903
|
+
/**
|
|
2904
|
+
* List of errors of attached files that could not be retrieved.
|
|
2905
|
+
*/
|
|
2906
|
+
Errors?: AttachedFileErrorsList;
|
|
2907
|
+
}
|
|
2563
2908
|
export interface BatchGetFlowAssociationRequest {
|
|
2564
2909
|
/**
|
|
2565
2910
|
* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
|
|
@@ -2744,9 +3089,44 @@ declare namespace Connect {
|
|
|
2744
3089
|
SourcePhoneNumberArn?: ARN;
|
|
2745
3090
|
}
|
|
2746
3091
|
export type ClientToken = string;
|
|
3092
|
+
export interface CommonAttributeAndCondition {
|
|
3093
|
+
/**
|
|
3094
|
+
* A leaf node condition which can be used to specify a tag condition.
|
|
3095
|
+
*/
|
|
3096
|
+
TagConditions?: TagAndConditionList;
|
|
3097
|
+
}
|
|
3098
|
+
export type CommonAttributeOrConditionList = CommonAttributeAndCondition[];
|
|
2747
3099
|
export type CommonNameLength127 = string;
|
|
2748
3100
|
export type Comparison = "LT"|string;
|
|
3101
|
+
export type ComparisonOperator = string;
|
|
3102
|
+
export interface CompleteAttachedFileUploadRequest {
|
|
3103
|
+
/**
|
|
3104
|
+
* The unique identifier of the Amazon Connect instance.
|
|
3105
|
+
*/
|
|
3106
|
+
InstanceId: InstanceId;
|
|
3107
|
+
/**
|
|
3108
|
+
* The unique identifier of the attached file resource.
|
|
3109
|
+
*/
|
|
3110
|
+
FileId: FileId;
|
|
3111
|
+
/**
|
|
3112
|
+
* The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource. This value must be a valid ARN.
|
|
3113
|
+
*/
|
|
3114
|
+
AssociatedResourceArn: ARN;
|
|
3115
|
+
}
|
|
3116
|
+
export interface CompleteAttachedFileUploadResponse {
|
|
3117
|
+
}
|
|
2749
3118
|
export type Concurrency = number;
|
|
3119
|
+
export interface Condition {
|
|
3120
|
+
/**
|
|
3121
|
+
* A leaf node condition which can be used to specify a string condition. The currently supported values for FieldName are name and
 value.
|
|
3122
|
+
*/
|
|
3123
|
+
StringCondition?: StringCondition;
|
|
3124
|
+
/**
|
|
3125
|
+
* A leaf node condition which can be used to specify a numeric condition.
|
|
3126
|
+
*/
|
|
3127
|
+
NumberCondition?: NumberCondition;
|
|
3128
|
+
}
|
|
3129
|
+
export type Conditions = Condition[];
|
|
2750
3130
|
export interface ConnectionData {
|
|
2751
3131
|
/**
|
|
2752
3132
|
* The attendee information, including attendee ID and join token.
|
|
@@ -2850,6 +3230,39 @@ declare namespace Connect {
|
|
|
2850
3230
|
* Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags.
|
|
2851
3231
|
*/
|
|
2852
3232
|
Tags?: ContactTagMap;
|
|
3233
|
+
/**
|
|
3234
|
+
* The timestamp when customer endpoint connected to Amazon Connect.
|
|
3235
|
+
*/
|
|
3236
|
+
ConnectedToSystemTimestamp?: timestamp;
|
|
3237
|
+
/**
|
|
3238
|
+
* Latest routing criteria on the contact.
|
|
3239
|
+
*/
|
|
3240
|
+
RoutingCriteria?: RoutingCriteria;
|
|
3241
|
+
/**
|
|
3242
|
+
* Information about the Customer on the contact.
|
|
3243
|
+
*/
|
|
3244
|
+
Customer?: Customer;
|
|
3245
|
+
Campaign?: Campaign;
|
|
3246
|
+
/**
|
|
3247
|
+
* Indicates how an outbound campaign call is actually disposed if the contact is connected to Amazon Connect.
|
|
3248
|
+
*/
|
|
3249
|
+
AnsweringMachineDetectionStatus?: AnsweringMachineDetectionStatus;
|
|
3250
|
+
/**
|
|
3251
|
+
* Information about customer’s voice activity.
|
|
3252
|
+
*/
|
|
3253
|
+
CustomerVoiceActivity?: CustomerVoiceActivity;
|
|
3254
|
+
/**
|
|
3255
|
+
* Information about the quality of the participant's media connection.
|
|
3256
|
+
*/
|
|
3257
|
+
QualityMetrics?: QualityMetrics;
|
|
3258
|
+
/**
|
|
3259
|
+
* Information about the call disconnect experience.
|
|
3260
|
+
*/
|
|
3261
|
+
DisconnectDetails?: DisconnectDetails;
|
|
3262
|
+
/**
|
|
3263
|
+
* A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes and can be accessed in flows. Attribute keys can include only alphanumeric, -, and _ characters. This field can be used to show channel subtype. For example, connect:Guide or connect:SMS.
|
|
3264
|
+
*/
|
|
3265
|
+
SegmentAttributes?: SegmentAttributes;
|
|
2853
3266
|
}
|
|
2854
3267
|
export interface ContactAnalysis {
|
|
2855
3268
|
/**
|
|
@@ -2911,6 +3324,10 @@ declare namespace Connect {
|
|
|
2911
3324
|
* The type of flow.
|
|
2912
3325
|
*/
|
|
2913
3326
|
State?: ContactFlowState;
|
|
3327
|
+
/**
|
|
3328
|
+
* The status of the contact flow.
|
|
3329
|
+
*/
|
|
3330
|
+
Status?: ContactFlowStatus;
|
|
2914
3331
|
/**
|
|
2915
3332
|
* The description of the flow.
|
|
2916
3333
|
*/
|
|
@@ -2965,6 +3382,22 @@ declare namespace Connect {
|
|
|
2965
3382
|
export type ContactFlowModuleDescription = string;
|
|
2966
3383
|
export type ContactFlowModuleId = string;
|
|
2967
3384
|
export type ContactFlowModuleName = string;
|
|
3385
|
+
export type ContactFlowModuleSearchConditionList = ContactFlowModuleSearchCriteria[];
|
|
3386
|
+
export interface ContactFlowModuleSearchCriteria {
|
|
3387
|
+
/**
|
|
3388
|
+
* A list of conditions which would be applied together with an OR condition.
|
|
3389
|
+
*/
|
|
3390
|
+
OrConditions?: ContactFlowModuleSearchConditionList;
|
|
3391
|
+
/**
|
|
3392
|
+
* A list of conditions which would be applied together with an AND condition.
|
|
3393
|
+
*/
|
|
3394
|
+
AndConditions?: ContactFlowModuleSearchConditionList;
|
|
3395
|
+
StringCondition?: StringCondition;
|
|
3396
|
+
}
|
|
3397
|
+
export interface ContactFlowModuleSearchFilter {
|
|
3398
|
+
TagFilter?: ControlPlaneTagFilter;
|
|
3399
|
+
}
|
|
3400
|
+
export type ContactFlowModuleSearchSummaryList = ContactFlowModule[];
|
|
2968
3401
|
export type ContactFlowModuleState = "ACTIVE"|"ARCHIVED"|string;
|
|
2969
3402
|
export type ContactFlowModuleStatus = "PUBLISHED"|"SAVED"|string;
|
|
2970
3403
|
export interface ContactFlowModuleSummary {
|
|
@@ -2987,7 +3420,36 @@ declare namespace Connect {
|
|
|
2987
3420
|
}
|
|
2988
3421
|
export type ContactFlowModulesSummaryList = ContactFlowModuleSummary[];
|
|
2989
3422
|
export type ContactFlowName = string;
|
|
3423
|
+
export type ContactFlowSearchConditionList = ContactFlowSearchCriteria[];
|
|
3424
|
+
export interface ContactFlowSearchCriteria {
|
|
3425
|
+
/**
|
|
3426
|
+
* A list of conditions which would be applied together with an OR condition.
|
|
3427
|
+
*/
|
|
3428
|
+
OrConditions?: ContactFlowSearchConditionList;
|
|
3429
|
+
/**
|
|
3430
|
+
* A list of conditions which would be applied together with an AND condition.
|
|
3431
|
+
*/
|
|
3432
|
+
AndConditions?: ContactFlowSearchConditionList;
|
|
3433
|
+
StringCondition?: StringCondition;
|
|
3434
|
+
/**
|
|
3435
|
+
* The type of flow.
|
|
3436
|
+
*/
|
|
3437
|
+
TypeCondition?: ContactFlowType;
|
|
3438
|
+
/**
|
|
3439
|
+
* The state of the flow.
|
|
3440
|
+
*/
|
|
3441
|
+
StateCondition?: ContactFlowState;
|
|
3442
|
+
/**
|
|
3443
|
+
* The status of the flow.
|
|
3444
|
+
*/
|
|
3445
|
+
StatusCondition?: ContactFlowStatus;
|
|
3446
|
+
}
|
|
3447
|
+
export interface ContactFlowSearchFilter {
|
|
3448
|
+
TagFilter?: ControlPlaneTagFilter;
|
|
3449
|
+
}
|
|
3450
|
+
export type ContactFlowSearchSummaryList = ContactFlow[];
|
|
2990
3451
|
export type ContactFlowState = "ACTIVE"|"ARCHIVED"|string;
|
|
3452
|
+
export type ContactFlowStatus = "PUBLISHED"|"SAVED"|string;
|
|
2991
3453
|
export interface ContactFlowSummary {
|
|
2992
3454
|
/**
|
|
2993
3455
|
* The identifier of the flow.
|
|
@@ -3009,6 +3471,10 @@ declare namespace Connect {
|
|
|
3009
3471
|
* The type of flow.
|
|
3010
3472
|
*/
|
|
3011
3473
|
ContactFlowState?: ContactFlowState;
|
|
3474
|
+
/**
|
|
3475
|
+
* The status of the contact flow.
|
|
3476
|
+
*/
|
|
3477
|
+
ContactFlowStatus?: ContactFlowStatus;
|
|
3012
3478
|
}
|
|
3013
3479
|
export type ContactFlowSummaryList = ContactFlowSummary[];
|
|
3014
3480
|
export type ContactFlowType = "CONTACT_FLOW"|"CUSTOMER_QUEUE"|"CUSTOMER_HOLD"|"CUSTOMER_WHISPER"|"AGENT_HOLD"|"AGENT_WHISPER"|"OUTBOUND_WHISPER"|"AGENT_TRANSFER"|"QUEUE_TRANSFER"|string;
|
|
@@ -3091,6 +3557,17 @@ declare namespace Connect {
|
|
|
3091
3557
|
export type Contacts = ContactSearchSummary[];
|
|
3092
3558
|
export type Content = string;
|
|
3093
3559
|
export type ContentType = string;
|
|
3560
|
+
export interface ControlPlaneAttributeFilter {
|
|
3561
|
+
/**
|
|
3562
|
+
* A list of conditions which would be applied together with an OR condition.
|
|
3563
|
+
*/
|
|
3564
|
+
OrConditions?: CommonAttributeOrConditionList;
|
|
3565
|
+
/**
|
|
3566
|
+
* A list of conditions which would be applied together with an AND condition.
|
|
3567
|
+
*/
|
|
3568
|
+
AndCondition?: CommonAttributeAndCondition;
|
|
3569
|
+
TagCondition?: TagCondition;
|
|
3570
|
+
}
|
|
3094
3571
|
export interface ControlPlaneTagFilter {
|
|
3095
3572
|
/**
|
|
3096
3573
|
* A list of conditions which would be applied together with an OR condition.
|
|
@@ -3220,6 +3697,10 @@ declare namespace Connect {
|
|
|
3220
3697
|
* The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language. Length Constraints: Minimum length of 1. Maximum length of 256000.
|
|
3221
3698
|
*/
|
|
3222
3699
|
Content: ContactFlowContent;
|
|
3700
|
+
/**
|
|
3701
|
+
* Indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. the SAVED status does not initiate validation of the content. SAVED | PUBLISHED.
|
|
3702
|
+
*/
|
|
3703
|
+
Status?: ContactFlowStatus;
|
|
3223
3704
|
/**
|
|
3224
3705
|
* The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
|
|
3225
3706
|
*/
|
|
@@ -3990,6 +4471,16 @@ declare namespace Connect {
|
|
|
3990
4471
|
*/
|
|
3991
4472
|
State: VocabularyState;
|
|
3992
4473
|
}
|
|
4474
|
+
export interface CreatedByInfo {
|
|
4475
|
+
/**
|
|
4476
|
+
* An agent ARN representing a connect user.
|
|
4477
|
+
*/
|
|
4478
|
+
ConnectUserArn?: ARN;
|
|
4479
|
+
/**
|
|
4480
|
+
* STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if ConnectUserArn is not provided.
|
|
4481
|
+
*/
|
|
4482
|
+
AWSIdentityArn?: ARN;
|
|
4483
|
+
}
|
|
3993
4484
|
export interface Credentials {
|
|
3994
4485
|
/**
|
|
3995
4486
|
* An access token generated for a federated user to access Amazon Connect.
|
|
@@ -4056,6 +4547,29 @@ declare namespace Connect {
|
|
|
4056
4547
|
}
|
|
4057
4548
|
export type CurrentMetricSortCriteriaMaxOne = CurrentMetricSortCriteria[];
|
|
4058
4549
|
export type CurrentMetrics = CurrentMetric[];
|
|
4550
|
+
export interface Customer {
|
|
4551
|
+
/**
|
|
4552
|
+
* Information regarding Customer’s device.
|
|
4553
|
+
*/
|
|
4554
|
+
DeviceInfo?: DeviceInfo;
|
|
4555
|
+
Capabilities?: ParticipantCapabilities;
|
|
4556
|
+
}
|
|
4557
|
+
export interface CustomerQualityMetrics {
|
|
4558
|
+
/**
|
|
4559
|
+
* Information about the audio quality of the Customer
|
|
4560
|
+
*/
|
|
4561
|
+
Audio?: AudioQualityMetricsInfo;
|
|
4562
|
+
}
|
|
4563
|
+
export interface CustomerVoiceActivity {
|
|
4564
|
+
/**
|
|
4565
|
+
* Timestamp that measures the beginning of the customer greeting from an outbound voice call.
|
|
4566
|
+
*/
|
|
4567
|
+
GreetingStartTimestamp?: timestamp;
|
|
4568
|
+
/**
|
|
4569
|
+
* Timestamp that measures the end of the customer greeting from an outbound voice call.
|
|
4570
|
+
*/
|
|
4571
|
+
GreetingEndTimestamp?: timestamp;
|
|
4572
|
+
}
|
|
4059
4573
|
export type DataSetId = string;
|
|
4060
4574
|
export type DataSetIds = DataSetId[];
|
|
4061
4575
|
export interface DateReference {
|
|
@@ -4116,6 +4630,22 @@ declare namespace Connect {
|
|
|
4116
4630
|
}
|
|
4117
4631
|
export type DefaultVocabularyList = DefaultVocabulary[];
|
|
4118
4632
|
export type Delay = number;
|
|
4633
|
+
export interface DeleteAttachedFileRequest {
|
|
4634
|
+
/**
|
|
4635
|
+
* The unique identifier of the Connect instance.
|
|
4636
|
+
*/
|
|
4637
|
+
InstanceId: InstanceId;
|
|
4638
|
+
/**
|
|
4639
|
+
* The unique identifier of the attached file resource.
|
|
4640
|
+
*/
|
|
4641
|
+
FileId: FileId;
|
|
4642
|
+
/**
|
|
4643
|
+
* The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource. This value must be a valid ARN.
|
|
4644
|
+
*/
|
|
4645
|
+
AssociatedResourceArn: ARN;
|
|
4646
|
+
}
|
|
4647
|
+
export interface DeleteAttachedFileResponse {
|
|
4648
|
+
}
|
|
4119
4649
|
export interface DeleteContactEvaluationRequest {
|
|
4120
4650
|
/**
|
|
4121
4651
|
* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
|
|
@@ -4382,6 +4912,22 @@ declare namespace Connect {
|
|
|
4382
4912
|
*/
|
|
4383
4913
|
AgentStatus?: AgentStatus;
|
|
4384
4914
|
}
|
|
4915
|
+
export interface DescribeAuthenticationProfileRequest {
|
|
4916
|
+
/**
|
|
4917
|
+
* A unique identifier for the authentication profile.
|
|
4918
|
+
*/
|
|
4919
|
+
AuthenticationProfileId: AuthenticationProfileId;
|
|
4920
|
+
/**
|
|
4921
|
+
* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
|
|
4922
|
+
*/
|
|
4923
|
+
InstanceId: InstanceId;
|
|
4924
|
+
}
|
|
4925
|
+
export interface DescribeAuthenticationProfileResponse {
|
|
4926
|
+
/**
|
|
4927
|
+
* The authentication profile object being described.
|
|
4928
|
+
*/
|
|
4929
|
+
AuthenticationProfile?: AuthenticationProfile;
|
|
4930
|
+
}
|
|
4385
4931
|
export interface DescribeContactEvaluationRequest {
|
|
4386
4932
|
/**
|
|
4387
4933
|
* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
|
|
@@ -4749,6 +5295,20 @@ declare namespace Connect {
|
|
|
4749
5295
|
export type Description = string;
|
|
4750
5296
|
export type Description250 = string;
|
|
4751
5297
|
export type DestinationId = string;
|
|
5298
|
+
export interface DeviceInfo {
|
|
5299
|
+
/**
|
|
5300
|
+
* Name of the platform that the participant used for the call.
|
|
5301
|
+
*/
|
|
5302
|
+
PlatformName?: PlatformName;
|
|
5303
|
+
/**
|
|
5304
|
+
* Version of the platform that the participant used for the call.
|
|
5305
|
+
*/
|
|
5306
|
+
PlatformVersion?: PlatformVersion;
|
|
5307
|
+
/**
|
|
5308
|
+
* Operating system that the participant used for the call.
|
|
5309
|
+
*/
|
|
5310
|
+
OperatingSystem?: OperatingSystem;
|
|
5311
|
+
}
|
|
4752
5312
|
export interface Dimensions {
|
|
4753
5313
|
/**
|
|
4754
5314
|
* Information about the queue for which metrics are returned.
|
|
@@ -4938,6 +5498,12 @@ declare namespace Connect {
|
|
|
4938
5498
|
*/
|
|
4939
5499
|
UserProficiencies: UserProficiencyDisassociateList;
|
|
4940
5500
|
}
|
|
5501
|
+
export interface DisconnectDetails {
|
|
5502
|
+
/**
|
|
5503
|
+
* Indicates the potential disconnection issues for a call. This field is not populated if the service does not detect potential issues.
|
|
5504
|
+
*/
|
|
5505
|
+
PotentialDisconnectIssue?: PotentialDisconnectIssue;
|
|
5506
|
+
}
|
|
4941
5507
|
export interface DisconnectReason {
|
|
4942
5508
|
/**
|
|
4943
5509
|
* A code that indicates how the contact was terminated.
|
|
@@ -4974,6 +5540,17 @@ declare namespace Connect {
|
|
|
4974
5540
|
}
|
|
4975
5541
|
export type DistributionList = Distribution[];
|
|
4976
5542
|
export type Double = number;
|
|
5543
|
+
export interface DownloadUrlMetadata {
|
|
5544
|
+
/**
|
|
5545
|
+
* A pre-signed URL that should be used to download the attached file.
|
|
5546
|
+
*/
|
|
5547
|
+
Url?: MetadataUrl;
|
|
5548
|
+
/**
|
|
5549
|
+
* The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
|
|
5550
|
+
*/
|
|
5551
|
+
UrlExpiry?: ISO8601Datetime;
|
|
5552
|
+
}
|
|
5553
|
+
export type DurationInSeconds = number;
|
|
4977
5554
|
export type Email = string;
|
|
4978
5555
|
export interface EmailReference {
|
|
4979
5556
|
/**
|
|
@@ -5012,6 +5589,8 @@ declare namespace Connect {
|
|
|
5012
5589
|
}
|
|
5013
5590
|
export type EndpointAddress = string;
|
|
5014
5591
|
export type EndpointType = "TELEPHONE_NUMBER"|"VOIP"|"CONTACT_FLOW"|string;
|
|
5592
|
+
export type ErrorCode = string;
|
|
5593
|
+
export type ErrorMessage = string;
|
|
5015
5594
|
export interface ErrorResult {
|
|
5016
5595
|
/**
|
|
5017
5596
|
* The error code.
|
|
@@ -5554,6 +6133,31 @@ declare namespace Connect {
|
|
|
5554
6133
|
}
|
|
5555
6134
|
export type EventBridgeActionName = string;
|
|
5556
6135
|
export type EventSourceName = "OnPostCallAnalysisAvailable"|"OnRealTimeCallAnalysisAvailable"|"OnRealTimeChatAnalysisAvailable"|"OnPostChatAnalysisAvailable"|"OnZendeskTicketCreate"|"OnZendeskTicketStatusUpdate"|"OnSalesforceCaseCreate"|"OnContactEvaluationSubmit"|"OnMetricDataUpdate"|"OnCaseCreate"|"OnCaseUpdate"|string;
|
|
6136
|
+
export interface Expiry {
|
|
6137
|
+
/**
|
|
6138
|
+
* The number of seconds to wait before expiring the routing step.
|
|
6139
|
+
*/
|
|
6140
|
+
DurationInSeconds?: DurationInSeconds;
|
|
6141
|
+
/**
|
|
6142
|
+
* The timestamp indicating when the routing step expires.
|
|
6143
|
+
*/
|
|
6144
|
+
ExpiryTimestamp?: timestamp;
|
|
6145
|
+
}
|
|
6146
|
+
export interface Expression {
|
|
6147
|
+
/**
|
|
6148
|
+
* An object to specify the predefined attribute condition.
|
|
6149
|
+
*/
|
|
6150
|
+
AttributeCondition?: AttributeCondition;
|
|
6151
|
+
/**
|
|
6152
|
+
* List of routing expressions which will be AND-ed together.
|
|
6153
|
+
*/
|
|
6154
|
+
AndExpression?: Expressions;
|
|
6155
|
+
/**
|
|
6156
|
+
* List of routing expressions which will be OR-ed together.
|
|
6157
|
+
*/
|
|
6158
|
+
OrExpression?: Expressions;
|
|
6159
|
+
}
|
|
6160
|
+
export type Expressions = Expression[];
|
|
5557
6161
|
export interface FailedRequest {
|
|
5558
6162
|
/**
|
|
5559
6163
|
* Request identifier provided in the API call in the ContactDataRequest to create a contact.
|
|
@@ -5588,7 +6192,7 @@ declare namespace Connect {
|
|
|
5588
6192
|
*/
|
|
5589
6193
|
BooleanValue?: Boolean;
|
|
5590
6194
|
/**
|
|
5591
|
-
*
|
|
6195
|
+
* A Double number value type.
|
|
5592
6196
|
*/
|
|
5593
6197
|
DoubleValue?: Double;
|
|
5594
6198
|
/**
|
|
@@ -5601,6 +6205,12 @@ declare namespace Connect {
|
|
|
5601
6205
|
StringValue?: FieldStringValue;
|
|
5602
6206
|
}
|
|
5603
6207
|
export type FieldValues = FieldValue[];
|
|
6208
|
+
export type FileId = string;
|
|
6209
|
+
export type FileIdList = FileId[];
|
|
6210
|
+
export type FileName = string;
|
|
6211
|
+
export type FileSizeInBytes = number;
|
|
6212
|
+
export type FileStatusType = "APPROVED"|"REJECTED"|"PROCESSING"|"FAILED"|string;
|
|
6213
|
+
export type FileUseCaseType = "ATTACHMENT"|string;
|
|
5604
6214
|
export interface FilterV2 {
|
|
5605
6215
|
/**
|
|
5606
6216
|
* The key to use for filtering data. For example, QUEUE, ROUTING_PROFILE, AGENT, CHANNEL, AGENT_HIERARCHY_LEVEL_ONE, AGENT_HIERARCHY_LEVEL_TWO, AGENT_HIERARCHY_LEVEL_THREE, AGENT_HIERARCHY_LEVEL_FOUR, AGENT_HIERARCHY_LEVEL_FIVE. There must be at least 1 key and a maximum 5 keys.
|
|
@@ -5649,6 +6259,70 @@ declare namespace Connect {
|
|
|
5649
6259
|
export type FlowAssociationSummaryList = FlowAssociationSummary[];
|
|
5650
6260
|
export type FunctionArn = string;
|
|
5651
6261
|
export type FunctionArnsList = FunctionArn[];
|
|
6262
|
+
export interface GetAttachedFileRequest {
|
|
6263
|
+
/**
|
|
6264
|
+
* The unique identifier of the Connect instance.
|
|
6265
|
+
*/
|
|
6266
|
+
InstanceId: InstanceId;
|
|
6267
|
+
/**
|
|
6268
|
+
* The unique identifier of the attached file resource.
|
|
6269
|
+
*/
|
|
6270
|
+
FileId: FileId;
|
|
6271
|
+
/**
|
|
6272
|
+
* Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.
|
|
6273
|
+
*/
|
|
6274
|
+
UrlExpiryInSeconds?: URLExpiryInSeconds;
|
|
6275
|
+
/**
|
|
6276
|
+
* The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource. This value must be a valid ARN.
|
|
6277
|
+
*/
|
|
6278
|
+
AssociatedResourceArn: ARN;
|
|
6279
|
+
}
|
|
6280
|
+
export interface GetAttachedFileResponse {
|
|
6281
|
+
/**
|
|
6282
|
+
* The unique identifier of the attached file resource (ARN).
|
|
6283
|
+
*/
|
|
6284
|
+
FileArn?: ARN;
|
|
6285
|
+
/**
|
|
6286
|
+
* The unique identifier of the attached file resource.
|
|
6287
|
+
*/
|
|
6288
|
+
FileId?: FileId;
|
|
6289
|
+
/**
|
|
6290
|
+
* The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.
|
|
6291
|
+
*/
|
|
6292
|
+
CreationTime?: ISO8601Datetime;
|
|
6293
|
+
/**
|
|
6294
|
+
* The current status of the attached file.
|
|
6295
|
+
*/
|
|
6296
|
+
FileStatus?: FileStatusType;
|
|
6297
|
+
/**
|
|
6298
|
+
* A case-sensitive name of the attached file being uploaded.
|
|
6299
|
+
*/
|
|
6300
|
+
FileName?: FileName;
|
|
6301
|
+
/**
|
|
6302
|
+
* The size of the attached file in bytes.
|
|
6303
|
+
*/
|
|
6304
|
+
FileSizeInBytes: FileSizeInBytes;
|
|
6305
|
+
/**
|
|
6306
|
+
* The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
|
|
6307
|
+
*/
|
|
6308
|
+
AssociatedResourceArn?: ARN;
|
|
6309
|
+
/**
|
|
6310
|
+
* The use case for the file.
|
|
6311
|
+
*/
|
|
6312
|
+
FileUseCaseType?: FileUseCaseType;
|
|
6313
|
+
/**
|
|
6314
|
+
* Represents the identity that created the file.
|
|
6315
|
+
*/
|
|
6316
|
+
CreatedBy?: CreatedByInfo;
|
|
6317
|
+
/**
|
|
6318
|
+
* URL and expiry to be used when downloading the attached file.
|
|
6319
|
+
*/
|
|
6320
|
+
DownloadUrlMetadata?: DownloadUrlMetadata;
|
|
6321
|
+
/**
|
|
6322
|
+
* The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
|
|
6323
|
+
*/
|
|
6324
|
+
Tags?: TagMap;
|
|
6325
|
+
}
|
|
5652
6326
|
export interface GetContactAttributesRequest {
|
|
5653
6327
|
/**
|
|
5654
6328
|
* The identifier of the Amazon Connect instance.
|
|
@@ -5859,15 +6533,15 @@ declare namespace Connect {
|
|
|
5859
6533
|
*/
|
|
5860
6534
|
Interval?: IntervalDetails;
|
|
5861
6535
|
/**
|
|
5862
|
-
* The filters to apply to returned metrics. You can filter on the following resources: Queues Routing profiles
|
|
6536
|
+
* The filters to apply to returned metrics. You can filter on the following resources: Agents Campaigns Channels Feature Queues Routing profiles Routing step expression User hierarchy groups At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups. For metrics for outbound campaigns analytics, you can also use campaigns to satisfy at least one filter requirement. To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator Guide. Note the following limits: Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys: AGENT | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE | ANSWERING_MACHINE_DETECTION_STATUS | CAMPAIGN | CASE_TEMPLATE_ARN | CASE_STATUS | CHANNEL | contact/segmentAttributes/connect:Subtype | DISCONNECT_REASON | FEATURE | FLOW_TYPE | FLOWS_NEXT_RESOURCE_ID | FLOWS_NEXT_RESOURCE_QUEUE_ID | FLOWS_OUTCOME_TYPE | FLOWS_RESOURCE_ID | INITIATION_METHOD | RESOURCE_PUBLISHED_TIMESTAMP | ROUTING_PROFILE | ROUTING_STEP_EXPRESSION | QUEUE | Q_CONNECT_ENABLED | Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid filterValue for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters. contact_lens_conversational_analytics is a valid filterValue for the FEATURE filter key. It is available only to contacts analyzed by Contact Lens conversational analytics. connect:Chat, connect:SMS, connect:Telephony, and connect:WebRTC are valid filterValue examples (not exhaustive) for the contact/segmentAttributes/connect:Subtype filter key. ROUTING_STEP_EXPRESSION is a valid filter key with a filter value up to 3000 length. This filter is case and order sensitive. JSON string fields must be sorted in ascending order and JSON array order should be kept as is. Q_CONNECT_ENABLED. TRUE and FALSE are the only valid filterValues for the Q_CONNECT_ENABLED filter key. TRUE includes all contacts that had Amazon Q in Connect enabled as part of the flow. FALSE includes all contacts that did not have Amazon Q in Connect enabled as part of the flow This filter is available only for contact record-driven metrics. Campaign ARNs are valid filterValues for the CAMPAIGN filter key.
|
|
5863
6537
|
*/
|
|
5864
6538
|
Filters: FiltersV2List;
|
|
5865
6539
|
/**
|
|
5866
|
-
* The grouping applied to the metrics that are returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values that are returned apply to the metrics for each queue. They are not aggregated for all queues. If no grouping is specified, a summary of all metrics is returned. Valid grouping keys:
|
|
6540
|
+
* The grouping applied to the metrics that are returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values that are returned apply to the metrics for each queue. They are not aggregated for all queues. If no grouping is specified, a summary of all metrics is returned. Valid grouping keys: AGENT | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE | ANSWERING_MACHINE_DETECTION_STATUS | CAMPAIGN | CASE_TEMPLATE_ARN | CASE_STATUS | CHANNEL | contact/segmentAttributes/connect:Subtype | DISCONNECT_REASON | FLOWS_RESOURCE_ID | FLOWS_MODULE_RESOURCE_ID | FLOW_TYPE | FLOWS_OUTCOME_TYPE | INITIATION_METHOD | Q_CONNECT_ENABLED | QUEUE | RESOURCE_PUBLISHED_TIMESTAMP | ROUTING_PROFILE | ROUTING_STEP_EXPRESSION
|
|
5867
6541
|
*/
|
|
5868
6542
|
Groupings?: GroupingsV2;
|
|
5869
6543
|
/**
|
|
5870
|
-
* The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator's Guide. ABANDONMENT_RATE Unit: Percent Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI name: Abandonment rate AGENT_ADHERENT_TIME This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Adherent time AGENT_ANSWER_RATE Unit: Percent Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent answer rate AGENT_NON_ADHERENT_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Non-adherent time AGENT_NON_RESPONSE Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent non-response AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy Data for this metric is available starting from October 1, 2023 0:00:00 GMT. UI name: Agent non-response without customer abandons AGENT_OCCUPANCY Unit: Percentage Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy UI name: Occupancy AGENT_SCHEDULE_ADHERENCE This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available. Unit: Percent Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Adherence AGENT_SCHEDULED_TIME This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Scheduled time AVG_ABANDON_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI name: Average queue abandon time AVG_ACTIVE_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Average active time AVG_AFTER_CONTACT_WORK_TIME Unit: Seconds Valid metric filter key: INITIATION_METHOD Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI name: Average after contact work time Feature is a valid filter but not a valid grouping. AVG_AGENT_CONNECTING_TIME Unit: Seconds Valid metric filter key: INITIATION_METHOD. For now, this metric only supports the following as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Average agent API connecting time The Negate key in Metric Level Filters is not applicable for this metric. AVG_AGENT_PAUSE_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Average agent pause time AVG_CASE_RELATED_CONTACTS Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Average contacts per case AVG_CASE_RESOLUTION_TIME Unit: Seconds Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Average case resolution time AVG_CONTACT_DURATION Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI name: Average contact duration Feature is a valid filter but not a valid grouping. AVG_CONVERSATION_DURATION Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI name: Average conversation duration AVG_GREETING_TIME_AGENT This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Average greeting time agent AVG_HANDLE_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression UI name: Average handle time Feature is a valid filter but not a valid grouping. AVG_HOLD_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI name: Average customer hold time Feature is a valid filter but not a valid grouping. AVG_HOLD_TIME_ALL_CONTACTS Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Average customer hold time all contacts AVG_HOLDS Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI name: Average holds Feature is a valid filter but not a valid grouping. AVG_INTERACTION_AND_HOLD_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Average agent interaction and customer hold time AVG_INTERACTION_TIME Unit: Seconds Valid metric filter key: INITIATION_METHOD Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype UI name: Average agent interaction time Feature is a valid filter but not a valid grouping. AVG_INTERRUPTIONS_AGENT This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Average interruptions agent AVG_INTERRUPTION_TIME_AGENT This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Average interruption time agent AVG_NON_TALK_TIME This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Average non-talk time AVG_QUEUE_ANSWER_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype UI name: Average queue answer time Feature is a valid filter but not a valid grouping. AVG_RESOLUTION_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype UI name: Average resolution time AVG_TALK_TIME This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Average talk time AVG_TALK_TIME_AGENT This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Average talk time agent AVG_TALK_TIME_CUSTOMER This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Average talk time customer CASES_CREATED Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Cases created CONTACTS_ABANDONED Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression UI name: Contact abandoned CONTACTS_CREATED Unit: Count Valid metric filter key: INITIATION_METHOD Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype UI name: Contacts created Feature is a valid filter but not a valid grouping. CONTACTS_HANDLED Unit: Count Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression UI name: API contacts handled Feature is a valid filter but not a valid grouping. CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT Unit: Count Valid metric filter key: INITIATION_METHOD Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Contacts handled by Connected to agent CONTACTS_HOLD_ABANDONS Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Contacts hold disconnect CONTACTS_ON_HOLD_AGENT_DISCONNECT Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Contacts hold agent disconnect CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Contacts hold customer disconnect CONTACTS_PUT_ON_HOLD Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Contacts put on hold CONTACTS_TRANSFERRED_OUT_EXTERNAL Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Contacts transferred out external CONTACTS_TRANSFERRED_OUT_INTERNAL Unit: Percent Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Contacts transferred out internal CONTACTS_QUEUED Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Contacts queued CONTACTS_QUEUED_BY_ENQUEUE Unit: Count Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Contacts queued by Enqueue CONTACTS_RESOLVED_IN_X Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype Threshold: For ThresholdValue enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than"). UI name: Contacts resolved in X CONTACTS_TRANSFERRED_OUT Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI name: Contacts transferred out Feature is a valid filter but not a valid grouping. CONTACTS_TRANSFERRED_OUT_BY_AGENT Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Contacts transferred out by agent CONTACTS_TRANSFERRED_OUT_FROM_QUEUE Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Contacts transferred out queue CURRENT_CASES Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Current cases MAX_QUEUED_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Maximum queued time PERCENT_CASES_FIRST_CONTACT_RESOLVED Unit: Percent Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Cases resolved on first contact PERCENT_CONTACTS_STEP_EXPIRED Unit: Percent Valid groupings and filters: Queue, RoutingStepExpression UI name: Not available PERCENT_CONTACTS_STEP_JOINED Unit: Percent Valid groupings and filters: Queue, RoutingStepExpression UI name: Not available PERCENT_NON_TALK_TIME This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Percentage Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Non-talk time percent PERCENT_TALK_TIME This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Percentage Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Talk time percent PERCENT_TALK_TIME_AGENT This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Percentage Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Talk time agent percent PERCENT_TALK_TIME_CUSTOMER This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Percentage Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Talk time customer percent REOPENED_CASE_ACTIONS Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Cases reopened RESOLVED_CASE_ACTIONS Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Cases resolved SERVICE_LEVEL You can include up to 20 SERVICE_LEVEL metrics in a request. Unit: Percent Valid groupings and filters: Queue, Channel, Routing Profile Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than"). UI name: Service level X STEP_CONTACTS_QUEUED Unit: Count Valid groupings and filters: Queue, RoutingStepExpression UI name: Not available SUM_AFTER_CONTACT_WORK_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: After contact work time SUM_CONNECTING_TIME_AGENT Unit: Seconds Valid metric filter key: INITIATION_METHOD. This metric only supports the following filter keys as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent API connecting time The Negate key in Metric Level Filters is not applicable for this metric. SUM_CONTACT_FLOW_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Contact flow time SUM_CONTACT_TIME_AGENT Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent on contact time SUM_CONTACTS_ANSWERED_IN_X Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than"). UI name: Contacts answered in X seconds SUM_CONTACTS_ABANDONED_IN_X Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than"). UI name: Contacts abandoned in X seconds SUM_CONTACTS_DISCONNECTED Valid metric filter key: DISCONNECT_REASON Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Contact disconnected SUM_ERROR_STATUS_TIME_AGENT Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Error status time SUM_HANDLE_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Contact handle time SUM_HOLD_TIME Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Customer hold time SUM_IDLE_TIME_AGENT Unit: Seconds Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy UI name: Agent idle time SUM_INTERACTION_AND_HOLD_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent interaction and hold time SUM_INTERACTION_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent interaction time SUM_NON_PRODUCTIVE_TIME_AGENT Unit: Seconds Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy UI name: Non-Productive Time SUM_ONLINE_TIME_AGENT Unit: Seconds Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy UI name: Online time SUM_RETRY_CALLBACK_ATTEMPTS Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype UI name: Callback attempts
|
|
6544
|
+
* The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator Guide. ABANDONMENT_RATE Unit: Percent Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Abandonment rate AGENT_ADHERENT_TIME This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Adherent time AGENT_ANSWER_RATE Unit: Percent Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent answer rate AGENT_NON_ADHERENT_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Non-adherent time AGENT_NON_RESPONSE Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent non-response AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy Data for this metric is available starting from October 1, 2023 0:00:00 GMT. UI name: Agent non-response without customer abandons AGENT_OCCUPANCY Unit: Percentage Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy UI name: Occupancy AGENT_SCHEDULE_ADHERENCE This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available. Unit: Percent Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Adherence AGENT_SCHEDULED_TIME This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Scheduled time AVG_ABANDON_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average queue abandon time AVG_ACTIVE_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: Average active time AVG_AFTER_CONTACT_WORK_TIME Unit: Seconds Valid metric filter key: INITIATION_METHOD Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average after contact work time Feature is a valid filter but not a valid grouping. AVG_AGENT_CONNECTING_TIME Unit: Seconds Valid metric filter key: INITIATION_METHOD. For now, this metric only supports the following as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Average agent API connecting time The Negate key in Metric Level Filters is not applicable for this metric. AVG_AGENT_PAUSE_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: Average agent pause time AVG_CASE_RELATED_CONTACTS Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Average contacts per case AVG_CASE_RESOLUTION_TIME Unit: Seconds Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Average case resolution time AVG_CONTACT_DURATION Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average contact duration Feature is a valid filter but not a valid grouping. AVG_CONVERSATION_DURATION Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average conversation duration AVG_DIALS_PER_MINUTE This metric is available only for contacts analyzed by outbound campaigns analytics. Unit: Count Valid groupings and filters: Campaign, Agent, Queue, Routing Profile UI name: Average dials per minute AVG_FLOW_TIME Unit: Seconds Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp UI name: Average flow time AVG_GREETING_TIME_AGENT This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average agent greeting time AVG_HANDLE_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression UI name: Average handle time Feature is a valid filter but not a valid grouping. AVG_HOLD_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average customer hold time Feature is a valid filter but not a valid grouping. AVG_HOLD_TIME_ALL_CONTACTS Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average customer hold time all contacts AVG_HOLDS Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average holds Feature is a valid filter but not a valid grouping. AVG_INTERACTION_AND_HOLD_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average agent interaction and customer hold time AVG_INTERACTION_TIME Unit: Seconds Valid metric filter key: INITIATION_METHOD Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average agent interaction time Feature is a valid filter but not a valid grouping. AVG_INTERRUPTIONS_AGENT This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average agent interruptions AVG_INTERRUPTION_TIME_AGENT This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average agent interruption time AVG_NON_TALK_TIME This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average non-talk time AVG_QUEUE_ANSWER_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average queue answer time Feature is a valid filter but not a valid grouping. AVG_RESOLUTION_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average resolution time AVG_TALK_TIME This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average talk time AVG_TALK_TIME_AGENT This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average agent talk time AVG_TALK_TIME_CUSTOMER This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average customer talk time AVG_WAIT_TIME_AFTER_CUSTOMER_CONNECTION This metric is available only for contacts analyzed by outbound campaigns analytics. Unit: Seconds Valid groupings and filters: Campaign UI name: Average wait time after customer connection CAMPAIGN_CONTACTS_ABANDONED_AFTER_X This metric is available only for contacts analyzed by outbound campaigns analytics. Unit: Count Valid groupings and filters: Campaign, Agent Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter GT (for Greater than). UI name: Campaign contacts abandoned after X CAMPAIGN_CONTACTS_ABANDONED_AFTER_X_RATE This metric is available only for contacts analyzed by outbound campaigns analytics. Unit: Percent Valid groupings and filters: Campaign, Agent Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter GT (for Greater than). UI name: Campaign contacts abandoned after X rate CASES_CREATED Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Cases created CONTACTS_CREATED Unit: Count Valid metric filter key: INITIATION_METHOD Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Contacts created Feature is a valid filter but not a valid grouping. CONTACTS_HANDLED Unit: Count Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect UI name: API contacts handled Feature is a valid filter but not a valid grouping. CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT Unit: Count Valid metric filter key: INITIATION_METHOD Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Contacts handled (connected to agent timestamp) CONTACTS_HOLD_ABANDONS Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Contacts hold disconnect CONTACTS_ON_HOLD_AGENT_DISCONNECT Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: Contacts hold agent disconnect CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: Contacts hold customer disconnect CONTACTS_PUT_ON_HOLD Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: Contacts put on hold CONTACTS_TRANSFERRED_OUT_EXTERNAL Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: Contacts transferred out external CONTACTS_TRANSFERRED_OUT_INTERNAL Unit: Percent Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: Contacts transferred out internal CONTACTS_QUEUED Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Contacts queued CONTACTS_QUEUED_BY_ENQUEUE Unit: Count Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Contacts queued (enqueue timestamp) CONTACTS_REMOVED_FROM_QUEUE_IN_X Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than"). UI name: Contacts removed from queue in X seconds CONTACTS_RESOLVED_IN_X Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect Threshold: For ThresholdValue enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than"). UI name: Contacts resolved in X CONTACTS_TRANSFERRED_OUT Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Contacts transferred out Feature is a valid filter but not a valid grouping. CONTACTS_TRANSFERRED_OUT_BY_AGENT Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Contacts transferred out by agent CONTACTS_TRANSFERRED_OUT_FROM_QUEUE Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Contacts transferred out queue CURRENT_CASES Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Current cases DELIVERY_ATTEMPTS This metric is available only for contacts analyzed by outbound campaigns analytics. Unit: Count Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, DISCONNECT_REASON Valid groupings and filters: Campaign, Agent, Queue, Routing Profile, Answering Machine Detection Status, Disconnect Reason UI name: Delivery attempts DELIVERY_ATTEMPT_DISPOSITION_RATE This metric is available only for contacts analyzed by outbound campaigns analytics, and with the answering machine detection enabled. Unit: Percent Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, DISCONNECT_REASON Valid groupings and filters: Campaign, Agent, Answering Machine Detection Status, Disconnect Reason Answering Machine Detection Status and Disconnect Reason are valid filters but not valid groupings. UI name: Delivery attempt disposition rate FLOWS_OUTCOME Unit: Count Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp UI name: Flows outcome FLOWS_STARTED Unit: Count Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows resource ID, Initiation method, Resource published timestamp UI name: Flows started HUMAN_ANSWERED_CALLS This metric is available only for contacts analyzed by outbound campaigns analytics, and with the answering machine detection enabled. Unit: Count Valid groupings and filters: Campaign, Agent UI name: Human answered MAX_FLOW_TIME Unit: Seconds Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp UI name: Maximum flow time MAX_QUEUED_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Maximum queued time MIN_FLOW_TIME Unit: Seconds Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp UI name: Minimum flow time PERCENT_CASES_FIRST_CONTACT_RESOLVED Unit: Percent Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Cases resolved on first contact PERCENT_CONTACTS_STEP_EXPIRED Unit: Percent Valid groupings and filters: Queue, RoutingStepExpression UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI. PERCENT_CONTACTS_STEP_JOINED Unit: Percent Valid groupings and filters: Queue, RoutingStepExpression UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI. PERCENT_FLOWS_OUTCOME Unit: Percent Valid metric filter key: FLOWS_OUTCOME_TYPE Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp UI name: Flows outcome percentage. The FLOWS_OUTCOME_TYPE is not a valid grouping. PERCENT_NON_TALK_TIME This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Percentage Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Non-talk time percent PERCENT_TALK_TIME This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Percentage Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Talk time percent PERCENT_TALK_TIME_AGENT This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Percentage Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Agent talk time percent PERCENT_TALK_TIME_CUSTOMER This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Percentage Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Customer talk time percent REOPENED_CASE_ACTIONS Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Cases reopened RESOLVED_CASE_ACTIONS Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Cases resolved SERVICE_LEVEL You can include up to 20 SERVICE_LEVEL metrics in a request. Unit: Percent Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than"). UI name: Service level X STEP_CONTACTS_QUEUED Unit: Count Valid groupings and filters: Queue, RoutingStepExpression UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI. SUM_AFTER_CONTACT_WORK_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: After contact work time SUM_CONNECTING_TIME_AGENT Unit: Seconds Valid metric filter key: INITIATION_METHOD. This metric only supports the following filter keys as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent API connecting time The Negate key in Metric Level Filters is not applicable for this metric. SUM_CONTACTS_ABANDONED Unit: Count Metric filter: Valid values: API| Incoming | Outbound | Transfer | Callback | Queue_Transfer| Disconnect Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect UI name: Contact abandoned SUM_CONTACTS_ABANDONED_IN_X Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than"). UI name: Contacts abandoned in X seconds SUM_CONTACTS_ANSWERED_IN_X Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than"). UI name: Contacts answered in X seconds SUM_CONTACT_FLOW_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: Contact flow time SUM_CONTACT_TIME_AGENT Unit: Seconds Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy UI name: Agent on contact time SUM_CONTACTS_DISCONNECTED Valid metric filter key: DISCONNECT_REASON Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Contact disconnected SUM_ERROR_STATUS_TIME_AGENT Unit: Seconds Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy UI name: Error status time SUM_HANDLE_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: Contact handle time SUM_HOLD_TIME Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: Customer hold time SUM_IDLE_TIME_AGENT Unit: Seconds Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy UI name: Agent idle time SUM_INTERACTION_AND_HOLD_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: Agent interaction and hold time SUM_INTERACTION_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent interaction time SUM_NON_PRODUCTIVE_TIME_AGENT Unit: Seconds Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy UI name: Non-Productive Time SUM_ONLINE_TIME_AGENT Unit: Seconds Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy UI name: Online time SUM_RETRY_CALLBACK_ATTEMPTS Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Callback attempts
|
|
5871
6545
|
*/
|
|
5872
6546
|
Metrics: MetricsV2;
|
|
5873
6547
|
/**
|
|
@@ -6094,6 +6768,28 @@ declare namespace Connect {
|
|
|
6094
6768
|
*/
|
|
6095
6769
|
Arn?: ARN;
|
|
6096
6770
|
}
|
|
6771
|
+
export interface HierarchyGroups {
|
|
6772
|
+
/**
|
|
6773
|
+
* The group at level one of the agent hierarchy.
|
|
6774
|
+
*/
|
|
6775
|
+
Level1?: AgentHierarchyGroup;
|
|
6776
|
+
/**
|
|
6777
|
+
* The group at level two of the agent hierarchy.
|
|
6778
|
+
*/
|
|
6779
|
+
Level2?: AgentHierarchyGroup;
|
|
6780
|
+
/**
|
|
6781
|
+
* The group at level three of the agent hierarchy.
|
|
6782
|
+
*/
|
|
6783
|
+
Level3?: AgentHierarchyGroup;
|
|
6784
|
+
/**
|
|
6785
|
+
* The group at level four of the agent hierarchy.
|
|
6786
|
+
*/
|
|
6787
|
+
Level4?: AgentHierarchyGroup;
|
|
6788
|
+
/**
|
|
6789
|
+
* The group at level five of the agent hierarchy.
|
|
6790
|
+
*/
|
|
6791
|
+
Level5?: AgentHierarchyGroup;
|
|
6792
|
+
}
|
|
6097
6793
|
export interface HierarchyLevel {
|
|
6098
6794
|
/**
|
|
6099
6795
|
* The identifier of the hierarchy level.
|
|
@@ -6401,6 +7097,7 @@ declare namespace Connect {
|
|
|
6401
7097
|
PhoneNumberArn?: ARN;
|
|
6402
7098
|
}
|
|
6403
7099
|
export type InboundCallsEnabled = boolean;
|
|
7100
|
+
export type Index = number;
|
|
6404
7101
|
export type InitiationMethodList = ContactInitiationMethod[];
|
|
6405
7102
|
export interface Instance {
|
|
6406
7103
|
/**
|
|
@@ -6592,6 +7289,8 @@ declare namespace Connect {
|
|
|
6592
7289
|
Id?: TaskTemplateFieldIdentifier;
|
|
6593
7290
|
}
|
|
6594
7291
|
export type InvisibleTaskTemplateFields = InvisibleFieldInfo[];
|
|
7292
|
+
export type IpCidr = string;
|
|
7293
|
+
export type IpCidrList = IpCidr[];
|
|
6595
7294
|
export type JoinToken = string;
|
|
6596
7295
|
export type KeyId = string;
|
|
6597
7296
|
export interface KinesisFirehoseConfig {
|
|
@@ -6718,11 +7417,35 @@ declare namespace Connect {
|
|
|
6718
7417
|
*/
|
|
6719
7418
|
MaxResults?: MaxResult25;
|
|
6720
7419
|
}
|
|
6721
|
-
export interface ListApprovedOriginsResponse {
|
|
7420
|
+
export interface ListApprovedOriginsResponse {
|
|
7421
|
+
/**
|
|
7422
|
+
* The approved origins.
|
|
7423
|
+
*/
|
|
7424
|
+
Origins?: OriginsList;
|
|
7425
|
+
/**
|
|
7426
|
+
* If there are additional results, this is the token for the next set of results.
|
|
7427
|
+
*/
|
|
7428
|
+
NextToken?: NextToken;
|
|
7429
|
+
}
|
|
7430
|
+
export interface ListAuthenticationProfilesRequest {
|
|
7431
|
+
/**
|
|
7432
|
+
* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
|
|
7433
|
+
*/
|
|
7434
|
+
InstanceId: InstanceId;
|
|
7435
|
+
/**
|
|
7436
|
+
* The maximum number of results to return per page.
|
|
7437
|
+
*/
|
|
7438
|
+
MaxResults?: MaxResult1000;
|
|
7439
|
+
/**
|
|
7440
|
+
* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
|
|
7441
|
+
*/
|
|
7442
|
+
NextToken?: NextToken;
|
|
7443
|
+
}
|
|
7444
|
+
export interface ListAuthenticationProfilesResponse {
|
|
6722
7445
|
/**
|
|
6723
|
-
*
|
|
7446
|
+
* A summary of a given authentication profile.
|
|
6724
7447
|
*/
|
|
6725
|
-
|
|
7448
|
+
AuthenticationProfileSummaryList?: AuthenticationProfileSummaryList;
|
|
6726
7449
|
/**
|
|
6727
7450
|
* If there are additional results, this is the token for the next set of results.
|
|
6728
7451
|
*/
|
|
@@ -6756,6 +7479,16 @@ declare namespace Connect {
|
|
|
6756
7479
|
*/
|
|
6757
7480
|
NextToken?: NextToken;
|
|
6758
7481
|
}
|
|
7482
|
+
export interface ListCondition {
|
|
7483
|
+
/**
|
|
7484
|
+
* The type of target list that will be used to filter the users.
|
|
7485
|
+
*/
|
|
7486
|
+
TargetListType?: TargetListType;
|
|
7487
|
+
/**
|
|
7488
|
+
* A list of Condition objects which would be applied together with an AND condition.
|
|
7489
|
+
*/
|
|
7490
|
+
Conditions?: Conditions;
|
|
7491
|
+
}
|
|
6759
7492
|
export interface ListContactEvaluationsRequest {
|
|
6760
7493
|
/**
|
|
6761
7494
|
* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
|
|
@@ -7917,6 +8650,12 @@ declare namespace Connect {
|
|
|
7917
8650
|
NextToken?: ViewsNextToken;
|
|
7918
8651
|
}
|
|
7919
8652
|
export type Long = number;
|
|
8653
|
+
export interface MatchCriteria {
|
|
8654
|
+
/**
|
|
8655
|
+
* An object to define agentIds.
|
|
8656
|
+
*/
|
|
8657
|
+
AgentsCriteria?: AgentsCriteria;
|
|
8658
|
+
}
|
|
7920
8659
|
export type MaxResult10 = number;
|
|
7921
8660
|
export type MaxResult100 = number;
|
|
7922
8661
|
export type MaxResult1000 = number;
|
|
@@ -7990,6 +8729,7 @@ declare namespace Connect {
|
|
|
7990
8729
|
Audio?: AudioFeatures;
|
|
7991
8730
|
}
|
|
7992
8731
|
export type MeetingId = string;
|
|
8732
|
+
export type MetadataUrl = string;
|
|
7993
8733
|
export type MetricDataCollectionsV2 = MetricDataV2[];
|
|
7994
8734
|
export interface MetricDataV2 {
|
|
7995
8735
|
/**
|
|
@@ -8003,7 +8743,7 @@ declare namespace Connect {
|
|
|
8003
8743
|
}
|
|
8004
8744
|
export interface MetricFilterV2 {
|
|
8005
8745
|
/**
|
|
8006
|
-
* The key to use for filtering data. Valid metric filter keys: INITIATION_METHOD, DISCONNECT_REASON. These are the same values as the InitiationMethod and DisconnectReason in the contact record. For more information, see ContactTraceRecord in the Amazon Connect Administrator
|
|
8746
|
+
* The key to use for filtering data. Valid metric filter keys: INITIATION_METHOD, DISCONNECT_REASON. These are the same values as the InitiationMethod and DisconnectReason in the contact record. For more information, see ContactTraceRecord in the Amazon Connect Administrator Guide.
|
|
8007
8747
|
*/
|
|
8008
8748
|
MetricFilterKey?: String;
|
|
8009
8749
|
/**
|
|
@@ -8126,6 +8866,27 @@ declare namespace Connect {
|
|
|
8126
8866
|
*/
|
|
8127
8867
|
UserIds?: UserIdList;
|
|
8128
8868
|
}
|
|
8869
|
+
export type NullableProficiencyLevel = number;
|
|
8870
|
+
export type NullableProficiencyLimitValue = number;
|
|
8871
|
+
export type NumberComparisonType = "GREATER_OR_EQUAL"|"GREATER"|"LESSER_OR_EQUAL"|"LESSER"|"EQUAL"|"NOT_EQUAL"|"RANGE"|string;
|
|
8872
|
+
export interface NumberCondition {
|
|
8873
|
+
/**
|
|
8874
|
+
* The name of the field in the number condition.
|
|
8875
|
+
*/
|
|
8876
|
+
FieldName?: String;
|
|
8877
|
+
/**
|
|
8878
|
+
* The minValue to be used while evaluating the number condition.
|
|
8879
|
+
*/
|
|
8880
|
+
MinValue?: NullableProficiencyLimitValue;
|
|
8881
|
+
/**
|
|
8882
|
+
* The maxValue to be used while evaluating the number condition.
|
|
8883
|
+
*/
|
|
8884
|
+
MaxValue?: NullableProficiencyLimitValue;
|
|
8885
|
+
/**
|
|
8886
|
+
* The type of comparison to be made when evaluating the number condition.
|
|
8887
|
+
*/
|
|
8888
|
+
ComparisonType?: NumberComparisonType;
|
|
8889
|
+
}
|
|
8129
8890
|
export interface NumberReference {
|
|
8130
8891
|
/**
|
|
8131
8892
|
* Identifier of the number reference.
|
|
@@ -8143,6 +8904,7 @@ declare namespace Connect {
|
|
|
8143
8904
|
*/
|
|
8144
8905
|
Label: NumericQuestionPropertyAutomationLabel;
|
|
8145
8906
|
}
|
|
8907
|
+
export type OperatingSystem = string;
|
|
8146
8908
|
export type Origin = string;
|
|
8147
8909
|
export type OriginsList = Origin[];
|
|
8148
8910
|
export interface OutboundCallerConfig {
|
|
@@ -8305,6 +9067,11 @@ declare namespace Connect {
|
|
|
8305
9067
|
export type PhoneNumberWorkflowMessage = string;
|
|
8306
9068
|
export type PhoneNumberWorkflowStatus = "CLAIMED"|"IN_PROGRESS"|"FAILED"|string;
|
|
8307
9069
|
export type PhoneType = "SOFT_PHONE"|"DESK_PHONE"|string;
|
|
9070
|
+
export type PlatformName = string;
|
|
9071
|
+
export type PlatformVersion = string;
|
|
9072
|
+
export type PotentialAudioQualityIssue = string;
|
|
9073
|
+
export type PotentialAudioQualityIssues = PotentialAudioQualityIssue[];
|
|
9074
|
+
export type PotentialDisconnectIssue = string;
|
|
8308
9075
|
export interface PredefinedAttribute {
|
|
8309
9076
|
/**
|
|
8310
9077
|
* The name of the predefined attribute.
|
|
@@ -8363,6 +9130,7 @@ declare namespace Connect {
|
|
|
8363
9130
|
export type Prefix = string;
|
|
8364
9131
|
export type Priority = number;
|
|
8365
9132
|
export type ProficiencyLevel = number;
|
|
9133
|
+
export type ProficiencyValue = string;
|
|
8366
9134
|
export interface Prompt {
|
|
8367
9135
|
/**
|
|
8368
9136
|
* The Amazon Resource Name (ARN) of the prompt.
|
|
@@ -8455,6 +9223,16 @@ declare namespace Connect {
|
|
|
8455
9223
|
}
|
|
8456
9224
|
export interface PutUserStatusResponse {
|
|
8457
9225
|
}
|
|
9226
|
+
export interface QualityMetrics {
|
|
9227
|
+
/**
|
|
9228
|
+
* Information about the quality of Agent media connection.
|
|
9229
|
+
*/
|
|
9230
|
+
Agent?: AgentQualityMetrics;
|
|
9231
|
+
/**
|
|
9232
|
+
* Information about the quality of Customer media connection.
|
|
9233
|
+
*/
|
|
9234
|
+
Customer?: CustomerQualityMetrics;
|
|
9235
|
+
}
|
|
8458
9236
|
export interface Queue {
|
|
8459
9237
|
/**
|
|
8460
9238
|
* The name of the queue.
|
|
@@ -8760,6 +9538,9 @@ declare namespace Connect {
|
|
|
8760
9538
|
TranscriptItems?: RealTimeContactAnalysisTranscriptItemsWithCharacterOffsets;
|
|
8761
9539
|
}
|
|
8762
9540
|
export type RealTimeContactAnalysisPointsOfInterest = RealTimeContactAnalysisPointOfInterest[];
|
|
9541
|
+
export type RealTimeContactAnalysisPostContactSummaryContent = string;
|
|
9542
|
+
export type RealTimeContactAnalysisPostContactSummaryFailureCode = "QUOTA_EXCEEDED"|"INSUFFICIENT_CONVERSATION_CONTENT"|"FAILED_SAFETY_GUIDELINES"|"INVALID_ANALYSIS_CONFIGURATION"|"INTERNAL_ERROR"|string;
|
|
9543
|
+
export type RealTimeContactAnalysisPostContactSummaryStatus = "FAILED"|"COMPLETED"|string;
|
|
8763
9544
|
export interface RealTimeContactAnalysisSegmentAttachments {
|
|
8764
9545
|
/**
|
|
8765
9546
|
* The identifier of the segment.
|
|
@@ -8824,6 +9605,20 @@ declare namespace Connect {
|
|
|
8824
9605
|
*/
|
|
8825
9606
|
IssuesDetected: RealTimeContactAnalysisIssuesDetected;
|
|
8826
9607
|
}
|
|
9608
|
+
export interface RealTimeContactAnalysisSegmentPostContactSummary {
|
|
9609
|
+
/**
|
|
9610
|
+
* The content of the summary.
|
|
9611
|
+
*/
|
|
9612
|
+
Content?: RealTimeContactAnalysisPostContactSummaryContent;
|
|
9613
|
+
/**
|
|
9614
|
+
* Whether the summary was successfully COMPLETED or FAILED to be generated.
|
|
9615
|
+
*/
|
|
9616
|
+
Status: RealTimeContactAnalysisPostContactSummaryStatus;
|
|
9617
|
+
/**
|
|
9618
|
+
* If the summary failed to be generated, one of the following failure codes occurs: QUOTA_EXCEEDED: The number of concurrent analytics jobs reached your service quota. INSUFFICIENT_CONVERSATION_CONTENT: The conversation needs to have at least one turn from both the participants in order to generate the summary. FAILED_SAFETY_GUIDELINES: The generated summary cannot be provided because it failed to meet system safety guidelines. INVALID_ANALYSIS_CONFIGURATION: This code occurs when, for example, you're using a language that isn't supported by generative AI-powered post-contact summaries. INTERNAL_ERROR: Internal system error.
|
|
9619
|
+
*/
|
|
9620
|
+
FailureCode?: RealTimeContactAnalysisPostContactSummaryFailureCode;
|
|
9621
|
+
}
|
|
8827
9622
|
export interface RealTimeContactAnalysisSegmentTranscript {
|
|
8828
9623
|
/**
|
|
8829
9624
|
* The identifier of the transcript.
|
|
@@ -8862,7 +9657,7 @@ declare namespace Connect {
|
|
|
8862
9657
|
*/
|
|
8863
9658
|
Sentiment?: RealTimeContactAnalysisSentimentLabel;
|
|
8864
9659
|
}
|
|
8865
|
-
export type RealTimeContactAnalysisSegmentType = "Transcript"|"Categories"|"Issues"|"Event"|"Attachments"|string;
|
|
9660
|
+
export type RealTimeContactAnalysisSegmentType = "Transcript"|"Categories"|"Issues"|"Event"|"Attachments"|"PostContactSummary"|string;
|
|
8866
9661
|
export type RealTimeContactAnalysisSegmentTypes = RealTimeContactAnalysisSegmentType[];
|
|
8867
9662
|
export type RealTimeContactAnalysisSentimentLabel = "POSITIVE"|"NEGATIVE"|"NEUTRAL"|string;
|
|
8868
9663
|
export type RealTimeContactAnalysisStatus = "IN_PROGRESS"|"FAILED"|"COMPLETED"|string;
|
|
@@ -8913,6 +9708,10 @@ declare namespace Connect {
|
|
|
8913
9708
|
* The analyzed attachments.
|
|
8914
9709
|
*/
|
|
8915
9710
|
Attachments?: RealTimeContactAnalysisSegmentAttachments;
|
|
9711
|
+
/**
|
|
9712
|
+
* Information about the post-contact summary.
|
|
9713
|
+
*/
|
|
9714
|
+
PostContactSummary?: RealTimeContactAnalysisSegmentPostContactSummary;
|
|
8916
9715
|
}
|
|
8917
9716
|
export type RealtimeContactAnalysisSegments = RealtimeContactAnalysisSegment[];
|
|
8918
9717
|
export interface Reference {
|
|
@@ -8958,6 +9757,7 @@ declare namespace Connect {
|
|
|
8958
9757
|
export type ReferenceType = "URL"|"ATTACHMENT"|"NUMBER"|"STRING"|"DATE"|"EMAIL"|string;
|
|
8959
9758
|
export type ReferenceTypes = ReferenceType[];
|
|
8960
9759
|
export type ReferenceValue = string;
|
|
9760
|
+
export type RefreshTokenDuration = number;
|
|
8961
9761
|
export type RegionName = string;
|
|
8962
9762
|
export type RehydrationType = "ENTIRE_PAST_SESSION"|"FROM_SEGMENT"|string;
|
|
8963
9763
|
export interface ReleasePhoneNumberRequest {
|
|
@@ -9047,6 +9847,44 @@ declare namespace Connect {
|
|
|
9047
9847
|
}
|
|
9048
9848
|
export interface ResumeContactResponse {
|
|
9049
9849
|
}
|
|
9850
|
+
export interface RoutingCriteria {
|
|
9851
|
+
/**
|
|
9852
|
+
* List of routing steps. When Amazon Connect does not find an available agent meeting the requirements in a step for a given step duration, the routing criteria will move on to the next step sequentially until a join is completed with an agent. When all steps are exhausted, the contact will be offered to any agent in the queue.
|
|
9853
|
+
*/
|
|
9854
|
+
Steps?: Steps;
|
|
9855
|
+
/**
|
|
9856
|
+
* The timestamp indicating when the routing criteria is set to active. A routing criteria is activated when contact is transferred to a queue. ActivationTimestamp will be set on routing criteria for contacts in agent queue even though Routing criteria is never activated for contacts in agent queue.
|
|
9857
|
+
*/
|
|
9858
|
+
ActivationTimestamp?: timestamp;
|
|
9859
|
+
/**
|
|
9860
|
+
* Information about the index of the routing criteria.
|
|
9861
|
+
*/
|
|
9862
|
+
Index?: Index;
|
|
9863
|
+
}
|
|
9864
|
+
export interface RoutingCriteriaInput {
|
|
9865
|
+
/**
|
|
9866
|
+
* When Amazon Connect does not find an available agent meeting the requirements in a step for
 a given step duration, the routing criteria will move on to the next step sequentially until a
 join is completed with an agent. When all steps are exhausted, the contact will be offered to any agent in the queue.
|
|
9867
|
+
*/
|
|
9868
|
+
Steps?: RoutingCriteriaInputSteps;
|
|
9869
|
+
}
|
|
9870
|
+
export interface RoutingCriteriaInputStep {
|
|
9871
|
+
/**
|
|
9872
|
+
* An object to specify the expiration of a routing step.
|
|
9873
|
+
*/
|
|
9874
|
+
Expiry?: RoutingCriteriaInputStepExpiry;
|
|
9875
|
+
/**
|
|
9876
|
+
* A tagged union to specify expression for a routing step.
|
|
9877
|
+
*/
|
|
9878
|
+
Expression?: Expression;
|
|
9879
|
+
}
|
|
9880
|
+
export interface RoutingCriteriaInputStepExpiry {
|
|
9881
|
+
/**
|
|
9882
|
+
* The number of seconds that the contact will be routed only to agents matching this routing
 step, if expiry was configured for this routing step.
|
|
9883
|
+
*/
|
|
9884
|
+
DurationInSeconds?: DurationInSeconds;
|
|
9885
|
+
}
|
|
9886
|
+
export type RoutingCriteriaInputSteps = RoutingCriteriaInputStep[];
|
|
9887
|
+
export type RoutingCriteriaStepStatus = "ACTIVE"|"INACTIVE"|"JOINED"|"EXPIRED"|string;
|
|
9050
9888
|
export type RoutingExpression = string;
|
|
9051
9889
|
export type RoutingExpressions = RoutingExpression[];
|
|
9052
9890
|
export interface RoutingProfile {
|
|
@@ -9106,6 +9944,10 @@ declare namespace Connect {
|
|
|
9106
9944
|
* Whether this a default routing profile.
|
|
9107
9945
|
*/
|
|
9108
9946
|
IsDefault?: Boolean;
|
|
9947
|
+
/**
|
|
9948
|
+
* The IDs of the associated queue.
|
|
9949
|
+
*/
|
|
9950
|
+
AssociatedQueueIds?: AssociatedQueueIdList;
|
|
9109
9951
|
}
|
|
9110
9952
|
export type RoutingProfileDescription = string;
|
|
9111
9953
|
export type RoutingProfileId = string;
|
|
@@ -9185,7 +10027,7 @@ declare namespace Connect {
|
|
|
9185
10027
|
*/
|
|
9186
10028
|
AndConditions?: RoutingProfileSearchConditionList;
|
|
9187
10029
|
/**
|
|
9188
|
-
* A leaf node condition which can be used to specify a string condition. The currently supported values for FieldName are name, description, and resourceID.
|
|
10030
|
+
* A leaf node condition which can be used to specify a string condition. The currently supported values for FieldName are associatedQueueIds, name, description, and resourceID.
|
|
9189
10031
|
*/
|
|
9190
10032
|
StringCondition?: StringCondition;
|
|
9191
10033
|
}
|
|
@@ -9365,6 +10207,42 @@ declare namespace Connect {
|
|
|
9365
10207
|
EncryptionConfig?: EncryptionConfig;
|
|
9366
10208
|
}
|
|
9367
10209
|
export type S3Uri = string;
|
|
10210
|
+
export interface SearchAgentStatusesRequest {
|
|
10211
|
+
/**
|
|
10212
|
+
* The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
|
|
10213
|
+
*/
|
|
10214
|
+
InstanceId: InstanceId;
|
|
10215
|
+
/**
|
|
10216
|
+
* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
|
|
10217
|
+
*/
|
|
10218
|
+
NextToken?: NextToken2500;
|
|
10219
|
+
/**
|
|
10220
|
+
* The maximum number of results to return per page.
|
|
10221
|
+
*/
|
|
10222
|
+
MaxResults?: MaxResult100;
|
|
10223
|
+
/**
|
|
10224
|
+
* Filters to be applied to search results.
|
|
10225
|
+
*/
|
|
10226
|
+
SearchFilter?: AgentStatusSearchFilter;
|
|
10227
|
+
/**
|
|
10228
|
+
* The search criteria to be used to return agent statuses.
|
|
10229
|
+
*/
|
|
10230
|
+
SearchCriteria?: AgentStatusSearchCriteria;
|
|
10231
|
+
}
|
|
10232
|
+
export interface SearchAgentStatusesResponse {
|
|
10233
|
+
/**
|
|
10234
|
+
* The search criteria to be used to return agent statuses.
|
|
10235
|
+
*/
|
|
10236
|
+
AgentStatuses?: AgentStatusList;
|
|
10237
|
+
/**
|
|
10238
|
+
* If there are additional results, this is the token for the next set of results.
|
|
10239
|
+
*/
|
|
10240
|
+
NextToken?: NextToken2500;
|
|
10241
|
+
/**
|
|
10242
|
+
* The total number of agent statuses which matched your search query.
|
|
10243
|
+
*/
|
|
10244
|
+
ApproximateTotalCount?: ApproximateTotalCount;
|
|
10245
|
+
}
|
|
9368
10246
|
export interface SearchAvailablePhoneNumbersRequest {
|
|
9369
10247
|
/**
|
|
9370
10248
|
* The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId or TargetArn.
|
|
@@ -9405,6 +10283,78 @@ declare namespace Connect {
|
|
|
9405
10283
|
*/
|
|
9406
10284
|
AvailableNumbersList?: AvailableNumbersList;
|
|
9407
10285
|
}
|
|
10286
|
+
export interface SearchContactFlowModulesRequest {
|
|
10287
|
+
/**
|
|
10288
|
+
* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
|
|
10289
|
+
*/
|
|
10290
|
+
InstanceId: InstanceId;
|
|
10291
|
+
/**
|
|
10292
|
+
* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
|
|
10293
|
+
*/
|
|
10294
|
+
NextToken?: NextToken2500;
|
|
10295
|
+
/**
|
|
10296
|
+
* The maximum number of results to return per page.
|
|
10297
|
+
*/
|
|
10298
|
+
MaxResults?: MaxResult100;
|
|
10299
|
+
/**
|
|
10300
|
+
* Filters to be applied to search results.
|
|
10301
|
+
*/
|
|
10302
|
+
SearchFilter?: ContactFlowModuleSearchFilter;
|
|
10303
|
+
/**
|
|
10304
|
+
* The search criteria to be used to return contact flow modules. The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in invalid results.
|
|
10305
|
+
*/
|
|
10306
|
+
SearchCriteria?: ContactFlowModuleSearchCriteria;
|
|
10307
|
+
}
|
|
10308
|
+
export interface SearchContactFlowModulesResponse {
|
|
10309
|
+
/**
|
|
10310
|
+
* The search criteria to be used to return contact flow modules.
|
|
10311
|
+
*/
|
|
10312
|
+
ContactFlowModules?: ContactFlowModuleSearchSummaryList;
|
|
10313
|
+
/**
|
|
10314
|
+
* If there are additional results, this is the token for the next set of results.
|
|
10315
|
+
*/
|
|
10316
|
+
NextToken?: NextToken2500;
|
|
10317
|
+
/**
|
|
10318
|
+
* The total number of contact flows which matched your search query.
|
|
10319
|
+
*/
|
|
10320
|
+
ApproximateTotalCount?: ApproximateTotalCount;
|
|
10321
|
+
}
|
|
10322
|
+
export interface SearchContactFlowsRequest {
|
|
10323
|
+
/**
|
|
10324
|
+
* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
|
|
10325
|
+
*/
|
|
10326
|
+
InstanceId: InstanceId;
|
|
10327
|
+
/**
|
|
10328
|
+
* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
|
|
10329
|
+
*/
|
|
10330
|
+
NextToken?: NextToken2500;
|
|
10331
|
+
/**
|
|
10332
|
+
* The maximum number of results to return per page.
|
|
10333
|
+
*/
|
|
10334
|
+
MaxResults?: MaxResult100;
|
|
10335
|
+
/**
|
|
10336
|
+
* Filters to be applied to search results.
|
|
10337
|
+
*/
|
|
10338
|
+
SearchFilter?: ContactFlowSearchFilter;
|
|
10339
|
+
/**
|
|
10340
|
+
* The search criteria to be used to return flows. The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in invalid results.
|
|
10341
|
+
*/
|
|
10342
|
+
SearchCriteria?: ContactFlowSearchCriteria;
|
|
10343
|
+
}
|
|
10344
|
+
export interface SearchContactFlowsResponse {
|
|
10345
|
+
/**
|
|
10346
|
+
* Information about the flows.
|
|
10347
|
+
*/
|
|
10348
|
+
ContactFlows?: ContactFlowSearchSummaryList;
|
|
10349
|
+
/**
|
|
10350
|
+
* If there are additional results, this is the token for the next set of results.
|
|
10351
|
+
*/
|
|
10352
|
+
NextToken?: NextToken2500;
|
|
10353
|
+
/**
|
|
10354
|
+
* The total number of contact flows which matched your search query.
|
|
10355
|
+
*/
|
|
10356
|
+
ApproximateTotalCount?: ApproximateTotalCount;
|
|
10357
|
+
}
|
|
9408
10358
|
export type SearchContactsMatchType = "MATCH_ALL"|"MATCH_ANY"|string;
|
|
9409
10359
|
export interface SearchContactsRequest {
|
|
9410
10360
|
/**
|
|
@@ -9487,7 +10437,7 @@ declare namespace Connect {
|
|
|
9487
10437
|
*/
|
|
9488
10438
|
QueueIds?: QueueIdList;
|
|
9489
10439
|
/**
|
|
9490
|
-
* The search criteria based on user-defined contact attributes that have been configured for contact search. For more information, see Search by
|
|
10440
|
+
* The search criteria based on user-defined contact attributes that have been configured for contact search. For more information, see Search by custom contact attributes in the Amazon Connect Administrator Guide. To use SearchableContactAttributes in a search request, the GetContactAttributes action is required to perform an API request. For more information, see https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissionsActions defined by Amazon Connect.
|
|
9491
10441
|
*/
|
|
9492
10442
|
SearchableContactAttributes?: SearchableContactAttributes;
|
|
9493
10443
|
}
|
|
@@ -9673,7 +10623,7 @@ declare namespace Connect {
|
|
|
9673
10623
|
*/
|
|
9674
10624
|
InstanceId: InstanceIdOrArn;
|
|
9675
10625
|
/**
|
|
9676
|
-
* The list of resource types to be used to search tags from. If not provided or if any empty list is provided, this API will search from all supported resource types.
|
|
10626
|
+
* The list of resource types to be used to search tags from. If not provided or if any empty list is provided, this API will search from all supported resource types. Supported resource types AGENT ROUTING_PROFILE STANDARD_QUEUE SECURITY_PROFILE OPERATING_HOURS PROMPT CONTACT_FLOW FLOW_MODULE
|
|
9677
10627
|
*/
|
|
9678
10628
|
ResourceTypes?: ResourceTypeList;
|
|
9679
10629
|
/**
|
|
@@ -9773,6 +10723,42 @@ declare namespace Connect {
|
|
|
9773
10723
|
}
|
|
9774
10724
|
export type SearchText = string;
|
|
9775
10725
|
export type SearchTextList = SearchText[];
|
|
10726
|
+
export interface SearchUserHierarchyGroupsRequest {
|
|
10727
|
+
/**
|
|
10728
|
+
* The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
|
|
10729
|
+
*/
|
|
10730
|
+
InstanceId: InstanceId;
|
|
10731
|
+
/**
|
|
10732
|
+
* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
|
|
10733
|
+
*/
|
|
10734
|
+
NextToken?: NextToken2500;
|
|
10735
|
+
/**
|
|
10736
|
+
* The maximum number of results to return per page.
|
|
10737
|
+
*/
|
|
10738
|
+
MaxResults?: MaxResult100;
|
|
10739
|
+
/**
|
|
10740
|
+
* Filters to be applied to search results.
|
|
10741
|
+
*/
|
|
10742
|
+
SearchFilter?: UserHierarchyGroupSearchFilter;
|
|
10743
|
+
/**
|
|
10744
|
+
* The search criteria to be used to return UserHierarchyGroups.
|
|
10745
|
+
*/
|
|
10746
|
+
SearchCriteria?: UserHierarchyGroupSearchCriteria;
|
|
10747
|
+
}
|
|
10748
|
+
export interface SearchUserHierarchyGroupsResponse {
|
|
10749
|
+
/**
|
|
10750
|
+
* Information about the userHierarchyGroups.
|
|
10751
|
+
*/
|
|
10752
|
+
UserHierarchyGroups?: UserHierarchyGroupList;
|
|
10753
|
+
/**
|
|
10754
|
+
* If there are additional results, this is the token for the next set of results.
|
|
10755
|
+
*/
|
|
10756
|
+
NextToken?: NextToken2500;
|
|
10757
|
+
/**
|
|
10758
|
+
* The total number of userHierarchyGroups which matched your search query.
|
|
10759
|
+
*/
|
|
10760
|
+
ApproximateTotalCount?: ApproximateTotalCount;
|
|
10761
|
+
}
|
|
9776
10762
|
export interface SearchUsersRequest {
|
|
9777
10763
|
/**
|
|
9778
10764
|
* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. InstanceID is a required field. The "Required: No" below is incorrect.
|
|
@@ -10118,6 +11104,70 @@ declare namespace Connect {
|
|
|
10118
11104
|
export type SourceApplicationName = string;
|
|
10119
11105
|
export type SourceId = string;
|
|
10120
11106
|
export type SourceType = "SALESFORCE"|"ZENDESK"|"CASES"|string;
|
|
11107
|
+
export interface StartAttachedFileUploadRequest {
|
|
11108
|
+
/**
|
|
11109
|
+
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
|
|
11110
|
+
*/
|
|
11111
|
+
ClientToken?: ClientToken;
|
|
11112
|
+
/**
|
|
11113
|
+
* The unique identifier of the Amazon Connect instance.
|
|
11114
|
+
*/
|
|
11115
|
+
InstanceId: InstanceId;
|
|
11116
|
+
/**
|
|
11117
|
+
* A case-sensitive name of the attached file being uploaded.
|
|
11118
|
+
*/
|
|
11119
|
+
FileName: FileName;
|
|
11120
|
+
/**
|
|
11121
|
+
* The size of the attached file in bytes.
|
|
11122
|
+
*/
|
|
11123
|
+
FileSizeInBytes: FileSizeInBytes;
|
|
11124
|
+
/**
|
|
11125
|
+
* Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.
|
|
11126
|
+
*/
|
|
11127
|
+
UrlExpiryInSeconds?: URLExpiryInSeconds;
|
|
11128
|
+
/**
|
|
11129
|
+
* The use case for the file.
|
|
11130
|
+
*/
|
|
11131
|
+
FileUseCaseType: FileUseCaseType;
|
|
11132
|
+
/**
|
|
11133
|
+
* The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource. This value must be a valid ARN.
|
|
11134
|
+
*/
|
|
11135
|
+
AssociatedResourceArn: ARN;
|
|
11136
|
+
/**
|
|
11137
|
+
* Represents the identity that created the file.
|
|
11138
|
+
*/
|
|
11139
|
+
CreatedBy?: CreatedByInfo;
|
|
11140
|
+
/**
|
|
11141
|
+
* The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
|
|
11142
|
+
*/
|
|
11143
|
+
Tags?: TagMap;
|
|
11144
|
+
}
|
|
11145
|
+
export interface StartAttachedFileUploadResponse {
|
|
11146
|
+
/**
|
|
11147
|
+
* The unique identifier of the attached file resource (ARN).
|
|
11148
|
+
*/
|
|
11149
|
+
FileArn?: ARN;
|
|
11150
|
+
/**
|
|
11151
|
+
* The unique identifier of the attached file resource.
|
|
11152
|
+
*/
|
|
11153
|
+
FileId?: FileId;
|
|
11154
|
+
/**
|
|
11155
|
+
* The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.
|
|
11156
|
+
*/
|
|
11157
|
+
CreationTime?: ISO8601Datetime;
|
|
11158
|
+
/**
|
|
11159
|
+
* The current status of the attached file.
|
|
11160
|
+
*/
|
|
11161
|
+
FileStatus?: FileStatusType;
|
|
11162
|
+
/**
|
|
11163
|
+
* Represents the identity that created the file.
|
|
11164
|
+
*/
|
|
11165
|
+
CreatedBy?: CreatedByInfo;
|
|
11166
|
+
/**
|
|
11167
|
+
* Information to be used while uploading the attached file.
|
|
11168
|
+
*/
|
|
11169
|
+
UploadUrlMetadata?: UploadUrlMetadata;
|
|
11170
|
+
}
|
|
10121
11171
|
export interface StartChatContactRequest {
|
|
10122
11172
|
/**
|
|
10123
11173
|
* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
|
|
@@ -10384,7 +11434,7 @@ declare namespace Connect {
|
|
|
10384
11434
|
*/
|
|
10385
11435
|
ClientToken?: ClientToken;
|
|
10386
11436
|
/**
|
|
10387
|
-
* The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing,
|
|
11437
|
+
* The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold: arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
|
|
10388
11438
|
*/
|
|
10389
11439
|
ContactFlowId: ContactFlowId;
|
|
10390
11440
|
/**
|
|
@@ -10428,6 +11478,21 @@ declare namespace Connect {
|
|
|
10428
11478
|
ParticipantToken?: ParticipantToken;
|
|
10429
11479
|
}
|
|
10430
11480
|
export type Statistic = "SUM"|"MAX"|"AVG"|string;
|
|
11481
|
+
export interface Step {
|
|
11482
|
+
/**
|
|
11483
|
+
* An object to specify the expiration of a routing step.
|
|
11484
|
+
*/
|
|
11485
|
+
Expiry?: Expiry;
|
|
11486
|
+
/**
|
|
11487
|
+
* A tagged union to specify expression for a routing step.
|
|
11488
|
+
*/
|
|
11489
|
+
Expression?: Expression;
|
|
11490
|
+
/**
|
|
11491
|
+
* Represents status of the Routing step.
|
|
11492
|
+
*/
|
|
11493
|
+
Status?: RoutingCriteriaStepStatus;
|
|
11494
|
+
}
|
|
11495
|
+
export type Steps = Step[];
|
|
10431
11496
|
export interface StopContactRecordingRequest {
|
|
10432
11497
|
/**
|
|
10433
11498
|
* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
|
|
@@ -10644,6 +11709,7 @@ declare namespace Connect {
|
|
|
10644
11709
|
export type TagValue = string;
|
|
10645
11710
|
export type TagValueString = string;
|
|
10646
11711
|
export type TagsList = TagSet[];
|
|
11712
|
+
export type TargetListType = "PROFICIENCIES"|string;
|
|
10647
11713
|
export interface TaskActionDefinition {
|
|
10648
11714
|
/**
|
|
10649
11715
|
* The name. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.
|
|
@@ -10781,7 +11847,7 @@ declare namespace Connect {
|
|
|
10781
11847
|
export type ThresholdCollections = ThresholdV2[];
|
|
10782
11848
|
export interface ThresholdV2 {
|
|
10783
11849
|
/**
|
|
10784
|
-
* The type of comparison. Only "less than" (LT) comparisons are supported.
|
|
11850
|
+
* The type of comparison. Only "less than" (LT) and "greater than" (GT) comparisons are supported.
|
|
10785
11851
|
*/
|
|
10786
11852
|
Comparison?: ResourceArnOrId;
|
|
10787
11853
|
/**
|
|
@@ -10931,6 +11997,7 @@ declare namespace Connect {
|
|
|
10931
11997
|
ContactArn?: ARN;
|
|
10932
11998
|
}
|
|
10933
11999
|
export type URI = string;
|
|
12000
|
+
export type URLExpiryInSeconds = number;
|
|
10934
12001
|
export type Unit = "SECONDS"|"COUNT"|"PERCENT"|string;
|
|
10935
12002
|
export interface UntagContactRequest {
|
|
10936
12003
|
/**
|
|
@@ -10989,6 +12056,36 @@ declare namespace Connect {
|
|
|
10989
12056
|
*/
|
|
10990
12057
|
ResetOrderNumber?: Boolean;
|
|
10991
12058
|
}
|
|
12059
|
+
export interface UpdateAuthenticationProfileRequest {
|
|
12060
|
+
/**
|
|
12061
|
+
* A unique identifier for the authentication profile.
|
|
12062
|
+
*/
|
|
12063
|
+
AuthenticationProfileId: AuthenticationProfileId;
|
|
12064
|
+
/**
|
|
12065
|
+
* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
|
|
12066
|
+
*/
|
|
12067
|
+
InstanceId: InstanceId;
|
|
12068
|
+
/**
|
|
12069
|
+
* The name for the authentication profile.
|
|
12070
|
+
*/
|
|
12071
|
+
Name?: AuthenticationProfileName;
|
|
12072
|
+
/**
|
|
12073
|
+
* The description for the authentication profile.
|
|
12074
|
+
*/
|
|
12075
|
+
Description?: AuthenticationProfileDescription;
|
|
12076
|
+
/**
|
|
12077
|
+
* A list of IP address range strings that are allowed to access the instance. For more information on how to configure IP addresses, seeConfigure session timeouts in the Amazon Connect Administrator Guide.
|
|
12078
|
+
*/
|
|
12079
|
+
AllowedIps?: IpCidrList;
|
|
12080
|
+
/**
|
|
12081
|
+
* A list of IP address range strings that are blocked from accessing the instance. For more information on how to configure IP addresses, For more information on how to configure IP addresses, see Configure IP-based access control in the Amazon Connect Administrator Guide.
|
|
12082
|
+
*/
|
|
12083
|
+
BlockedIps?: IpCidrList;
|
|
12084
|
+
/**
|
|
12085
|
+
* The short lived session duration configuration for users logged in to Amazon Connect, in minutes. This value determines the maximum possible time before an agent is authenticated. For more information, For more information on how to configure IP addresses, see Configure session timeouts in the Amazon Connect Administrator Guide.
|
|
12086
|
+
*/
|
|
12087
|
+
PeriodicSessionDuration?: AccessTokenDuration;
|
|
12088
|
+
}
|
|
10992
12089
|
export interface UpdateCaseActionDefinition {
|
|
10993
12090
|
/**
|
|
10994
12091
|
* An array of objects with Field ID and Value data.
|
|
@@ -11005,7 +12102,7 @@ declare namespace Connect {
|
|
|
11005
12102
|
*/
|
|
11006
12103
|
InstanceId: InstanceId;
|
|
11007
12104
|
/**
|
|
11008
|
-
* The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact attributes. You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
|
|
12105
|
+
* The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact attributes. You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters. When the attributes for a contact exceed 32 KB, the contact is routed down the Error branch of the flow. As a mitigation, consider the following options: Remove unnecessary attributes by setting their values to empty. If the attributes are only used in one flow and don't need to be referred to outside of that flow (for example, by a Lambda or another flow), then use flow attributes. This way you aren't needlessly persisting the 32 KB of information from one flow to another. For more information, see Flow block: Set contact attributes in the Amazon Connect Administrator Guide.
|
|
11009
12106
|
*/
|
|
11010
12107
|
Attributes: Attributes;
|
|
11011
12108
|
}
|
|
@@ -11180,6 +12277,10 @@ declare namespace Connect {
|
|
|
11180
12277
|
* Priority of the contact in the queue. The default priority for new contacts is 5. You can raise the priority of a contact compared to other contacts in the queue by assigning them a higher priority, such as 1 or 2.
|
|
11181
12278
|
*/
|
|
11182
12279
|
QueuePriority?: QueuePriority;
|
|
12280
|
+
/**
|
|
12281
|
+
* Updates the routing criteria on the contact. These properties can be used to change how a
 contact is routed within the queue.
|
|
12282
|
+
*/
|
|
12283
|
+
RoutingCriteria?: RoutingCriteriaInput;
|
|
11183
12284
|
}
|
|
11184
12285
|
export interface UpdateContactRoutingDataResponse {
|
|
11185
12286
|
}
|
|
@@ -11922,7 +13023,24 @@ declare namespace Connect {
|
|
|
11922
13023
|
}
|
|
11923
13024
|
export interface UpdateViewMetadataResponse {
|
|
11924
13025
|
}
|
|
13026
|
+
export interface UploadUrlMetadata {
|
|
13027
|
+
/**
|
|
13028
|
+
* A pre-signed S3 URL that should be used for uploading the attached file.
|
|
13029
|
+
*/
|
|
13030
|
+
Url?: MetadataUrl;
|
|
13031
|
+
/**
|
|
13032
|
+
* The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
|
|
13033
|
+
*/
|
|
13034
|
+
UrlExpiry?: ISO8601Datetime;
|
|
13035
|
+
/**
|
|
13036
|
+
* A map of headers that should be provided when uploading the attached file.
|
|
13037
|
+
*/
|
|
13038
|
+
HeadersToInclude?: UrlMetadataSignedHeaders;
|
|
13039
|
+
}
|
|
11925
13040
|
export type Url = string;
|
|
13041
|
+
export type UrlMetadataSignedHeaders = {[key: string]: UrlMetadataSignedHeadersValue};
|
|
13042
|
+
export type UrlMetadataSignedHeadersKey = string;
|
|
13043
|
+
export type UrlMetadataSignedHeadersValue = string;
|
|
11926
13044
|
export interface UrlReference {
|
|
11927
13045
|
/**
|
|
11928
13046
|
* Identifier of the URL reference.
|
|
@@ -12062,6 +13180,28 @@ declare namespace Connect {
|
|
|
12062
13180
|
}
|
|
12063
13181
|
export type UserDataHierarchyGroups = HierarchyGroupId[];
|
|
12064
13182
|
export type UserDataList = UserData[];
|
|
13183
|
+
export type UserHierarchyGroupList = HierarchyGroup[];
|
|
13184
|
+
export type UserHierarchyGroupSearchConditionList = UserHierarchyGroupSearchCriteria[];
|
|
13185
|
+
export interface UserHierarchyGroupSearchCriteria {
|
|
13186
|
+
/**
|
|
13187
|
+
* A list of conditions which would be applied together with an OR condition.
|
|
13188
|
+
*/
|
|
13189
|
+
OrConditions?: UserHierarchyGroupSearchConditionList;
|
|
13190
|
+
/**
|
|
13191
|
+
* A list of conditions which would be applied together with an AND condition.
|
|
13192
|
+
*/
|
|
13193
|
+
AndConditions?: UserHierarchyGroupSearchConditionList;
|
|
13194
|
+
/**
|
|
13195
|
+
* A leaf node condition which can be used to specify a string condition. The currently supported values for FieldName are name,

 parentId, levelId, and resourceID.
|
|
13196
|
+
*/
|
|
13197
|
+
StringCondition?: StringCondition;
|
|
13198
|
+
}
|
|
13199
|
+
export interface UserHierarchyGroupSearchFilter {
|
|
13200
|
+
/**
|
|
13201
|
+
* An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR or AND (List of List) input where: The top level list specifies conditions that need to be applied with OR operator. The inner list specifies conditions that need to be applied with AND operator.
|
|
13202
|
+
*/
|
|
13203
|
+
AttributeFilter?: ControlPlaneAttributeFilter;
|
|
13204
|
+
}
|
|
12065
13205
|
export type UserId = string;
|
|
12066
13206
|
export type UserIdList = UserId[];
|
|
12067
13207
|
export interface UserIdentityInfo {
|
|
@@ -12174,6 +13314,10 @@ declare namespace Connect {
|
|
|
12174
13314
|
* A leaf node condition which can be used to specify a string condition. The currently supported values for FieldName are Username, FirstName, LastName, RoutingProfileId, SecurityProfileId, ResourceId.
|
|
12175
13315
|
*/
|
|
12176
13316
|
StringCondition?: StringCondition;
|
|
13317
|
+
/**
|
|
13318
|
+
* A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.
|
|
13319
|
+
*/
|
|
13320
|
+
ListCondition?: ListCondition;
|
|
12177
13321
|
/**
|
|
12178
13322
|
* A leaf node condition which can be used to specify a hierarchy group condition.
|
|
12179
13323
|
*/
|