aws-sdk-connect 1.164.0 → 1.166.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -396,6 +396,22 @@ module Aws::Connect
396
396
  include Aws::Structure
397
397
  end
398
398
 
399
+ # Can be used to define a list of preferred agents to target the contact
400
+ # within the queue. Note that agents must have the queue in their
401
+ # routing profile in order to be offered the contact.
402
+ #
403
+ # @!attribute [rw] agent_ids
404
+ # An object to specify a list of agents, by Agent ID.
405
+ # @return [Array<String>]
406
+ #
407
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AgentsCriteria AWS API Documentation
408
+ #
409
+ class AgentsCriteria < Struct.new(
410
+ :agent_ids)
411
+ SENSITIVE = []
412
+ include Aws::Structure
413
+ end
414
+
399
415
  # Information about the capabilities enabled for participants of the
400
416
  # contact.
401
417
  #
@@ -1162,6 +1178,10 @@ module Aws::Connect
1162
1178
  # The proficiency level of the condition.
1163
1179
  # @return [Float]
1164
1180
  #
1181
+ # @!attribute [rw] match_criteria
1182
+ # An object to define `AgentsCriteria`.
1183
+ # @return [Types::MatchCriteria]
1184
+ #
1165
1185
  # @!attribute [rw] comparison_operator
1166
1186
  # The operator of the condition.
1167
1187
  # @return [String]
@@ -1172,6 +1192,7 @@ module Aws::Connect
1172
1192
  :name,
1173
1193
  :value,
1174
1194
  :proficiency_level,
1195
+ :match_criteria,
1175
1196
  :comparison_operator)
1176
1197
  SENSITIVE = []
1177
1198
  include Aws::Structure
@@ -1217,6 +1238,169 @@ module Aws::Connect
1217
1238
  include Aws::Structure
1218
1239
  end
1219
1240
 
1241
+ # This API is in preview release for Amazon Connect and is subject to
1242
+ # change. To request access to this API, contact Amazon Web Services
1243
+ # Support.
1244
+ #
1245
+ # Information about an authentication profile. An authentication profile
1246
+ # is a resource that stores the authentication settings for users in
1247
+ # your contact center. You use authentication profiles to set up IP
1248
+ # address range restrictions and session timeouts. For more information,
1249
+ # see [Set IP address restrictions or session timeouts][1].
1250
+ #
1251
+ #
1252
+ #
1253
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html
1254
+ #
1255
+ # @!attribute [rw] id
1256
+ # A unique identifier for the authentication profile.
1257
+ # @return [String]
1258
+ #
1259
+ # @!attribute [rw] arn
1260
+ # The Amazon Resource Name (ARN) for the authentication profile.
1261
+ # @return [String]
1262
+ #
1263
+ # @!attribute [rw] name
1264
+ # The name for the authentication profile.
1265
+ # @return [String]
1266
+ #
1267
+ # @!attribute [rw] description
1268
+ # The description for the authentication profile.
1269
+ # @return [String]
1270
+ #
1271
+ # @!attribute [rw] allowed_ips
1272
+ # A list of IP address range strings that are allowed to access the
1273
+ # Amazon Connect instance. For more information about how to configure
1274
+ # IP addresses, see [Configure IP address based access control][1] in
1275
+ # the *Amazon Connect Administrator Guide*.
1276
+ #
1277
+ #
1278
+ #
1279
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-ip-based-ac
1280
+ # @return [Array<String>]
1281
+ #
1282
+ # @!attribute [rw] blocked_ips
1283
+ # A list of IP address range strings that are blocked from accessing
1284
+ # the Amazon Connect instance. For more information about how to
1285
+ # configure IP addresses, see [Configure IP address based access
1286
+ # control][1] in the *Amazon Connect Administrator Guide*.
1287
+ #
1288
+ #
1289
+ #
1290
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-ip-based-ac
1291
+ # @return [Array<String>]
1292
+ #
1293
+ # @!attribute [rw] is_default
1294
+ # Shows whether the authentication profile is the default
1295
+ # authentication profile for the Amazon Connect instance. The default
1296
+ # authentication profile applies to all agents in an Amazon Connect
1297
+ # instance, unless overridden by another authentication profile.
1298
+ # @return [Boolean]
1299
+ #
1300
+ # @!attribute [rw] created_time
1301
+ # The timestamp when the authentication profile was created.
1302
+ # @return [Time]
1303
+ #
1304
+ # @!attribute [rw] last_modified_time
1305
+ # The timestamp when the authentication profile was last modified.
1306
+ # @return [Time]
1307
+ #
1308
+ # @!attribute [rw] last_modified_region
1309
+ # The Amazon Web Services Region where the authentication profile was
1310
+ # last modified.
1311
+ # @return [String]
1312
+ #
1313
+ # @!attribute [rw] periodic_session_duration
1314
+ # The short lived session duration configuration for users logged in
1315
+ # to Amazon Connect, in minutes. This value determines the maximum
1316
+ # possible time before an agent is authenticated. For more
1317
+ # information, see [Configure the session duration][1] in the *Amazon
1318
+ # Connect Administrator Guide*.
1319
+ #
1320
+ #
1321
+ #
1322
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts
1323
+ # @return [Integer]
1324
+ #
1325
+ # @!attribute [rw] max_session_duration
1326
+ # The long lived session duration for users logged in to Amazon
1327
+ # Connect, in minutes. After this time period, users must log in
1328
+ # again. For more information, see [Configure the session duration][1]
1329
+ # in the *Amazon Connect Administrator Guide*.
1330
+ #
1331
+ #
1332
+ #
1333
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts
1334
+ # @return [Integer]
1335
+ #
1336
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AuthenticationProfile AWS API Documentation
1337
+ #
1338
+ class AuthenticationProfile < Struct.new(
1339
+ :id,
1340
+ :arn,
1341
+ :name,
1342
+ :description,
1343
+ :allowed_ips,
1344
+ :blocked_ips,
1345
+ :is_default,
1346
+ :created_time,
1347
+ :last_modified_time,
1348
+ :last_modified_region,
1349
+ :periodic_session_duration,
1350
+ :max_session_duration)
1351
+ SENSITIVE = []
1352
+ include Aws::Structure
1353
+ end
1354
+
1355
+ # This API is in preview release for Amazon Connect and is subject to
1356
+ # change. To request access to this API, contact Amazon Web Services
1357
+ # Support.
1358
+ #
1359
+ # A summary of a given authentication profile.
1360
+ #
1361
+ # @!attribute [rw] id
1362
+ # The unique identifier of the authentication profile.
1363
+ # @return [String]
1364
+ #
1365
+ # @!attribute [rw] arn
1366
+ # The Amazon Resource Name (ARN) of the authentication profile
1367
+ # summary.
1368
+ # @return [String]
1369
+ #
1370
+ # @!attribute [rw] name
1371
+ # The name of the authentication profile summary.
1372
+ # @return [String]
1373
+ #
1374
+ # @!attribute [rw] is_default
1375
+ # Shows whether the authentication profile is the default
1376
+ # authentication profile for the Amazon Connect instance. The default
1377
+ # authentication profile applies to all agents in an Amazon Connect
1378
+ # instance, unless overridden by another authentication profile.
1379
+ # @return [Boolean]
1380
+ #
1381
+ # @!attribute [rw] last_modified_time
1382
+ # The timestamp when the authentication profile summary was last
1383
+ # modified.
1384
+ # @return [Time]
1385
+ #
1386
+ # @!attribute [rw] last_modified_region
1387
+ # The Amazon Web Services Region when the authentication profile
1388
+ # summary was last modified.
1389
+ # @return [String]
1390
+ #
1391
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AuthenticationProfileSummary AWS API Documentation
1392
+ #
1393
+ class AuthenticationProfileSummary < Struct.new(
1394
+ :id,
1395
+ :arn,
1396
+ :name,
1397
+ :is_default,
1398
+ :last_modified_time,
1399
+ :last_modified_region)
1400
+ SENSITIVE = []
1401
+ include Aws::Structure
1402
+ end
1403
+
1220
1404
  # Information about available phone numbers.
1221
1405
  #
1222
1406
  # @!attribute [rw] phone_number
@@ -1809,7 +1993,7 @@ module Aws::Connect
1809
1993
  # Request to CompleteAttachedFileUpload API
1810
1994
  #
1811
1995
  # @!attribute [rw] instance_id
1812
- # The unique identifier of the Connect instance.
1996
+ # The unique identifier of the Amazon Connect instance.
1813
1997
  # @return [String]
1814
1998
  #
1815
1999
  # @!attribute [rw] file_id
@@ -5358,6 +5542,40 @@ module Aws::Connect
5358
5542
  include Aws::Structure
5359
5543
  end
5360
5544
 
5545
+ # @!attribute [rw] authentication_profile_id
5546
+ # A unique identifier for the authentication profile.
5547
+ # @return [String]
5548
+ #
5549
+ # @!attribute [rw] instance_id
5550
+ # The identifier of the Amazon Connect instance. You can [find the
5551
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
5552
+ #
5553
+ #
5554
+ #
5555
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
5556
+ # @return [String]
5557
+ #
5558
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeAuthenticationProfileRequest AWS API Documentation
5559
+ #
5560
+ class DescribeAuthenticationProfileRequest < Struct.new(
5561
+ :authentication_profile_id,
5562
+ :instance_id)
5563
+ SENSITIVE = []
5564
+ include Aws::Structure
5565
+ end
5566
+
5567
+ # @!attribute [rw] authentication_profile
5568
+ # The authentication profile object being described.
5569
+ # @return [Types::AuthenticationProfile]
5570
+ #
5571
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeAuthenticationProfileResponse AWS API Documentation
5572
+ #
5573
+ class DescribeAuthenticationProfileResponse < Struct.new(
5574
+ :authentication_profile)
5575
+ SENSITIVE = []
5576
+ include Aws::Structure
5577
+ end
5578
+
5361
5579
  # @!attribute [rw] instance_id
5362
5580
  # The identifier of the Amazon Connect instance. You can [find the
5363
5581
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -7731,7 +7949,7 @@ module Aws::Connect
7731
7949
  # @return [Boolean]
7732
7950
  #
7733
7951
  # @!attribute [rw] double_value
7734
- # a Double number value type.
7952
+ # A Double number value type.
7735
7953
  # @return [Float]
7736
7954
  #
7737
7955
  # @!attribute [rw] empty_value
@@ -9248,49 +9466,6 @@ module Aws::Connect
9248
9466
  #
9249
9467
  # UI name: [Cases created][37]
9250
9468
  #
9251
- # CONTACTS\_ABANDONED
9252
- #
9253
- # : Unit: Count
9254
- #
9255
- # Metric filter:
9256
- #
9257
- # * Valid values: `API`\| `Incoming` \| `Outbound` \| `Transfer` \|
9258
- # `Callback` \| `Queue_Transfer`\| `Disconnect`
9259
- #
9260
- # ^
9261
- #
9262
- # Valid groupings and filters: Queue, Channel, Routing Profile,
9263
- # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
9264
- # RoutingStepExpression, Q in Connect
9265
- #
9266
- # UI name: [Contact abandoned][38]
9267
- #
9268
- # CONTACTS\_ABANDONED\_IN\_X
9269
- #
9270
- # : Unit: Count
9271
- #
9272
- # Valid groupings and filters: Queue, Channel, Routing Profile,
9273
- # contact/segmentAttributes/connect:Subtype, Q in Connect
9274
- #
9275
- # Threshold: For `ThresholdValue`, enter any whole number from 1 to
9276
- # 604800 (inclusive), in seconds. For `Comparison`, you must enter
9277
- # `LT` (for "Less than").
9278
- #
9279
- # UI name: [Contacts abandoned in X seconds][39]
9280
- #
9281
- # CONTACTS\_ANSWERED\_IN\_X
9282
- #
9283
- # : Unit: Count
9284
- #
9285
- # Valid groupings and filters: Queue, Channel, Routing Profile,
9286
- # contact/segmentAttributes/connect:Subtype, Q in Connect
9287
- #
9288
- # Threshold: For `ThresholdValue`, enter any whole number from 1 to
9289
- # 604800 (inclusive), in seconds. For `Comparison`, you must enter
9290
- # `LT` (for "Less than").
9291
- #
9292
- # UI name: [Contacts answered in X seconds][40]
9293
- #
9294
9469
  # CONTACTS\_CREATED
9295
9470
  #
9296
9471
  # : Unit: Count
@@ -9300,7 +9475,7 @@ module Aws::Connect
9300
9475
  # Valid groupings and filters: Queue, Channel, Routing Profile,
9301
9476
  # Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
9302
9477
  #
9303
- # UI name: [Contacts created][41]
9478
+ # UI name: [Contacts created][38]
9304
9479
  #
9305
9480
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
9306
9481
  #
@@ -9317,7 +9492,7 @@ module Aws::Connect
9317
9492
  # contact/segmentAttributes/connect:Subtype, RoutingStepExpression,
9318
9493
  # Q in Connect
9319
9494
  #
9320
- # UI name: [API contacts handled][42]
9495
+ # UI name: [API contacts handled][39]
9321
9496
  #
9322
9497
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
9323
9498
  #
@@ -9332,7 +9507,7 @@ module Aws::Connect
9332
9507
  # Valid groupings and filters: Queue, Channel, Agent, Agent
9333
9508
  # Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
9334
9509
  #
9335
- # UI name: [Contacts handled (connected to agent timestamp)][43]
9510
+ # UI name: [Contacts handled (connected to agent timestamp)][40]
9336
9511
  #
9337
9512
  # CONTACTS\_HOLD\_ABANDONS
9338
9513
  #
@@ -9342,7 +9517,7 @@ module Aws::Connect
9342
9517
  # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
9343
9518
  # Q in Connect
9344
9519
  #
9345
- # UI name: [Contacts hold disconnect][43]
9520
+ # UI name: [Contacts hold disconnect][40]
9346
9521
  #
9347
9522
  # CONTACTS\_ON\_HOLD\_AGENT\_DISCONNECT
9348
9523
  #
@@ -9351,7 +9526,7 @@ module Aws::Connect
9351
9526
  # Valid groupings and filters: Queue, Channel, Routing Profile,
9352
9527
  # Agent, Agent Hierarchy, Q in Connect
9353
9528
  #
9354
- # UI name: [Contacts hold agent disconnect][44]
9529
+ # UI name: [Contacts hold agent disconnect][41]
9355
9530
  #
9356
9531
  # CONTACTS\_ON\_HOLD\_CUSTOMER\_DISCONNECT
9357
9532
  #
@@ -9360,7 +9535,7 @@ module Aws::Connect
9360
9535
  # Valid groupings and filters: Queue, Channel, Routing Profile,
9361
9536
  # Agent, Agent Hierarchy, Q in Connect
9362
9537
  #
9363
- # UI name: [Contacts hold customer disconnect][45]
9538
+ # UI name: [Contacts hold customer disconnect][42]
9364
9539
  #
9365
9540
  # CONTACTS\_PUT\_ON\_HOLD
9366
9541
  #
@@ -9369,7 +9544,7 @@ module Aws::Connect
9369
9544
  # Valid groupings and filters: Queue, Channel, Routing Profile,
9370
9545
  # Agent, Agent Hierarchy, Q in Connect
9371
9546
  #
9372
- # UI name: [Contacts put on hold][45]
9547
+ # UI name: [Contacts put on hold][42]
9373
9548
  #
9374
9549
  # CONTACTS\_TRANSFERRED\_OUT\_EXTERNAL
9375
9550
  #
@@ -9378,7 +9553,7 @@ module Aws::Connect
9378
9553
  # Valid groupings and filters: Queue, Channel, Routing Profile,
9379
9554
  # Agent, Agent Hierarchy, Q in Connect
9380
9555
  #
9381
- # UI name: [Contacts transferred out external][46]
9556
+ # UI name: [Contacts transferred out external][43]
9382
9557
  #
9383
9558
  # CONTACTS\_TRANSFERRED\_OUT\_INTERNAL
9384
9559
  #
@@ -9387,7 +9562,7 @@ module Aws::Connect
9387
9562
  # Valid groupings and filters: Queue, Channel, Routing Profile,
9388
9563
  # Agent, Agent Hierarchy, Q in Connect
9389
9564
  #
9390
- # UI name: [Contacts transferred out internal][47]
9565
+ # UI name: [Contacts transferred out internal][44]
9391
9566
  #
9392
9567
  # CONTACTS\_QUEUED
9393
9568
  #
@@ -9397,7 +9572,7 @@ module Aws::Connect
9397
9572
  # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
9398
9573
  # Q in Connect
9399
9574
  #
9400
- # UI name: [Contacts queued][48]
9575
+ # UI name: [Contacts queued][45]
9401
9576
  #
9402
9577
  # CONTACTS\_QUEUED\_BY\_ENQUEUE
9403
9578
  #
@@ -9406,7 +9581,21 @@ module Aws::Connect
9406
9581
  # Valid groupings and filters: Queue, Channel, Agent, Agent
9407
9582
  # Hierarchy, contact/segmentAttributes/connect:Subtype
9408
9583
  #
9409
- # UI name: [Contacts queued (enqueue timestamp)][49]
9584
+ # UI name: [Contacts queued (enqueue timestamp)][46]
9585
+ #
9586
+ # CONTACTS\_REMOVED\_FROM\_QUEUE\_IN\_X
9587
+ #
9588
+ # : Unit: Count
9589
+ #
9590
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Q in
9591
+ # Connect
9592
+ #
9593
+ # Threshold: For `ThresholdValue`, enter any whole number from 1 to
9594
+ # 604800 (inclusive), in seconds. For `Comparison`, you must enter
9595
+ # `LT` (for "Less than").
9596
+ #
9597
+ # UI name: This metric is not available in Amazon Connect admin
9598
+ # website.
9410
9599
  #
9411
9600
  # CONTACTS\_RESOLVED\_IN\_X
9412
9601
  #
@@ -9419,7 +9608,7 @@ module Aws::Connect
9419
9608
  # 604800 (inclusive), in seconds. For `Comparison`, you must enter
9420
9609
  # `LT` (for "Less than").
9421
9610
  #
9422
- # UI name: [Contacts resolved in X][50]
9611
+ # UI name: [Contacts resolved in X][47]
9423
9612
  #
9424
9613
  # CONTACTS\_TRANSFERRED\_OUT
9425
9614
  #
@@ -9429,7 +9618,7 @@ module Aws::Connect
9429
9618
  # Agent, Agent Hierarchy, Feature,
9430
9619
  # contact/segmentAttributes/connect:Subtype, Q in Connect
9431
9620
  #
9432
- # UI name: [Contacts transferred out][51]
9621
+ # UI name: [Contacts transferred out][48]
9433
9622
  #
9434
9623
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
9435
9624
  #
@@ -9443,7 +9632,7 @@ module Aws::Connect
9443
9632
  # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
9444
9633
  # Q in Connect
9445
9634
  #
9446
- # UI name: [Contacts transferred out by agent][52]
9635
+ # UI name: [Contacts transferred out by agent][49]
9447
9636
  #
9448
9637
  # CONTACTS\_TRANSFERRED\_OUT\_FROM\_QUEUE
9449
9638
  #
@@ -9453,7 +9642,7 @@ module Aws::Connect
9453
9642
  # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
9454
9643
  # Q in Connect
9455
9644
  #
9456
- # UI name: [Contacts transferred out queue][52]
9645
+ # UI name: [Contacts transferred out queue][49]
9457
9646
  #
9458
9647
  # CURRENT\_CASES
9459
9648
  #
@@ -9463,7 +9652,7 @@ module Aws::Connect
9463
9652
  #
9464
9653
  # Valid groupings and filters: CASE\_TEMPLATE\_ARN, CASE\_STATUS
9465
9654
  #
9466
- # UI name: [Current cases][53]
9655
+ # UI name: [Current cases][50]
9467
9656
  #
9468
9657
  # FLOWS\_OUTCOME
9469
9658
  #
@@ -9475,7 +9664,7 @@ module Aws::Connect
9475
9664
  # Flows outcome type, Flows resource ID, Initiation method, Resource
9476
9665
  # published timestamp
9477
9666
  #
9478
- # UI name: [Flows outcome][54]
9667
+ # UI name: [Flows outcome][51]
9479
9668
  #
9480
9669
  # FLOWS\_STARTED
9481
9670
  #
@@ -9486,7 +9675,7 @@ module Aws::Connect
9486
9675
  # resource ID, Flows resource ID, Initiation method, Resource
9487
9676
  # published timestamp
9488
9677
  #
9489
- # UI name: [Flows started][55]
9678
+ # UI name: [Flows started][52]
9490
9679
  #
9491
9680
  # MAX\_FLOW\_TIME
9492
9681
  #
@@ -9498,7 +9687,7 @@ module Aws::Connect
9498
9687
  # Flows outcome type, Flows resource ID, Initiation method, Resource
9499
9688
  # published timestamp
9500
9689
  #
9501
- # UI name: [Maximum flow time][56]
9690
+ # UI name: [Maximum flow time][53]
9502
9691
  #
9503
9692
  # MAX\_QUEUED\_TIME
9504
9693
  #
@@ -9508,7 +9697,7 @@ module Aws::Connect
9508
9697
  # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
9509
9698
  # Q in Connect
9510
9699
  #
9511
- # UI name: [Maximum queued time][57]
9700
+ # UI name: [Maximum queued time][54]
9512
9701
  #
9513
9702
  # MIN\_FLOW\_TIME
9514
9703
  #
@@ -9520,7 +9709,7 @@ module Aws::Connect
9520
9709
  # Flows outcome type, Flows resource ID, Initiation method, Resource
9521
9710
  # published timestamp
9522
9711
  #
9523
- # UI name: [Minimum flow time][58]
9712
+ # UI name: [Minimum flow time][55]
9524
9713
  #
9525
9714
  # PERCENT\_CASES\_FIRST\_CONTACT\_RESOLVED
9526
9715
  #
@@ -9530,7 +9719,7 @@ module Aws::Connect
9530
9719
  #
9531
9720
  # Valid groupings and filters: CASE\_TEMPLATE\_ARN, CASE\_STATUS
9532
9721
  #
9533
- # UI name: [Cases resolved on first contact][59]
9722
+ # UI name: [Cases resolved on first contact][56]
9534
9723
  #
9535
9724
  # PERCENT\_CONTACTS\_STEP\_EXPIRED
9536
9725
  #
@@ -9538,7 +9727,8 @@ module Aws::Connect
9538
9727
  #
9539
9728
  # Valid groupings and filters: Queue, RoutingStepExpression
9540
9729
  #
9541
- # UI name: Not available
9730
+ # UI name: This metric is available in Real-time Metrics UI but not
9731
+ # on the Historical Metrics UI.
9542
9732
  #
9543
9733
  # PERCENT\_CONTACTS\_STEP\_JOINED
9544
9734
  #
@@ -9546,7 +9736,8 @@ module Aws::Connect
9546
9736
  #
9547
9737
  # Valid groupings and filters: Queue, RoutingStepExpression
9548
9738
  #
9549
- # UI name: Not available
9739
+ # UI name: This metric is available in Real-time Metrics UI but not
9740
+ # on the Historical Metrics UI.
9550
9741
  #
9551
9742
  # PERCENT\_FLOWS\_OUTCOME
9552
9743
  #
@@ -9560,7 +9751,7 @@ module Aws::Connect
9560
9751
  # Flows outcome type, Flows resource ID, Initiation method, Resource
9561
9752
  # published timestamp
9562
9753
  #
9563
- # UI name: [Flows outcome percentage][60].
9754
+ # UI name: [Flows outcome percentage][57].
9564
9755
  #
9565
9756
  # <note markdown="1"> The `FLOWS_OUTCOME_TYPE` is not a valid grouping.
9566
9757
  #
@@ -9577,7 +9768,7 @@ module Aws::Connect
9577
9768
  # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
9578
9769
  # Q in Connect
9579
9770
  #
9580
- # UI name: [Non-talk time percent][61]
9771
+ # UI name: [Non-talk time percent][58]
9581
9772
  #
9582
9773
  # PERCENT\_TALK\_TIME
9583
9774
  #
@@ -9590,7 +9781,7 @@ module Aws::Connect
9590
9781
  # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
9591
9782
  # Q in Connect
9592
9783
  #
9593
- # UI name: [Talk time percent][62]
9784
+ # UI name: [Talk time percent][59]
9594
9785
  #
9595
9786
  # PERCENT\_TALK\_TIME\_AGENT
9596
9787
  #
@@ -9603,7 +9794,7 @@ module Aws::Connect
9603
9794
  # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
9604
9795
  # Q in Connect
9605
9796
  #
9606
- # UI name: [Agent talk time percent][63]
9797
+ # UI name: [Agent talk time percent][60]
9607
9798
  #
9608
9799
  # PERCENT\_TALK\_TIME\_CUSTOMER
9609
9800
  #
@@ -9616,7 +9807,7 @@ module Aws::Connect
9616
9807
  # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
9617
9808
  # Q in Connect
9618
9809
  #
9619
- # UI name: [Customer talk time percent][64]
9810
+ # UI name: [Customer talk time percent][61]
9620
9811
  #
9621
9812
  # REOPENED\_CASE\_ACTIONS
9622
9813
  #
@@ -9626,7 +9817,7 @@ module Aws::Connect
9626
9817
  #
9627
9818
  # Valid groupings and filters: CASE\_TEMPLATE\_ARN, CASE\_STATUS
9628
9819
  #
9629
- # UI name: [Cases reopened][65]
9820
+ # UI name: [Cases reopened][62]
9630
9821
  #
9631
9822
  # RESOLVED\_CASE\_ACTIONS
9632
9823
  #
@@ -9636,7 +9827,7 @@ module Aws::Connect
9636
9827
  #
9637
9828
  # Valid groupings and filters: CASE\_TEMPLATE\_ARN, CASE\_STATUS
9638
9829
  #
9639
- # UI name: [Cases resolved][66]
9830
+ # UI name: [Cases resolved][63]
9640
9831
  #
9641
9832
  # SERVICE\_LEVEL
9642
9833
  #
@@ -9651,7 +9842,7 @@ module Aws::Connect
9651
9842
  # 604800 (inclusive), in seconds. For `Comparison`, you must enter
9652
9843
  # `LT` (for "Less than").
9653
9844
  #
9654
- # UI name: [Service level X][67]
9845
+ # UI name: [Service level X][64]
9655
9846
  #
9656
9847
  # STEP\_CONTACTS\_QUEUED
9657
9848
  #
@@ -9659,7 +9850,8 @@ module Aws::Connect
9659
9850
  #
9660
9851
  # Valid groupings and filters: Queue, RoutingStepExpression
9661
9852
  #
9662
- # UI name: Not available
9853
+ # UI name: This metric is available in Real-time Metrics UI but not
9854
+ # on the Historical Metrics UI.
9663
9855
  #
9664
9856
  # SUM\_AFTER\_CONTACT\_WORK\_TIME
9665
9857
  #
@@ -9668,7 +9860,7 @@ module Aws::Connect
9668
9860
  # Valid groupings and filters: Queue, Channel, Routing Profile,
9669
9861
  # Agent, Agent Hierarchy, Q in Connect
9670
9862
  #
9671
- # UI name: [After contact work time][68]
9863
+ # UI name: [After contact work time][65]
9672
9864
  #
9673
9865
  # SUM\_CONNECTING\_TIME\_AGENT
9674
9866
  #
@@ -9681,13 +9873,56 @@ module Aws::Connect
9681
9873
  # Valid groupings and filters: Queue, Channel, Routing Profile,
9682
9874
  # Agent, Agent Hierarchy
9683
9875
  #
9684
- # UI name: [Agent API connecting time][69]
9876
+ # UI name: [Agent API connecting time][66]
9685
9877
  #
9686
9878
  # <note markdown="1"> The `Negate` key in Metric Level Filters is not applicable for
9687
9879
  # this metric.
9688
9880
  #
9689
9881
  # </note>
9690
9882
  #
9883
+ # SUM\_CONTACTS\_ABANDONED
9884
+ #
9885
+ # : Unit: Count
9886
+ #
9887
+ # Metric filter:
9888
+ #
9889
+ # * Valid values: `API`\| `Incoming` \| `Outbound` \| `Transfer` \|
9890
+ # `Callback` \| `Queue_Transfer`\| `Disconnect`
9891
+ #
9892
+ # ^
9893
+ #
9894
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
9895
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
9896
+ # RoutingStepExpression, Q in Connect
9897
+ #
9898
+ # UI name: [Contact abandoned][67]
9899
+ #
9900
+ # SUM\_CONTACTS\_ABANDONED\_IN\_X
9901
+ #
9902
+ # : Unit: Count
9903
+ #
9904
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
9905
+ # contact/segmentAttributes/connect:Subtype, Q in Connect
9906
+ #
9907
+ # Threshold: For `ThresholdValue`, enter any whole number from 1 to
9908
+ # 604800 (inclusive), in seconds. For `Comparison`, you must enter
9909
+ # `LT` (for "Less than").
9910
+ #
9911
+ # UI name: [Contacts abandoned in X seconds][68]
9912
+ #
9913
+ # SUM\_CONTACTS\_ANSWERED\_IN\_X
9914
+ #
9915
+ # : Unit: Count
9916
+ #
9917
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
9918
+ # contact/segmentAttributes/connect:Subtype, Q in Connect
9919
+ #
9920
+ # Threshold: For `ThresholdValue`, enter any whole number from 1 to
9921
+ # 604800 (inclusive), in seconds. For `Comparison`, you must enter
9922
+ # `LT` (for "Less than").
9923
+ #
9924
+ # UI name: [Contacts answered in X seconds][69]
9925
+ #
9691
9926
  # SUM\_CONTACT\_FLOW\_TIME
9692
9927
  #
9693
9928
  # : Unit: Seconds
@@ -9701,8 +9936,8 @@ module Aws::Connect
9701
9936
  #
9702
9937
  # : Unit: Seconds
9703
9938
  #
9704
- # Valid groupings and filters: Queue, Channel, Routing Profile,
9705
- # Agent, Agent Hierarchy
9939
+ # Valid groupings and filters: Routing Profile, Agent, Agent
9940
+ # Hierarchy
9706
9941
  #
9707
9942
  # UI name: [Agent on contact time][71]
9708
9943
  #
@@ -9722,8 +9957,8 @@ module Aws::Connect
9722
9957
  #
9723
9958
  # : Unit: Seconds
9724
9959
  #
9725
- # Valid groupings and filters: Queue, Channel, Routing Profile,
9726
- # Agent, Agent Hierarchy
9960
+ # Valid groupings and filters: Routing Profile, Agent, Agent
9961
+ # Hierarchy
9727
9962
  #
9728
9963
  # UI name: [Error status time][73]
9729
9964
  #
@@ -9838,38 +10073,38 @@ module Aws::Connect
9838
10073
  # [35]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-agent-historical
9839
10074
  # [36]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-customer-historical
9840
10075
  # [37]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html##cases-created-historical
9841
- # [38]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-historical
9842
- # [39]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-x-historical
9843
- # [40]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-answered-x-historical
9844
- # [41]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-created-historical
9845
- # [42]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#api-contacts-handled-historical
9846
- # [43]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-handled-by-connected-to-agent-historical
9847
- # [44]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-agent-disconnect-historical
9848
- # [45]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-customer-disconnect-historical
9849
- # [46]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-external-historical
9850
- # [47]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-internal-historical
9851
- # [48]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-queued-historical
9852
- # [49]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-queued-by-enqueue-historical
9853
- # [50]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-resolved-historical
9854
- # [51]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-historical
9855
- # [52]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-by-agent-historical
9856
- # [53]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#current-cases-historical
9857
- # [54]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-outcome-historical
9858
- # [55]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-started-historical
9859
- # [56]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#maximum-flow-time-historical
9860
- # [57]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#maximum-queued-time-historical
9861
- # [58]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#minimum-flow-time-historical
9862
- # [59]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-resolved-first-contact-historical
9863
- # [60]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-outcome-percentage-historical
9864
- # [61]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ntt-historical
9865
- # [62]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#tt-historical
9866
- # [63]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ttagent-historical
9867
- # [64]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ttcustomer-historical
9868
- # [65]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-reopened-historical
9869
- # [66]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-resolved-historicall
9870
- # [67]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#service-level-historical
9871
- # [68]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#acw-historical
9872
- # [69]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#htm-agent-api-connecting-time
10076
+ # [38]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-created-historical
10077
+ # [39]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#api-contacts-handled-historical
10078
+ # [40]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-handled-by-connected-to-agent-historical
10079
+ # [41]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-agent-disconnect-historical
10080
+ # [42]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-customer-disconnect-historical
10081
+ # [43]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-external-historical
10082
+ # [44]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-internal-historical
10083
+ # [45]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-queued-historical
10084
+ # [46]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-queued-by-enqueue-historical
10085
+ # [47]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-resolved-historical
10086
+ # [48]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-historical
10087
+ # [49]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-by-agent-historical
10088
+ # [50]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#current-cases-historical
10089
+ # [51]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-outcome-historical
10090
+ # [52]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-started-historical
10091
+ # [53]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#maximum-flow-time-historical
10092
+ # [54]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#maximum-queued-time-historical
10093
+ # [55]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#minimum-flow-time-historical
10094
+ # [56]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-resolved-first-contact-historical
10095
+ # [57]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-outcome-percentage-historical
10096
+ # [58]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ntt-historical
10097
+ # [59]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#tt-historical
10098
+ # [60]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ttagent-historical
10099
+ # [61]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ttcustomer-historical
10100
+ # [62]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-reopened-historical
10101
+ # [63]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-resolved-historical
10102
+ # [64]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#service-level-historical
10103
+ # [65]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#acw-historical
10104
+ # [66]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#htm-agent-api-connecting-time
10105
+ # [67]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-historical
10106
+ # [68]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-x-historical
10107
+ # [69]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-answered-x-historical
9873
10108
  # [70]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-flow-time-historical
9874
10109
  # [71]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-on-contact-time-historical
9875
10110
  # [72]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-disconnected-historical
@@ -11506,6 +11741,53 @@ module Aws::Connect
11506
11741
  include Aws::Structure
11507
11742
  end
11508
11743
 
11744
+ # @!attribute [rw] instance_id
11745
+ # The identifier of the Amazon Connect instance. You can [find the
11746
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
11747
+ #
11748
+ #
11749
+ #
11750
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
11751
+ # @return [String]
11752
+ #
11753
+ # @!attribute [rw] max_results
11754
+ # The maximum number of results to return per page.
11755
+ # @return [Integer]
11756
+ #
11757
+ # @!attribute [rw] next_token
11758
+ # The token for the next set of results. Use the value returned in the
11759
+ # previous response in the next request to retrieve the next set of
11760
+ # results.
11761
+ # @return [String]
11762
+ #
11763
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListAuthenticationProfilesRequest AWS API Documentation
11764
+ #
11765
+ class ListAuthenticationProfilesRequest < Struct.new(
11766
+ :instance_id,
11767
+ :max_results,
11768
+ :next_token)
11769
+ SENSITIVE = []
11770
+ include Aws::Structure
11771
+ end
11772
+
11773
+ # @!attribute [rw] authentication_profile_summary_list
11774
+ # A summary of a given authentication profile.
11775
+ # @return [Array<Types::AuthenticationProfileSummary>]
11776
+ #
11777
+ # @!attribute [rw] next_token
11778
+ # If there are additional results, this is the token for the next set
11779
+ # of results.
11780
+ # @return [String]
11781
+ #
11782
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListAuthenticationProfilesResponse AWS API Documentation
11783
+ #
11784
+ class ListAuthenticationProfilesResponse < Struct.new(
11785
+ :authentication_profile_summary_list,
11786
+ :next_token)
11787
+ SENSITIVE = []
11788
+ include Aws::Structure
11789
+ end
11790
+
11509
11791
  # @!attribute [rw] instance_id
11510
11792
  # The identifier of the Amazon Connect instance. You can [find the
11511
11793
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -13765,6 +14047,20 @@ module Aws::Connect
13765
14047
  include Aws::Structure
13766
14048
  end
13767
14049
 
14050
+ # An object to define `AgentsCriteria`.
14051
+ #
14052
+ # @!attribute [rw] agents_criteria
14053
+ # An object to define `AgentIds`.
14054
+ # @return [Types::AgentsCriteria]
14055
+ #
14056
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/MatchCriteria AWS API Documentation
14057
+ #
14058
+ class MatchCriteria < Struct.new(
14059
+ :agents_criteria)
14060
+ SENSITIVE = []
14061
+ include Aws::Structure
14062
+ end
14063
+
13768
14064
  # Maximum number (1000) of tags have been returned with current request.
13769
14065
  # Consider changing request parameters to get more tags.
13770
14066
  #
@@ -16878,7 +17174,7 @@ module Aws::Connect
16878
17174
  end
16879
17175
 
16880
17176
  # @!attribute [rw] contact_flows
16881
- # Information about the contact flows.
17177
+ # Information about the flows.
16882
17178
  # @return [Array<Types::ContactFlow>]
16883
17179
  #
16884
17180
  # @!attribute [rw] next_token
@@ -17018,7 +17314,7 @@ module Aws::Connect
17018
17314
  # @!attribute [rw] searchable_contact_attributes
17019
17315
  # The search criteria based on user-defined contact attributes that
17020
17316
  # have been configured for contact search. For more information, see
17021
- # [Search by customer contact attributes][1] in the *Amazon Connect
17317
+ # [Search by custom contact attributes][1] in the *Amazon Connect
17022
17318
  # Administrator Guide*.
17023
17319
  #
17024
17320
  # To use `SearchableContactAttributes` in a search request, the
@@ -18180,7 +18476,7 @@ module Aws::Connect
18180
18476
  include Aws::Structure
18181
18477
  end
18182
18478
 
18183
- # A structure that defineds the field name to sort by and a sort order.
18479
+ # A structure that defines the field name to sort by and a sort order.
18184
18480
  #
18185
18481
  # @!attribute [rw] field_name
18186
18482
  # The name of the field on which to sort.
@@ -18214,7 +18510,7 @@ module Aws::Connect
18214
18510
  # @return [String]
18215
18511
  #
18216
18512
  # @!attribute [rw] instance_id
18217
- # The unique identifier of the Connect instance.
18513
+ # The unique identifier of the Amazon Connect instance.
18218
18514
  # @return [String]
18219
18515
  #
18220
18516
  # @!attribute [rw] file_name
@@ -18952,10 +19248,9 @@ module Aws::Connect
18952
19248
  # @!attribute [rw] contact_flow_id
18953
19249
  # The identifier of the flow for the call. To see the ContactFlowId in
18954
19250
  # the Amazon Connect admin website, on the navigation menu go to
18955
- # **Routing**, **Contact Flows**. Choose the flow. On the flow page,
18956
- # under the name of the flow, choose **Show additional flow
18957
- # information**. The ContactFlowId is the last part of the ARN, shown
18958
- # here in bold:
19251
+ # **Routing**, **Flows**. Choose the flow. On the flow page, under the
19252
+ # name of the flow, choose **Show additional flow information**. The
19253
+ # ContactFlowId is the last part of the ARN, shown here in bold:
18959
19254
  #
18960
19255
  # arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
18961
19256
  # @return [String]
@@ -20128,6 +20423,77 @@ module Aws::Connect
20128
20423
  include Aws::Structure
20129
20424
  end
20130
20425
 
20426
+ # @!attribute [rw] authentication_profile_id
20427
+ # A unique identifier for the authentication profile.
20428
+ # @return [String]
20429
+ #
20430
+ # @!attribute [rw] instance_id
20431
+ # The identifier of the Amazon Connect instance. You can [find the
20432
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
20433
+ #
20434
+ #
20435
+ #
20436
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
20437
+ # @return [String]
20438
+ #
20439
+ # @!attribute [rw] name
20440
+ # The name for the authentication profile.
20441
+ # @return [String]
20442
+ #
20443
+ # @!attribute [rw] description
20444
+ # The description for the authentication profile.
20445
+ # @return [String]
20446
+ #
20447
+ # @!attribute [rw] allowed_ips
20448
+ # A list of IP address range strings that are allowed to access the
20449
+ # instance. For more information on how to configure IP addresses,
20450
+ # see[Configure session timeouts][1] in the *Amazon Connect
20451
+ # Administrator Guide*.
20452
+ #
20453
+ #
20454
+ #
20455
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts
20456
+ # @return [Array<String>]
20457
+ #
20458
+ # @!attribute [rw] blocked_ips
20459
+ # A list of IP address range strings that are blocked from accessing
20460
+ # the instance. For more information on how to configure IP addresses,
20461
+ # For more information on how to configure IP addresses, see
20462
+ # [Configure IP-based access control][1] in the *Amazon Connect
20463
+ # Administrator Guide*.
20464
+ #
20465
+ #
20466
+ #
20467
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-ip-based-ac
20468
+ # @return [Array<String>]
20469
+ #
20470
+ # @!attribute [rw] periodic_session_duration
20471
+ # The short lived session duration configuration for users logged in
20472
+ # to Amazon Connect, in minutes. This value determines the maximum
20473
+ # possible time before an agent is authenticated. For more
20474
+ # information, For more information on how to configure IP addresses,
20475
+ # see [Configure session timeouts][1] in the *Amazon Connect
20476
+ # Administrator Guide*.
20477
+ #
20478
+ #
20479
+ #
20480
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts
20481
+ # @return [Integer]
20482
+ #
20483
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateAuthenticationProfileRequest AWS API Documentation
20484
+ #
20485
+ class UpdateAuthenticationProfileRequest < Struct.new(
20486
+ :authentication_profile_id,
20487
+ :instance_id,
20488
+ :name,
20489
+ :description,
20490
+ :allowed_ips,
20491
+ :blocked_ips,
20492
+ :periodic_session_duration)
20493
+ SENSITIVE = []
20494
+ include Aws::Structure
20495
+ end
20496
+
20131
20497
  # The `UpdateCase` action definition.
20132
20498
  #
20133
20499
  # @!attribute [rw] fields