aws-sdk-connect 1.53.0 → 1.57.0

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.
@@ -10,6 +10,38 @@
10
10
  module Aws::Connect
11
11
  module Types
12
12
 
13
+ # You do not have sufficient access to perform this action.
14
+ #
15
+ # @!attribute [rw] message
16
+ # @return [String]
17
+ #
18
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AccessDeniedException AWS API Documentation
19
+ #
20
+ class AccessDeniedException < Struct.new(
21
+ :message)
22
+ SENSITIVE = []
23
+ include Aws::Structure
24
+ end
25
+
26
+ # Information about the agent who accepted the contact.
27
+ #
28
+ # @!attribute [rw] id
29
+ # The identifier of the agent who accepted the contact.
30
+ # @return [String]
31
+ #
32
+ # @!attribute [rw] connected_to_agent_timestamp
33
+ # The timestamp when the contact was connected to the agent.
34
+ # @return [Time]
35
+ #
36
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AgentInfo AWS API Documentation
37
+ #
38
+ class AgentInfo < Struct.new(
39
+ :id,
40
+ :connected_to_agent_timestamp)
41
+ SENSITIVE = []
42
+ include Aws::Structure
43
+ end
44
+
13
45
  # Contains information about an agent status.
14
46
  #
15
47
  # @!attribute [rw] agent_status_arn
@@ -418,6 +450,31 @@ module Aws::Connect
418
450
  include Aws::Structure
419
451
  end
420
452
 
453
+ # Information about the attachment reference if the `referenceType` is
454
+ # `ATTACHMENT`. Otherwise, null.
455
+ #
456
+ # @!attribute [rw] name
457
+ # Identifier of the attachment reference.
458
+ # @return [String]
459
+ #
460
+ # @!attribute [rw] value
461
+ # Contains the location path of the attachment reference.
462
+ # @return [String]
463
+ #
464
+ # @!attribute [rw] status
465
+ # Status of an attachment reference type.
466
+ # @return [String]
467
+ #
468
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AttachmentReference AWS API Documentation
469
+ #
470
+ class AttachmentReference < Struct.new(
471
+ :name,
472
+ :value,
473
+ :status)
474
+ SENSITIVE = []
475
+ include Aws::Structure
476
+ end
477
+
421
478
  # A toggle for an individual feature at the instance level.
422
479
  #
423
480
  # @!attribute [rw] attribute_type
@@ -464,6 +521,119 @@ module Aws::Connect
464
521
  include Aws::Structure
465
522
  end
466
523
 
524
+ # The streaming configuration, such as the Amazon SNS streaming
525
+ # endpoint.
526
+ #
527
+ # @note When making an API call, you may pass ChatStreamingConfiguration
528
+ # data as a hash:
529
+ #
530
+ # {
531
+ # streaming_endpoint_arn: "ChatStreamingEndpointARN", # required
532
+ # }
533
+ #
534
+ # @!attribute [rw] streaming_endpoint_arn
535
+ # The Amazon Resource Name (ARN) of the standard Amazon SNS topic. The
536
+ # Amazon Resource Name (ARN) of the streaming endpoint that is used to
537
+ # publish real-time message streaming for chat conversations.
538
+ # @return [String]
539
+ #
540
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ChatStreamingConfiguration AWS API Documentation
541
+ #
542
+ class ChatStreamingConfiguration < Struct.new(
543
+ :streaming_endpoint_arn)
544
+ SENSITIVE = []
545
+ include Aws::Structure
546
+ end
547
+
548
+ # Contains information about a contact.
549
+ #
550
+ # @!attribute [rw] arn
551
+ # The Amazon Resource Name (ARN) for the contact.
552
+ # @return [String]
553
+ #
554
+ # @!attribute [rw] id
555
+ # The identifier for the contact.
556
+ # @return [String]
557
+ #
558
+ # @!attribute [rw] initial_contact_id
559
+ # If this contact is related to other contacts, this is the ID of the
560
+ # initial contact.
561
+ # @return [String]
562
+ #
563
+ # @!attribute [rw] previous_contact_id
564
+ # If this contact is not the first contact, this is the ID of the
565
+ # previous contact.
566
+ # @return [String]
567
+ #
568
+ # @!attribute [rw] initiation_method
569
+ # Indicates how the contact was initiated.
570
+ # @return [String]
571
+ #
572
+ # @!attribute [rw] name
573
+ # The name of the contact.
574
+ # @return [String]
575
+ #
576
+ # @!attribute [rw] description
577
+ # The description of the contact.
578
+ # @return [String]
579
+ #
580
+ # @!attribute [rw] channel
581
+ # How the contact reached your contact center.
582
+ # @return [String]
583
+ #
584
+ # @!attribute [rw] queue_info
585
+ # If this contact was queued, this contains information about the
586
+ # queue.
587
+ # @return [Types::QueueInfo]
588
+ #
589
+ # @!attribute [rw] agent_info
590
+ # Information about the agent who accepted the contact.
591
+ # @return [Types::AgentInfo]
592
+ #
593
+ # @!attribute [rw] initiation_timestamp
594
+ # The date and time this contact was initiated, in UTC time. For
595
+ # `INBOUND`, this is when the contact arrived. For `OUTBOUND`, this is
596
+ # when the agent began dialing. For `CALLBACK`, this is when the
597
+ # callback contact was created. For `TRANSFER` and `QUEUE_TRANSFER`,
598
+ # this is when the transfer was initiated. For `API`, this is when the
599
+ # request arrived.
600
+ # @return [Time]
601
+ #
602
+ # @!attribute [rw] disconnect_timestamp
603
+ # The timestamp when the customer endpoint disconnected from Amazon
604
+ # Connect.
605
+ # @return [Time]
606
+ #
607
+ # @!attribute [rw] last_update_timestamp
608
+ # The timestamp when contact was last updated.
609
+ # @return [Time]
610
+ #
611
+ # @!attribute [rw] scheduled_timestamp
612
+ # The timestamp, in Unix epoch time format, at which to start running
613
+ # the inbound flow.
614
+ # @return [Time]
615
+ #
616
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Contact AWS API Documentation
617
+ #
618
+ class Contact < Struct.new(
619
+ :arn,
620
+ :id,
621
+ :initial_contact_id,
622
+ :previous_contact_id,
623
+ :initiation_method,
624
+ :name,
625
+ :description,
626
+ :channel,
627
+ :queue_info,
628
+ :agent_info,
629
+ :initiation_timestamp,
630
+ :disconnect_timestamp,
631
+ :last_update_timestamp,
632
+ :scheduled_timestamp)
633
+ SENSITIVE = []
634
+ include Aws::Structure
635
+ end
636
+
467
637
  # Contains information about a contact flow.
468
638
  #
469
639
  # @!attribute [rw] arn
@@ -1201,6 +1371,69 @@ module Aws::Connect
1201
1371
  include Aws::Structure
1202
1372
  end
1203
1373
 
1374
+ # @note When making an API call, you may pass CreateSecurityProfileRequest
1375
+ # data as a hash:
1376
+ #
1377
+ # {
1378
+ # security_profile_name: "SecurityProfileName", # required
1379
+ # description: "SecurityProfileDescription",
1380
+ # permissions: ["SecurityProfilePermission"],
1381
+ # instance_id: "InstanceId", # required
1382
+ # tags: {
1383
+ # "TagKey" => "TagValue",
1384
+ # },
1385
+ # }
1386
+ #
1387
+ # @!attribute [rw] security_profile_name
1388
+ # The name of the security profile.
1389
+ # @return [String]
1390
+ #
1391
+ # @!attribute [rw] description
1392
+ # The description of the security profile.
1393
+ # @return [String]
1394
+ #
1395
+ # @!attribute [rw] permissions
1396
+ # Permissions assigned to the security profile.
1397
+ # @return [Array<String>]
1398
+ #
1399
+ # @!attribute [rw] instance_id
1400
+ # The identifier of the Amazon Connect instance. You can find the
1401
+ # instanceId in the ARN of the instance.
1402
+ # @return [String]
1403
+ #
1404
+ # @!attribute [rw] tags
1405
+ # One or more tags.
1406
+ # @return [Hash<String,String>]
1407
+ #
1408
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateSecurityProfileRequest AWS API Documentation
1409
+ #
1410
+ class CreateSecurityProfileRequest < Struct.new(
1411
+ :security_profile_name,
1412
+ :description,
1413
+ :permissions,
1414
+ :instance_id,
1415
+ :tags)
1416
+ SENSITIVE = []
1417
+ include Aws::Structure
1418
+ end
1419
+
1420
+ # @!attribute [rw] security_profile_id
1421
+ # The identifier for the security profle.
1422
+ # @return [String]
1423
+ #
1424
+ # @!attribute [rw] security_profile_arn
1425
+ # The Amazon Resource Name (ARN) for the security profile.
1426
+ # @return [String]
1427
+ #
1428
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateSecurityProfileResponse AWS API Documentation
1429
+ #
1430
+ class CreateSecurityProfileResponse < Struct.new(
1431
+ :security_profile_id,
1432
+ :security_profile_arn)
1433
+ SENSITIVE = []
1434
+ include Aws::Structure
1435
+ end
1436
+
1204
1437
  # @note When making an API call, you may pass CreateUseCaseRequest
1205
1438
  # data as a hash:
1206
1439
  #
@@ -1630,6 +1863,32 @@ module Aws::Connect
1630
1863
  include Aws::Structure
1631
1864
  end
1632
1865
 
1866
+ # @note When making an API call, you may pass DeleteSecurityProfileRequest
1867
+ # data as a hash:
1868
+ #
1869
+ # {
1870
+ # instance_id: "InstanceId", # required
1871
+ # security_profile_id: "SecurityProfileId", # required
1872
+ # }
1873
+ #
1874
+ # @!attribute [rw] instance_id
1875
+ # The identifier of the Amazon Connect instance. You can find the
1876
+ # instanceId in the ARN of the instance.
1877
+ # @return [String]
1878
+ #
1879
+ # @!attribute [rw] security_profile_id
1880
+ # The identifier for the security profle.
1881
+ # @return [String]
1882
+ #
1883
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteSecurityProfileRequest AWS API Documentation
1884
+ #
1885
+ class DeleteSecurityProfileRequest < Struct.new(
1886
+ :instance_id,
1887
+ :security_profile_id)
1888
+ SENSITIVE = []
1889
+ include Aws::Structure
1890
+ end
1891
+
1633
1892
  # @note When making an API call, you may pass DeleteUseCaseRequest
1634
1893
  # data as a hash:
1635
1894
  #
@@ -1789,6 +2048,44 @@ module Aws::Connect
1789
2048
  include Aws::Structure
1790
2049
  end
1791
2050
 
2051
+ # @note When making an API call, you may pass DescribeContactRequest
2052
+ # data as a hash:
2053
+ #
2054
+ # {
2055
+ # instance_id: "InstanceId", # required
2056
+ # contact_id: "ContactId", # required
2057
+ # }
2058
+ #
2059
+ # @!attribute [rw] instance_id
2060
+ # The identifier of the Amazon Connect instance. You can find the
2061
+ # instanceId in the ARN of the instance.
2062
+ # @return [String]
2063
+ #
2064
+ # @!attribute [rw] contact_id
2065
+ # The identifier of the initial contact.
2066
+ # @return [String]
2067
+ #
2068
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactRequest AWS API Documentation
2069
+ #
2070
+ class DescribeContactRequest < Struct.new(
2071
+ :instance_id,
2072
+ :contact_id)
2073
+ SENSITIVE = []
2074
+ include Aws::Structure
2075
+ end
2076
+
2077
+ # @!attribute [rw] contact
2078
+ # Information about the contact.
2079
+ # @return [Types::Contact]
2080
+ #
2081
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactResponse AWS API Documentation
2082
+ #
2083
+ class DescribeContactResponse < Struct.new(
2084
+ :contact)
2085
+ SENSITIVE = []
2086
+ include Aws::Structure
2087
+ end
2088
+
1792
2089
  # @note When making an API call, you may pass DescribeHoursOfOperationRequest
1793
2090
  # data as a hash:
1794
2091
  #
@@ -2056,6 +2353,44 @@ module Aws::Connect
2056
2353
  include Aws::Structure
2057
2354
  end
2058
2355
 
2356
+ # @note When making an API call, you may pass DescribeSecurityProfileRequest
2357
+ # data as a hash:
2358
+ #
2359
+ # {
2360
+ # security_profile_id: "SecurityProfileId", # required
2361
+ # instance_id: "InstanceId", # required
2362
+ # }
2363
+ #
2364
+ # @!attribute [rw] security_profile_id
2365
+ # The identifier for the security profle.
2366
+ # @return [String]
2367
+ #
2368
+ # @!attribute [rw] instance_id
2369
+ # The identifier of the Amazon Connect instance. You can find the
2370
+ # instanceId in the ARN of the instance.
2371
+ # @return [String]
2372
+ #
2373
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeSecurityProfileRequest AWS API Documentation
2374
+ #
2375
+ class DescribeSecurityProfileRequest < Struct.new(
2376
+ :security_profile_id,
2377
+ :instance_id)
2378
+ SENSITIVE = []
2379
+ include Aws::Structure
2380
+ end
2381
+
2382
+ # @!attribute [rw] security_profile
2383
+ # The security profile.
2384
+ # @return [Types::SecurityProfile]
2385
+ #
2386
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeSecurityProfileResponse AWS API Documentation
2387
+ #
2388
+ class DescribeSecurityProfileResponse < Struct.new(
2389
+ :security_profile)
2390
+ SENSITIVE = []
2391
+ include Aws::Structure
2392
+ end
2393
+
2059
2394
  # @note When making an API call, you may pass DescribeUserHierarchyGroupRequest
2060
2395
  # data as a hash:
2061
2396
  #
@@ -4243,13 +4578,14 @@ module Aws::Connect
4243
4578
  include Aws::Structure
4244
4579
  end
4245
4580
 
4246
- # @note When making an API call, you may pass ListHoursOfOperationsRequest
4581
+ # @note When making an API call, you may pass ListContactReferencesRequest
4247
4582
  # data as a hash:
4248
4583
  #
4249
4584
  # {
4250
4585
  # instance_id: "InstanceId", # required
4586
+ # contact_id: "ContactId", # required
4587
+ # reference_types: ["URL"], # required, accepts URL, ATTACHMENT
4251
4588
  # next_token: "NextToken",
4252
- # max_results: 1,
4253
4589
  # }
4254
4590
  #
4255
4591
  # @!attribute [rw] instance_id
@@ -4257,45 +4593,55 @@ module Aws::Connect
4257
4593
  # instanceId in the ARN of the instance.
4258
4594
  # @return [String]
4259
4595
  #
4596
+ # @!attribute [rw] contact_id
4597
+ # The identifier of the initial contact.
4598
+ # @return [String]
4599
+ #
4600
+ # @!attribute [rw] reference_types
4601
+ # The type of reference.
4602
+ # @return [Array<String>]
4603
+ #
4260
4604
  # @!attribute [rw] next_token
4261
4605
  # The token for the next set of results. Use the value returned in the
4262
4606
  # previous response in the next request to retrieve the next set of
4263
4607
  # results.
4264
- # @return [String]
4265
4608
  #
4266
- # @!attribute [rw] max_results
4267
- # The maximum number of results to return per page.
4268
- # @return [Integer]
4609
+ # This is not expected to be set since the value returned in the
4610
+ # previous response is always null.
4611
+ # @return [String]
4269
4612
  #
4270
- # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListHoursOfOperationsRequest AWS API Documentation
4613
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactReferencesRequest AWS API Documentation
4271
4614
  #
4272
- class ListHoursOfOperationsRequest < Struct.new(
4615
+ class ListContactReferencesRequest < Struct.new(
4273
4616
  :instance_id,
4274
- :next_token,
4275
- :max_results)
4617
+ :contact_id,
4618
+ :reference_types,
4619
+ :next_token)
4276
4620
  SENSITIVE = []
4277
4621
  include Aws::Structure
4278
4622
  end
4279
4623
 
4280
- # @!attribute [rw] hours_of_operation_summary_list
4281
- # Information about the hours of operation.
4282
- # @return [Array<Types::HoursOfOperationSummary>]
4624
+ # @!attribute [rw] reference_summary_list
4625
+ # Information about the contact flows.
4626
+ # @return [Array<Types::ReferenceSummary>]
4283
4627
  #
4284
4628
  # @!attribute [rw] next_token
4285
4629
  # If there are additional results, this is the token for the next set
4286
4630
  # of results.
4631
+ #
4632
+ # This is always returned as null in the response.
4287
4633
  # @return [String]
4288
4634
  #
4289
- # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListHoursOfOperationsResponse AWS API Documentation
4635
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactReferencesResponse AWS API Documentation
4290
4636
  #
4291
- class ListHoursOfOperationsResponse < Struct.new(
4292
- :hours_of_operation_summary_list,
4637
+ class ListContactReferencesResponse < Struct.new(
4638
+ :reference_summary_list,
4293
4639
  :next_token)
4294
4640
  SENSITIVE = []
4295
4641
  include Aws::Structure
4296
4642
  end
4297
4643
 
4298
- # @note When making an API call, you may pass ListInstanceAttributesRequest
4644
+ # @note When making an API call, you may pass ListHoursOfOperationsRequest
4299
4645
  # data as a hash:
4300
4646
  #
4301
4647
  # {
@@ -4319,9 +4665,9 @@ module Aws::Connect
4319
4665
  # The maximum number of results to return per page.
4320
4666
  # @return [Integer]
4321
4667
  #
4322
- # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListInstanceAttributesRequest AWS API Documentation
4668
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListHoursOfOperationsRequest AWS API Documentation
4323
4669
  #
4324
- class ListInstanceAttributesRequest < Struct.new(
4670
+ class ListHoursOfOperationsRequest < Struct.new(
4325
4671
  :instance_id,
4326
4672
  :next_token,
4327
4673
  :max_results)
@@ -4329,16 +4675,68 @@ module Aws::Connect
4329
4675
  include Aws::Structure
4330
4676
  end
4331
4677
 
4332
- # @!attribute [rw] attributes
4333
- # The attribute types.
4334
- # @return [Array<Types::Attribute>]
4678
+ # @!attribute [rw] hours_of_operation_summary_list
4679
+ # Information about the hours of operation.
4680
+ # @return [Array<Types::HoursOfOperationSummary>]
4335
4681
  #
4336
4682
  # @!attribute [rw] next_token
4337
4683
  # If there are additional results, this is the token for the next set
4338
4684
  # of results.
4339
4685
  # @return [String]
4340
4686
  #
4341
- # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListInstanceAttributesResponse AWS API Documentation
4687
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListHoursOfOperationsResponse AWS API Documentation
4688
+ #
4689
+ class ListHoursOfOperationsResponse < Struct.new(
4690
+ :hours_of_operation_summary_list,
4691
+ :next_token)
4692
+ SENSITIVE = []
4693
+ include Aws::Structure
4694
+ end
4695
+
4696
+ # @note When making an API call, you may pass ListInstanceAttributesRequest
4697
+ # data as a hash:
4698
+ #
4699
+ # {
4700
+ # instance_id: "InstanceId", # required
4701
+ # next_token: "NextToken",
4702
+ # max_results: 1,
4703
+ # }
4704
+ #
4705
+ # @!attribute [rw] instance_id
4706
+ # The identifier of the Amazon Connect instance. You can find the
4707
+ # instanceId in the ARN of the instance.
4708
+ # @return [String]
4709
+ #
4710
+ # @!attribute [rw] next_token
4711
+ # The token for the next set of results. Use the value returned in the
4712
+ # previous response in the next request to retrieve the next set of
4713
+ # results.
4714
+ # @return [String]
4715
+ #
4716
+ # @!attribute [rw] max_results
4717
+ # The maximum number of results to return per page.
4718
+ # @return [Integer]
4719
+ #
4720
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListInstanceAttributesRequest AWS API Documentation
4721
+ #
4722
+ class ListInstanceAttributesRequest < Struct.new(
4723
+ :instance_id,
4724
+ :next_token,
4725
+ :max_results)
4726
+ SENSITIVE = []
4727
+ include Aws::Structure
4728
+ end
4729
+
4730
+ # @!attribute [rw] attributes
4731
+ # The attribute types.
4732
+ # @return [Array<Types::Attribute>]
4733
+ #
4734
+ # @!attribute [rw] next_token
4735
+ # If there are additional results, this is the token for the next set
4736
+ # of results.
4737
+ # @return [String]
4738
+ #
4739
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListInstanceAttributesResponse AWS API Documentation
4342
4740
  #
4343
4741
  class ListInstanceAttributesResponse < Struct.new(
4344
4742
  :attributes,
@@ -5067,6 +5465,64 @@ module Aws::Connect
5067
5465
  include Aws::Structure
5068
5466
  end
5069
5467
 
5468
+ # @note When making an API call, you may pass ListSecurityProfilePermissionsRequest
5469
+ # data as a hash:
5470
+ #
5471
+ # {
5472
+ # security_profile_id: "SecurityProfileId", # required
5473
+ # instance_id: "InstanceId", # required
5474
+ # next_token: "NextToken",
5475
+ # max_results: 1,
5476
+ # }
5477
+ #
5478
+ # @!attribute [rw] security_profile_id
5479
+ # The identifier for the security profle.
5480
+ # @return [String]
5481
+ #
5482
+ # @!attribute [rw] instance_id
5483
+ # The identifier of the Amazon Connect instance. You can find the
5484
+ # instanceId in the ARN of the instance.
5485
+ # @return [String]
5486
+ #
5487
+ # @!attribute [rw] next_token
5488
+ # The token for the next set of results. Use the value returned in the
5489
+ # previous response in the next request to retrieve the next set of
5490
+ # results.
5491
+ # @return [String]
5492
+ #
5493
+ # @!attribute [rw] max_results
5494
+ # The maximum number of results to return per page.
5495
+ # @return [Integer]
5496
+ #
5497
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityProfilePermissionsRequest AWS API Documentation
5498
+ #
5499
+ class ListSecurityProfilePermissionsRequest < Struct.new(
5500
+ :security_profile_id,
5501
+ :instance_id,
5502
+ :next_token,
5503
+ :max_results)
5504
+ SENSITIVE = []
5505
+ include Aws::Structure
5506
+ end
5507
+
5508
+ # @!attribute [rw] permissions
5509
+ # The permissions granted to the security profile.
5510
+ # @return [Array<String>]
5511
+ #
5512
+ # @!attribute [rw] next_token
5513
+ # If there are additional results, this is the token for the next set
5514
+ # of results.
5515
+ # @return [String]
5516
+ #
5517
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityProfilePermissionsResponse AWS API Documentation
5518
+ #
5519
+ class ListSecurityProfilePermissionsResponse < Struct.new(
5520
+ :permissions,
5521
+ :next_token)
5522
+ SENSITIVE = []
5523
+ include Aws::Structure
5524
+ end
5525
+
5070
5526
  # @note When making an API call, you may pass ListSecurityProfilesRequest
5071
5527
  # data as a hash:
5072
5528
  #
@@ -5568,6 +6024,25 @@ module Aws::Connect
5568
6024
  include Aws::Structure
5569
6025
  end
5570
6026
 
6027
+ # If this contact was queued, this contains information about the queue.
6028
+ #
6029
+ # @!attribute [rw] id
6030
+ # The identifier of the agent who accepted the contact.
6031
+ # @return [String]
6032
+ #
6033
+ # @!attribute [rw] enqueue_timestamp
6034
+ # The timestamp when the contact was added to the queue.
6035
+ # @return [Time]
6036
+ #
6037
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/QueueInfo AWS API Documentation
6038
+ #
6039
+ class QueueInfo < Struct.new(
6040
+ :id,
6041
+ :enqueue_timestamp)
6042
+ SENSITIVE = []
6043
+ include Aws::Structure
6044
+ end
6045
+
5571
6046
  # Contains information about a queue for a quick connect. The contact
5572
6047
  # flow must be of type Transfer to Queue.
5573
6048
  #
@@ -5777,16 +6252,18 @@ module Aws::Connect
5777
6252
  #
5778
6253
  # {
5779
6254
  # value: "ReferenceValue", # required
5780
- # type: "URL", # required, accepts URL
6255
+ # type: "URL", # required, accepts URL, ATTACHMENT
5781
6256
  # }
5782
6257
  #
5783
6258
  # @!attribute [rw] value
5784
- # A formatted URL that displays to an agent in the Contact Control
5785
- # Panel (CCP)
6259
+ # A valid value for the reference. For example, for a URL reference, a
6260
+ # formatted URL that is displayed to an agent in the Contact Control
6261
+ # Panel (CCP).
5786
6262
  # @return [String]
5787
6263
  #
5788
6264
  # @!attribute [rw] type
5789
- # A valid URL.
6265
+ # The type of the reference. Only `URL` type can be added or updated
6266
+ # on a contact.
5790
6267
  # @return [String]
5791
6268
  #
5792
6269
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Reference AWS API Documentation
@@ -5798,6 +6275,37 @@ module Aws::Connect
5798
6275
  include Aws::Structure
5799
6276
  end
5800
6277
 
6278
+ # Contains summary information about a reference. `ReferenceSummary`
6279
+ # contains only one non null field between the URL and attachment based
6280
+ # on the reference type.
6281
+ #
6282
+ # @note ReferenceSummary is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ReferenceSummary corresponding to the set member.
6283
+ #
6284
+ # @!attribute [rw] url
6285
+ # Information about Url reference if the `referenceType` is `URL`.
6286
+ # Otherwise, null.
6287
+ # @return [Types::UrlReference]
6288
+ #
6289
+ # @!attribute [rw] attachment
6290
+ # Information about the attachment reference if the `referenceType` is
6291
+ # `ATTACHMENT`. Otherwise, null.
6292
+ # @return [Types::AttachmentReference]
6293
+ #
6294
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ReferenceSummary AWS API Documentation
6295
+ #
6296
+ class ReferenceSummary < Struct.new(
6297
+ :url,
6298
+ :attachment,
6299
+ :unknown)
6300
+ SENSITIVE = []
6301
+ include Aws::Structure
6302
+ include Aws::Structure::Union
6303
+
6304
+ class Url < ReferenceSummary; end
6305
+ class Attachment < ReferenceSummary; end
6306
+ class Unknown < ReferenceSummary; end
6307
+ end
6308
+
5801
6309
  # A resource already has that name.
5802
6310
  #
5803
6311
  # @!attribute [rw] message
@@ -6150,6 +6658,45 @@ module Aws::Connect
6150
6658
  include Aws::Structure
6151
6659
  end
6152
6660
 
6661
+ # Contains information about a security profile.
6662
+ #
6663
+ # @!attribute [rw] id
6664
+ # The identifier for the security profile.
6665
+ # @return [String]
6666
+ #
6667
+ # @!attribute [rw] organization_resource_id
6668
+ # The organization resource identifier for the security profile.
6669
+ # @return [String]
6670
+ #
6671
+ # @!attribute [rw] arn
6672
+ # The Amazon Resource Name (ARN) for the secruity profile.
6673
+ # @return [String]
6674
+ #
6675
+ # @!attribute [rw] security_profile_name
6676
+ # The name for the security profile.
6677
+ # @return [String]
6678
+ #
6679
+ # @!attribute [rw] description
6680
+ # The description of the security profile.
6681
+ # @return [String]
6682
+ #
6683
+ # @!attribute [rw] tags
6684
+ # One or more tags.
6685
+ # @return [Hash<String,String>]
6686
+ #
6687
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SecurityProfile AWS API Documentation
6688
+ #
6689
+ class SecurityProfile < Struct.new(
6690
+ :id,
6691
+ :organization_resource_id,
6692
+ :arn,
6693
+ :security_profile_name,
6694
+ :description,
6695
+ :tags)
6696
+ SENSITIVE = []
6697
+ include Aws::Structure
6698
+ end
6699
+
6153
6700
  # Contains information about a security profile.
6154
6701
  #
6155
6702
  # @!attribute [rw] id
@@ -6335,6 +6882,64 @@ module Aws::Connect
6335
6882
  #
6336
6883
  class StartContactRecordingResponse < Aws::EmptyStructure; end
6337
6884
 
6885
+ # @note When making an API call, you may pass StartContactStreamingRequest
6886
+ # data as a hash:
6887
+ #
6888
+ # {
6889
+ # instance_id: "InstanceId", # required
6890
+ # contact_id: "ContactId", # required
6891
+ # chat_streaming_configuration: { # required
6892
+ # streaming_endpoint_arn: "ChatStreamingEndpointARN", # required
6893
+ # },
6894
+ # client_token: "ClientToken", # required
6895
+ # }
6896
+ #
6897
+ # @!attribute [rw] instance_id
6898
+ # The identifier of the Amazon Connect instance. You can find the
6899
+ # instanceId in the ARN of the instance.
6900
+ # @return [String]
6901
+ #
6902
+ # @!attribute [rw] contact_id
6903
+ # The identifier of the contact. This is the identifier of the contact
6904
+ # associated with the first interaction with the contact center.
6905
+ # @return [String]
6906
+ #
6907
+ # @!attribute [rw] chat_streaming_configuration
6908
+ # The streaming configuration, such as the Amazon SNS streaming
6909
+ # endpoint.
6910
+ # @return [Types::ChatStreamingConfiguration]
6911
+ #
6912
+ # @!attribute [rw] client_token
6913
+ # A unique, case-sensitive identifier that you provide to ensure the
6914
+ # idempotency of the request.
6915
+ #
6916
+ # **A suitable default value is auto-generated.** You should normally
6917
+ # not need to pass this option.
6918
+ # @return [String]
6919
+ #
6920
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartContactStreamingRequest AWS API Documentation
6921
+ #
6922
+ class StartContactStreamingRequest < Struct.new(
6923
+ :instance_id,
6924
+ :contact_id,
6925
+ :chat_streaming_configuration,
6926
+ :client_token)
6927
+ SENSITIVE = []
6928
+ include Aws::Structure
6929
+ end
6930
+
6931
+ # @!attribute [rw] streaming_id
6932
+ # The identifier of the streaming configuration enabled.
6933
+ # @return [String]
6934
+ #
6935
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartContactStreamingResponse AWS API Documentation
6936
+ #
6937
+ class StartContactStreamingResponse < Struct.new(
6938
+ :streaming_id)
6939
+ SENSITIVE = []
6940
+ include Aws::Structure
6941
+ end
6942
+
6338
6943
  # @note When making an API call, you may pass StartOutboundVoiceContactRequest
6339
6944
  # data as a hash:
6340
6945
  #
@@ -6469,11 +7074,12 @@ module Aws::Connect
6469
7074
  # references: {
6470
7075
  # "ReferenceKey" => {
6471
7076
  # value: "ReferenceValue", # required
6472
- # type: "URL", # required, accepts URL
7077
+ # type: "URL", # required, accepts URL, ATTACHMENT
6473
7078
  # },
6474
7079
  # },
6475
7080
  # description: "Description",
6476
7081
  # client_token: "ClientToken",
7082
+ # scheduled_time: Time.now,
6477
7083
  # }
6478
7084
  #
6479
7085
  # @!attribute [rw] instance_id
@@ -6529,6 +7135,12 @@ module Aws::Connect
6529
7135
  # not need to pass this option.
6530
7136
  # @return [String]
6531
7137
  #
7138
+ # @!attribute [rw] scheduled_time
7139
+ # The timestamp, in Unix Epoch seconds format, at which to start
7140
+ # running the inbound contact flow. The scheduled time cannot be in
7141
+ # the past. It must be within up to 6 days in future.
7142
+ # @return [Time]
7143
+ #
6532
7144
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartTaskContactRequest AWS API Documentation
6533
7145
  #
6534
7146
  class StartTaskContactRequest < Struct.new(
@@ -6539,7 +7151,8 @@ module Aws::Connect
6539
7151
  :name,
6540
7152
  :references,
6541
7153
  :description,
6542
- :client_token)
7154
+ :client_token,
7155
+ :scheduled_time)
6543
7156
  SENSITIVE = []
6544
7157
  include Aws::Structure
6545
7158
  end
@@ -6623,6 +7236,44 @@ module Aws::Connect
6623
7236
  #
6624
7237
  class StopContactResponse < Aws::EmptyStructure; end
6625
7238
 
7239
+ # @note When making an API call, you may pass StopContactStreamingRequest
7240
+ # data as a hash:
7241
+ #
7242
+ # {
7243
+ # instance_id: "InstanceId", # required
7244
+ # contact_id: "ContactId", # required
7245
+ # streaming_id: "StreamingId", # required
7246
+ # }
7247
+ #
7248
+ # @!attribute [rw] instance_id
7249
+ # The identifier of the Amazon Connect instance. You can find the
7250
+ # instanceId in the ARN of the instance.
7251
+ # @return [String]
7252
+ #
7253
+ # @!attribute [rw] contact_id
7254
+ # The identifier of the contact. This is the identifier of the contact
7255
+ # that is associated with the first interaction with the contact
7256
+ # center.
7257
+ # @return [String]
7258
+ #
7259
+ # @!attribute [rw] streaming_id
7260
+ # The identifier of the streaming configuration enabled.
7261
+ # @return [String]
7262
+ #
7263
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContactStreamingRequest AWS API Documentation
7264
+ #
7265
+ class StopContactStreamingRequest < Struct.new(
7266
+ :instance_id,
7267
+ :contact_id,
7268
+ :streaming_id)
7269
+ SENSITIVE = []
7270
+ include Aws::Structure
7271
+ end
7272
+
7273
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContactStreamingResponse AWS API Documentation
7274
+ #
7275
+ class StopContactStreamingResponse < Aws::EmptyStructure; end
7276
+
6626
7277
  # @note When making an API call, you may pass SuspendContactRecordingRequest
6627
7278
  # data as a hash:
6628
7279
  #
@@ -6928,6 +7579,99 @@ module Aws::Connect
6928
7579
  include Aws::Structure
6929
7580
  end
6930
7581
 
7582
+ # @note When making an API call, you may pass UpdateContactRequest
7583
+ # data as a hash:
7584
+ #
7585
+ # {
7586
+ # instance_id: "InstanceId", # required
7587
+ # contact_id: "ContactId", # required
7588
+ # name: "Name",
7589
+ # description: "Description",
7590
+ # references: {
7591
+ # "ReferenceKey" => {
7592
+ # value: "ReferenceValue", # required
7593
+ # type: "URL", # required, accepts URL, ATTACHMENT
7594
+ # },
7595
+ # },
7596
+ # }
7597
+ #
7598
+ # @!attribute [rw] instance_id
7599
+ # The identifier of the Amazon Connect instance. You can find the
7600
+ # instanceId in the ARN of the instance.
7601
+ # @return [String]
7602
+ #
7603
+ # @!attribute [rw] contact_id
7604
+ # The identifier of the contact. This is the identifier of the contact
7605
+ # associated with the first interaction with your contact center.
7606
+ # @return [String]
7607
+ #
7608
+ # @!attribute [rw] name
7609
+ # The name of the contact.
7610
+ # @return [String]
7611
+ #
7612
+ # @!attribute [rw] description
7613
+ # The description of the contact.
7614
+ # @return [String]
7615
+ #
7616
+ # @!attribute [rw] references
7617
+ # A formatted URL that is shown to an agent in the Contact Control
7618
+ # Panel (CCP).
7619
+ # @return [Hash<String,Types::Reference>]
7620
+ #
7621
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactRequest AWS API Documentation
7622
+ #
7623
+ class UpdateContactRequest < Struct.new(
7624
+ :instance_id,
7625
+ :contact_id,
7626
+ :name,
7627
+ :description,
7628
+ :references)
7629
+ SENSITIVE = []
7630
+ include Aws::Structure
7631
+ end
7632
+
7633
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactResponse AWS API Documentation
7634
+ #
7635
+ class UpdateContactResponse < Aws::EmptyStructure; end
7636
+
7637
+ # @note When making an API call, you may pass UpdateContactScheduleRequest
7638
+ # data as a hash:
7639
+ #
7640
+ # {
7641
+ # instance_id: "InstanceId", # required
7642
+ # contact_id: "ContactId", # required
7643
+ # scheduled_time: Time.now, # required
7644
+ # }
7645
+ #
7646
+ # @!attribute [rw] instance_id
7647
+ # The identifier of the Amazon Connect instance. You can find the
7648
+ # instanceId in the ARN of the instance.
7649
+ # @return [String]
7650
+ #
7651
+ # @!attribute [rw] contact_id
7652
+ # The identifier of the contact.
7653
+ # @return [String]
7654
+ #
7655
+ # @!attribute [rw] scheduled_time
7656
+ # The timestamp, in Unix Epoch seconds format, at which to start
7657
+ # running the inbound contact flow. The scheduled time cannot be in
7658
+ # the past. It must be within up to 6 days in future.
7659
+ # @return [Time]
7660
+ #
7661
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactScheduleRequest AWS API Documentation
7662
+ #
7663
+ class UpdateContactScheduleRequest < Struct.new(
7664
+ :instance_id,
7665
+ :contact_id,
7666
+ :scheduled_time)
7667
+ SENSITIVE = []
7668
+ include Aws::Structure
7669
+ end
7670
+
7671
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactScheduleResponse AWS API Documentation
7672
+ #
7673
+ class UpdateContactScheduleResponse < Aws::EmptyStructure; end
7674
+
6931
7675
  # @note When making an API call, you may pass UpdateHoursOfOperationRequest
6932
7676
  # data as a hash:
6933
7677
  #
@@ -7498,6 +8242,44 @@ module Aws::Connect
7498
8242
  include Aws::Structure
7499
8243
  end
7500
8244
 
8245
+ # @note When making an API call, you may pass UpdateSecurityProfileRequest
8246
+ # data as a hash:
8247
+ #
8248
+ # {
8249
+ # description: "SecurityProfileDescription",
8250
+ # permissions: ["SecurityProfilePermission"],
8251
+ # security_profile_id: "SecurityProfileId", # required
8252
+ # instance_id: "InstanceId", # required
8253
+ # }
8254
+ #
8255
+ # @!attribute [rw] description
8256
+ # The description of the security profile.
8257
+ # @return [String]
8258
+ #
8259
+ # @!attribute [rw] permissions
8260
+ # The permissions granted to a security profile.
8261
+ # @return [Array<String>]
8262
+ #
8263
+ # @!attribute [rw] security_profile_id
8264
+ # The identifier for the security profle.
8265
+ # @return [String]
8266
+ #
8267
+ # @!attribute [rw] instance_id
8268
+ # The identifier of the Amazon Connect instance. You can find the
8269
+ # instanceId in the ARN of the instance.
8270
+ # @return [String]
8271
+ #
8272
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateSecurityProfileRequest AWS API Documentation
8273
+ #
8274
+ class UpdateSecurityProfileRequest < Struct.new(
8275
+ :description,
8276
+ :permissions,
8277
+ :security_profile_id,
8278
+ :instance_id)
8279
+ SENSITIVE = []
8280
+ include Aws::Structure
8281
+ end
8282
+
7501
8283
  # @note When making an API call, you may pass UpdateUserHierarchyGroupNameRequest
7502
8284
  # data as a hash:
7503
8285
  #
@@ -7742,6 +8524,25 @@ module Aws::Connect
7742
8524
  include Aws::Structure
7743
8525
  end
7744
8526
 
8527
+ # The URL reference.
8528
+ #
8529
+ # @!attribute [rw] name
8530
+ # Identifier of the URL reference.
8531
+ # @return [String]
8532
+ #
8533
+ # @!attribute [rw] value
8534
+ # A valid URL.
8535
+ # @return [String]
8536
+ #
8537
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UrlReference AWS API Documentation
8538
+ #
8539
+ class UrlReference < Struct.new(
8540
+ :name,
8541
+ :value)
8542
+ SENSITIVE = []
8543
+ include Aws::Structure
8544
+ end
8545
+
7745
8546
  # Contains the use case.
7746
8547
  #
7747
8548
  # @!attribute [rw] use_case_id