aws-sdk-connect 1.19.0 → 1.20.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -25,6 +25,11 @@ module Aws::Connect
25
25
  ClientToken = Shapes::StringShape.new(name: 'ClientToken')
26
26
  Comparison = Shapes::StringShape.new(name: 'Comparison')
27
27
  ContactFlowId = Shapes::StringShape.new(name: 'ContactFlowId')
28
+ ContactFlowName = Shapes::StringShape.new(name: 'ContactFlowName')
29
+ ContactFlowSummary = Shapes::StructureShape.new(name: 'ContactFlowSummary')
30
+ ContactFlowSummaryList = Shapes::ListShape.new(name: 'ContactFlowSummaryList')
31
+ ContactFlowType = Shapes::StringShape.new(name: 'ContactFlowType')
32
+ ContactFlowTypes = Shapes::ListShape.new(name: 'ContactFlowTypes')
28
33
  ContactId = Shapes::StringShape.new(name: 'ContactId')
29
34
  ContactNotFoundException = Shapes::StructureShape.new(name: 'ContactNotFoundException')
30
35
  CreateUserRequest = Shapes::StructureShape.new(name: 'CreateUserRequest')
@@ -77,11 +82,23 @@ module Aws::Connect
77
82
  HistoricalMetricResult = Shapes::StructureShape.new(name: 'HistoricalMetricResult')
78
83
  HistoricalMetricResults = Shapes::ListShape.new(name: 'HistoricalMetricResults')
79
84
  HistoricalMetrics = Shapes::ListShape.new(name: 'HistoricalMetrics')
85
+ HoursOfOperationId = Shapes::StringShape.new(name: 'HoursOfOperationId')
86
+ HoursOfOperationName = Shapes::StringShape.new(name: 'HoursOfOperationName')
87
+ HoursOfOperationSummary = Shapes::StructureShape.new(name: 'HoursOfOperationSummary')
88
+ HoursOfOperationSummaryList = Shapes::ListShape.new(name: 'HoursOfOperationSummaryList')
80
89
  InstanceId = Shapes::StringShape.new(name: 'InstanceId')
81
90
  InternalServiceException = Shapes::StructureShape.new(name: 'InternalServiceException')
82
91
  InvalidParameterException = Shapes::StructureShape.new(name: 'InvalidParameterException')
83
92
  InvalidRequestException = Shapes::StructureShape.new(name: 'InvalidRequestException')
84
93
  LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
94
+ ListContactFlowsRequest = Shapes::StructureShape.new(name: 'ListContactFlowsRequest')
95
+ ListContactFlowsResponse = Shapes::StructureShape.new(name: 'ListContactFlowsResponse')
96
+ ListHoursOfOperationsRequest = Shapes::StructureShape.new(name: 'ListHoursOfOperationsRequest')
97
+ ListHoursOfOperationsResponse = Shapes::StructureShape.new(name: 'ListHoursOfOperationsResponse')
98
+ ListPhoneNumbersRequest = Shapes::StructureShape.new(name: 'ListPhoneNumbersRequest')
99
+ ListPhoneNumbersResponse = Shapes::StructureShape.new(name: 'ListPhoneNumbersResponse')
100
+ ListQueuesRequest = Shapes::StructureShape.new(name: 'ListQueuesRequest')
101
+ ListQueuesResponse = Shapes::StructureShape.new(name: 'ListQueuesResponse')
85
102
  ListRoutingProfilesRequest = Shapes::StructureShape.new(name: 'ListRoutingProfilesRequest')
86
103
  ListRoutingProfilesResponse = Shapes::StructureShape.new(name: 'ListRoutingProfilesResponse')
87
104
  ListSecurityProfilesRequest = Shapes::StructureShape.new(name: 'ListSecurityProfilesRequest')
@@ -97,9 +114,21 @@ module Aws::Connect
97
114
  OutboundContactNotPermittedException = Shapes::StructureShape.new(name: 'OutboundContactNotPermittedException')
98
115
  Password = Shapes::StringShape.new(name: 'Password')
99
116
  PhoneNumber = Shapes::StringShape.new(name: 'PhoneNumber')
117
+ PhoneNumberCountryCode = Shapes::StringShape.new(name: 'PhoneNumberCountryCode')
118
+ PhoneNumberCountryCodes = Shapes::ListShape.new(name: 'PhoneNumberCountryCodes')
119
+ PhoneNumberId = Shapes::StringShape.new(name: 'PhoneNumberId')
120
+ PhoneNumberSummary = Shapes::StructureShape.new(name: 'PhoneNumberSummary')
121
+ PhoneNumberSummaryList = Shapes::ListShape.new(name: 'PhoneNumberSummaryList')
122
+ PhoneNumberType = Shapes::StringShape.new(name: 'PhoneNumberType')
123
+ PhoneNumberTypes = Shapes::ListShape.new(name: 'PhoneNumberTypes')
100
124
  PhoneType = Shapes::StringShape.new(name: 'PhoneType')
101
125
  QueueId = Shapes::StringShape.new(name: 'QueueId')
126
+ QueueName = Shapes::StringShape.new(name: 'QueueName')
102
127
  QueueReference = Shapes::StructureShape.new(name: 'QueueReference')
128
+ QueueSummary = Shapes::StructureShape.new(name: 'QueueSummary')
129
+ QueueSummaryList = Shapes::ListShape.new(name: 'QueueSummaryList')
130
+ QueueType = Shapes::StringShape.new(name: 'QueueType')
131
+ QueueTypes = Shapes::ListShape.new(name: 'QueueTypes')
103
132
  Queues = Shapes::ListShape.new(name: 'Queues')
104
133
  ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
105
134
  RoutingProfileId = Shapes::StringShape.new(name: 'RoutingProfileId')
@@ -143,6 +172,16 @@ module Aws::Connect
143
172
 
144
173
  Channels.member = Shapes::ShapeRef.new(shape: Channel)
145
174
 
175
+ ContactFlowSummary.add_member(:id, Shapes::ShapeRef.new(shape: ContactFlowId, location_name: "Id"))
176
+ ContactFlowSummary.add_member(:arn, Shapes::ShapeRef.new(shape: ARN, location_name: "Arn"))
177
+ ContactFlowSummary.add_member(:name, Shapes::ShapeRef.new(shape: ContactFlowName, location_name: "Name"))
178
+ ContactFlowSummary.add_member(:contact_flow_type, Shapes::ShapeRef.new(shape: ContactFlowType, location_name: "ContactFlowType"))
179
+ ContactFlowSummary.struct_class = Types::ContactFlowSummary
180
+
181
+ ContactFlowSummaryList.member = Shapes::ShapeRef.new(shape: ContactFlowSummary)
182
+
183
+ ContactFlowTypes.member = Shapes::ShapeRef.new(shape: ContactFlowType)
184
+
146
185
  ContactNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
147
186
  ContactNotFoundException.struct_class = Types::ContactNotFoundException
148
187
 
@@ -318,6 +357,13 @@ module Aws::Connect
318
357
 
319
358
  HistoricalMetrics.member = Shapes::ShapeRef.new(shape: HistoricalMetric)
320
359
 
360
+ HoursOfOperationSummary.add_member(:id, Shapes::ShapeRef.new(shape: HoursOfOperationId, location_name: "Id"))
361
+ HoursOfOperationSummary.add_member(:arn, Shapes::ShapeRef.new(shape: ARN, location_name: "Arn"))
362
+ HoursOfOperationSummary.add_member(:name, Shapes::ShapeRef.new(shape: HoursOfOperationName, location_name: "Name"))
363
+ HoursOfOperationSummary.struct_class = Types::HoursOfOperationSummary
364
+
365
+ HoursOfOperationSummaryList.member = Shapes::ShapeRef.new(shape: HoursOfOperationSummary)
366
+
321
367
  InternalServiceException.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
322
368
  InternalServiceException.struct_class = Types::InternalServiceException
323
369
 
@@ -330,6 +376,46 @@ module Aws::Connect
330
376
  LimitExceededException.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
331
377
  LimitExceededException.struct_class = Types::LimitExceededException
332
378
 
379
+ ListContactFlowsRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
380
+ ListContactFlowsRequest.add_member(:contact_flow_types, Shapes::ShapeRef.new(shape: ContactFlowTypes, location: "querystring", location_name: "contactFlowTypes"))
381
+ ListContactFlowsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
382
+ ListContactFlowsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResult1000, location: "querystring", location_name: "maxResults"))
383
+ ListContactFlowsRequest.struct_class = Types::ListContactFlowsRequest
384
+
385
+ ListContactFlowsResponse.add_member(:contact_flow_summary_list, Shapes::ShapeRef.new(shape: ContactFlowSummaryList, location_name: "ContactFlowSummaryList"))
386
+ ListContactFlowsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
387
+ ListContactFlowsResponse.struct_class = Types::ListContactFlowsResponse
388
+
389
+ ListHoursOfOperationsRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
390
+ ListHoursOfOperationsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
391
+ ListHoursOfOperationsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResult1000, location: "querystring", location_name: "maxResults"))
392
+ ListHoursOfOperationsRequest.struct_class = Types::ListHoursOfOperationsRequest
393
+
394
+ ListHoursOfOperationsResponse.add_member(:hours_of_operation_summary_list, Shapes::ShapeRef.new(shape: HoursOfOperationSummaryList, location_name: "HoursOfOperationSummaryList"))
395
+ ListHoursOfOperationsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
396
+ ListHoursOfOperationsResponse.struct_class = Types::ListHoursOfOperationsResponse
397
+
398
+ ListPhoneNumbersRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
399
+ ListPhoneNumbersRequest.add_member(:phone_number_types, Shapes::ShapeRef.new(shape: PhoneNumberTypes, location: "querystring", location_name: "phoneNumberTypes"))
400
+ ListPhoneNumbersRequest.add_member(:phone_number_country_codes, Shapes::ShapeRef.new(shape: PhoneNumberCountryCodes, location: "querystring", location_name: "phoneNumberCountryCodes"))
401
+ ListPhoneNumbersRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
402
+ ListPhoneNumbersRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResult1000, location: "querystring", location_name: "maxResults"))
403
+ ListPhoneNumbersRequest.struct_class = Types::ListPhoneNumbersRequest
404
+
405
+ ListPhoneNumbersResponse.add_member(:phone_number_summary_list, Shapes::ShapeRef.new(shape: PhoneNumberSummaryList, location_name: "PhoneNumberSummaryList"))
406
+ ListPhoneNumbersResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
407
+ ListPhoneNumbersResponse.struct_class = Types::ListPhoneNumbersResponse
408
+
409
+ ListQueuesRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
410
+ ListQueuesRequest.add_member(:queue_types, Shapes::ShapeRef.new(shape: QueueTypes, location: "querystring", location_name: "queueTypes"))
411
+ ListQueuesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
412
+ ListQueuesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResult1000, location: "querystring", location_name: "maxResults"))
413
+ ListQueuesRequest.struct_class = Types::ListQueuesRequest
414
+
415
+ ListQueuesResponse.add_member(:queue_summary_list, Shapes::ShapeRef.new(shape: QueueSummaryList, location_name: "QueueSummaryList"))
416
+ ListQueuesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
417
+ ListQueuesResponse.struct_class = Types::ListQueuesResponse
418
+
333
419
  ListRoutingProfilesRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
334
420
  ListRoutingProfilesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
335
421
  ListRoutingProfilesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResult1000, location: "querystring", location_name: "maxResults", metadata: {"box"=>true}))
@@ -369,10 +455,33 @@ module Aws::Connect
369
455
  OutboundContactNotPermittedException.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
370
456
  OutboundContactNotPermittedException.struct_class = Types::OutboundContactNotPermittedException
371
457
 
458
+ PhoneNumberCountryCodes.member = Shapes::ShapeRef.new(shape: PhoneNumberCountryCode)
459
+
460
+ PhoneNumberSummary.add_member(:id, Shapes::ShapeRef.new(shape: PhoneNumberId, location_name: "Id"))
461
+ PhoneNumberSummary.add_member(:arn, Shapes::ShapeRef.new(shape: ARN, location_name: "Arn"))
462
+ PhoneNumberSummary.add_member(:phone_number, Shapes::ShapeRef.new(shape: PhoneNumber, location_name: "PhoneNumber"))
463
+ PhoneNumberSummary.add_member(:phone_number_type, Shapes::ShapeRef.new(shape: PhoneNumberType, location_name: "PhoneNumberType"))
464
+ PhoneNumberSummary.add_member(:phone_number_country_code, Shapes::ShapeRef.new(shape: PhoneNumberCountryCode, location_name: "PhoneNumberCountryCode"))
465
+ PhoneNumberSummary.struct_class = Types::PhoneNumberSummary
466
+
467
+ PhoneNumberSummaryList.member = Shapes::ShapeRef.new(shape: PhoneNumberSummary)
468
+
469
+ PhoneNumberTypes.member = Shapes::ShapeRef.new(shape: PhoneNumberType)
470
+
372
471
  QueueReference.add_member(:id, Shapes::ShapeRef.new(shape: QueueId, location_name: "Id"))
373
472
  QueueReference.add_member(:arn, Shapes::ShapeRef.new(shape: ARN, location_name: "Arn"))
374
473
  QueueReference.struct_class = Types::QueueReference
375
474
 
475
+ QueueSummary.add_member(:id, Shapes::ShapeRef.new(shape: QueueId, location_name: "Id"))
476
+ QueueSummary.add_member(:arn, Shapes::ShapeRef.new(shape: ARN, location_name: "Arn"))
477
+ QueueSummary.add_member(:name, Shapes::ShapeRef.new(shape: QueueName, location_name: "Name"))
478
+ QueueSummary.add_member(:queue_type, Shapes::ShapeRef.new(shape: QueueType, location_name: "QueueType"))
479
+ QueueSummary.struct_class = Types::QueueSummary
480
+
481
+ QueueSummaryList.member = Shapes::ShapeRef.new(shape: QueueSummary)
482
+
483
+ QueueTypes.member = Shapes::ShapeRef.new(shape: QueueType)
484
+
376
485
  Queues.member = Shapes::ShapeRef.new(shape: QueueId)
377
486
 
378
487
  ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
@@ -632,6 +741,82 @@ module Aws::Connect
632
741
  )
633
742
  end)
634
743
 
744
+ api.add_operation(:list_contact_flows, Seahorse::Model::Operation.new.tap do |o|
745
+ o.name = "ListContactFlows"
746
+ o.http_method = "GET"
747
+ o.http_request_uri = "/contact-flows-summary/{InstanceId}"
748
+ o.input = Shapes::ShapeRef.new(shape: ListContactFlowsRequest)
749
+ o.output = Shapes::ShapeRef.new(shape: ListContactFlowsResponse)
750
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
751
+ o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
752
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
753
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
754
+ o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
755
+ o[:pager] = Aws::Pager.new(
756
+ limit_key: "max_results",
757
+ tokens: {
758
+ "next_token" => "next_token"
759
+ }
760
+ )
761
+ end)
762
+
763
+ api.add_operation(:list_hours_of_operations, Seahorse::Model::Operation.new.tap do |o|
764
+ o.name = "ListHoursOfOperations"
765
+ o.http_method = "GET"
766
+ o.http_request_uri = "/hours-of-operations-summary/{InstanceId}"
767
+ o.input = Shapes::ShapeRef.new(shape: ListHoursOfOperationsRequest)
768
+ o.output = Shapes::ShapeRef.new(shape: ListHoursOfOperationsResponse)
769
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
770
+ o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
771
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
772
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
773
+ o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
774
+ o[:pager] = Aws::Pager.new(
775
+ limit_key: "max_results",
776
+ tokens: {
777
+ "next_token" => "next_token"
778
+ }
779
+ )
780
+ end)
781
+
782
+ api.add_operation(:list_phone_numbers, Seahorse::Model::Operation.new.tap do |o|
783
+ o.name = "ListPhoneNumbers"
784
+ o.http_method = "GET"
785
+ o.http_request_uri = "/phone-numbers-summary/{InstanceId}"
786
+ o.input = Shapes::ShapeRef.new(shape: ListPhoneNumbersRequest)
787
+ o.output = Shapes::ShapeRef.new(shape: ListPhoneNumbersResponse)
788
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
789
+ o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
790
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
791
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
792
+ o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
793
+ o[:pager] = Aws::Pager.new(
794
+ limit_key: "max_results",
795
+ tokens: {
796
+ "next_token" => "next_token"
797
+ }
798
+ )
799
+ end)
800
+
801
+ api.add_operation(:list_queues, Seahorse::Model::Operation.new.tap do |o|
802
+ o.name = "ListQueues"
803
+ o.http_method = "GET"
804
+ o.http_request_uri = "/queues-summary/{InstanceId}"
805
+ o.input = Shapes::ShapeRef.new(shape: ListQueuesRequest)
806
+ o.output = Shapes::ShapeRef.new(shape: ListQueuesResponse)
807
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
808
+ o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
809
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
810
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
811
+ o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
812
+ o[:pager] = Aws::Pager.new(
813
+ limit_key: "max_results",
814
+ tokens: {
815
+ "next_token" => "next_token"
816
+ }
817
+ )
818
+ end)
819
+
635
820
  api.add_operation(:list_routing_profiles, Seahorse::Model::Operation.new.tap do |o|
636
821
  o.name = "ListRoutingProfiles"
637
822
  o.http_method = "GET"
@@ -643,6 +828,12 @@ module Aws::Connect
643
828
  o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
644
829
  o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
645
830
  o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
831
+ o[:pager] = Aws::Pager.new(
832
+ limit_key: "max_results",
833
+ tokens: {
834
+ "next_token" => "next_token"
835
+ }
836
+ )
646
837
  end)
647
838
 
648
839
  api.add_operation(:list_security_profiles, Seahorse::Model::Operation.new.tap do |o|
@@ -656,6 +847,12 @@ module Aws::Connect
656
847
  o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
657
848
  o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
658
849
  o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
850
+ o[:pager] = Aws::Pager.new(
851
+ limit_key: "max_results",
852
+ tokens: {
853
+ "next_token" => "next_token"
854
+ }
855
+ )
659
856
  end)
660
857
 
661
858
  api.add_operation(:list_user_hierarchy_groups, Seahorse::Model::Operation.new.tap do |o|
@@ -669,6 +866,12 @@ module Aws::Connect
669
866
  o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
670
867
  o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
671
868
  o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
869
+ o[:pager] = Aws::Pager.new(
870
+ limit_key: "max_results",
871
+ tokens: {
872
+ "next_token" => "next_token"
873
+ }
874
+ )
672
875
  end)
673
876
 
674
877
  api.add_operation(:list_users, Seahorse::Model::Operation.new.tap do |o|
@@ -682,6 +885,12 @@ module Aws::Connect
682
885
  o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
683
886
  o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
684
887
  o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
888
+ o[:pager] = Aws::Pager.new(
889
+ limit_key: "max_results",
890
+ tokens: {
891
+ "next_token" => "next_token"
892
+ }
893
+ )
685
894
  end)
686
895
 
687
896
  api.add_operation(:start_outbound_voice_contact, Seahorse::Model::Operation.new.tap do |o|
@@ -8,6 +8,34 @@
8
8
  module Aws::Connect
9
9
  module Types
10
10
 
11
+ # Contains summary information about a contact flow.
12
+ #
13
+ # @!attribute [rw] id
14
+ # The identifier of the contact flow.
15
+ # @return [String]
16
+ #
17
+ # @!attribute [rw] arn
18
+ # The Amazon Resource Name (ARN) of the contact flow.
19
+ # @return [String]
20
+ #
21
+ # @!attribute [rw] name
22
+ # The name of the contact flow.
23
+ # @return [String]
24
+ #
25
+ # @!attribute [rw] contact_flow_type
26
+ # The type of contact flow.
27
+ # @return [String]
28
+ #
29
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactFlowSummary AWS API Documentation
30
+ #
31
+ class ContactFlowSummary < Struct.new(
32
+ :id,
33
+ :arn,
34
+ :name,
35
+ :contact_flow_type)
36
+ include Aws::Structure
37
+ end
38
+
11
39
  # The contact with the specified ID is not active or does not exist.
12
40
  #
13
41
  # @!attribute [rw] message
@@ -46,69 +74,55 @@ module Aws::Connect
46
74
  # }
47
75
  #
48
76
  # @!attribute [rw] username
49
- # The user name in Amazon Connect for the account to create. If you
50
- # are using SAML for identity management in your Amazon Connect, the
51
- # value for `Username` can include up to 64 characters from
52
- # \[a-zA-Z0-9\_-.\\@\]+.
77
+ # The user name for the account. For instances not using SAML for
78
+ # identity management, the user name can include up to 20 characters.
79
+ # If you are using SAML for identity management, the user name can
80
+ # include up to 64 characters from \[a-zA-Z0-9\_-.\\@\]+.
53
81
  # @return [String]
54
82
  #
55
83
  # @!attribute [rw] password
56
- # The password for the user account to create. This is required if you
57
- # are using Amazon Connect for identity management. If you are using
58
- # SAML for identity management and include this parameter, an
59
- # `InvalidRequestException` is returned.
84
+ # The password for the user account. A password is required if you are
85
+ # using Amazon Connect for identity management. Otherwise, it is an
86
+ # error to include a password.
60
87
  # @return [String]
61
88
  #
62
89
  # @!attribute [rw] identity_info
63
- # Information about the user, including email address, first name, and
64
- # last name.
90
+ # The information about the identity of the user.
65
91
  # @return [Types::UserIdentityInfo]
66
92
  #
67
93
  # @!attribute [rw] phone_config
68
- # Specifies the phone settings for the user, including
69
- # `AfterContactWorkTimeLimit`, `AutoAccept`, `DeskPhoneNumber`, and
70
- # `PhoneType`.
94
+ # The phone settings for the user.
71
95
  # @return [Types::UserPhoneConfig]
72
96
  #
73
97
  # @!attribute [rw] directory_user_id
74
- # The unique identifier for the user account in the directory service
75
- # directory used for identity management. If Amazon Connect is unable
76
- # to access the existing directory, you can use the `DirectoryUserId`
77
- # to authenticate users. If you include the parameter, it is assumed
78
- # that Amazon Connect cannot access the directory. If the parameter is
79
- # not included, the `UserIdentityInfo` is used to authenticate users
80
- # from your existing directory.
98
+ # The identifier of the user account in the directory used for
99
+ # identity management. If Amazon Connect cannot access the directory,
100
+ # you can specify this identifier to authenticate users. If you
101
+ # include the identifier, we assume that Amazon Connect cannot access
102
+ # the directory. Otherwise, the identity information is used to
103
+ # authenticate users from your directory.
81
104
  #
82
105
  # This parameter is required if you are using an existing directory
83
106
  # for identity management in Amazon Connect when Amazon Connect cannot
84
107
  # access your directory to authenticate users. If you are using SAML
85
- # for identity management and include this parameter, an
86
- # `InvalidRequestException` is returned.
108
+ # for identity management and include this parameter, an error is
109
+ # returned.
87
110
  # @return [String]
88
111
  #
89
112
  # @!attribute [rw] security_profile_ids
90
- # The unique identifier of the security profile to assign to the user
91
- # created.
113
+ # The identifier of the security profile for the user.
92
114
  # @return [Array<String>]
93
115
  #
94
116
  # @!attribute [rw] routing_profile_id
95
- # The unique identifier for the routing profile to assign to the user
96
- # created.
117
+ # The identifier of the routing profile for the user.
97
118
  # @return [String]
98
119
  #
99
120
  # @!attribute [rw] hierarchy_group_id
100
- # The unique identifier for the hierarchy group to assign to the user
101
- # created.
121
+ # The identifier of the hierarchy group for the user.
102
122
  # @return [String]
103
123
  #
104
124
  # @!attribute [rw] instance_id
105
- # The identifier for your Amazon Connect instance. To find the ID of
106
- # your instance, open the AWS console and select Amazon Connect.
107
- # Select the alias of the instance in the Instance alias column. The
108
- # instance ID is displayed in the Overview section of your instance
109
- # settings. For example, the instance ID is the set of characters at
110
- # the end of the instance ARN, after instance/, such as
111
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
125
+ # The identifier of the Amazon Connect instance.
112
126
  # @return [String]
113
127
  #
114
128
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUserRequest AWS API Documentation
@@ -127,11 +141,11 @@ module Aws::Connect
127
141
  end
128
142
 
129
143
  # @!attribute [rw] user_id
130
- # The unique identifier for the user account in Amazon Connect
144
+ # The identifier of the user account.
131
145
  # @return [String]
132
146
  #
133
147
  # @!attribute [rw] user_arn
134
- # The Amazon Resource Name (ARN) of the user account created.
148
+ # The Amazon Resource Name (ARN) of the user account.
135
149
  # @return [String]
136
150
  #
137
151
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUserResponse AWS API Documentation
@@ -142,16 +156,16 @@ module Aws::Connect
142
156
  include Aws::Structure
143
157
  end
144
158
 
145
- # The credentials to use for federation.
159
+ # Contains credentials to use for federation.
146
160
  #
147
161
  # @!attribute [rw] access_token
148
162
  # An access token generated for a federated user to access Amazon
149
- # Connect
163
+ # Connect.
150
164
  # @return [String]
151
165
  #
152
166
  # @!attribute [rw] access_token_expiration
153
167
  # A token generated with an expiration time for the session a user is
154
- # logged in to Amazon Connect
168
+ # logged in to Amazon Connect.
155
169
  # @return [Time]
156
170
  #
157
171
  # @!attribute [rw] refresh_token
@@ -173,8 +187,7 @@ module Aws::Connect
173
187
  include Aws::Structure
174
188
  end
175
189
 
176
- # A `CurrentMetric` object that contains the Name and Unit for the
177
- # metric.
190
+ # Contains information about a real-time metric.
178
191
  #
179
192
  # @note When making an API call, you may pass CurrentMetric
180
193
  # data as a hash:
@@ -200,14 +213,14 @@ module Aws::Connect
200
213
  include Aws::Structure
201
214
  end
202
215
 
203
- # A `CurrentMetricData` object.
216
+ # Contains the data for a real-time metric.
204
217
  #
205
218
  # @!attribute [rw] metric
206
- # The metric in a `CurrentMetricData` object.
219
+ # Information about the metric.
207
220
  # @return [Types::CurrentMetric]
208
221
  #
209
222
  # @!attribute [rw] value
210
- # The value of the metric in the CurrentMetricData object.
223
+ # The value of the metric.
211
224
  # @return [Float]
212
225
  #
213
226
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CurrentMetricData AWS API Documentation
@@ -218,14 +231,14 @@ module Aws::Connect
218
231
  include Aws::Structure
219
232
  end
220
233
 
221
- # A `CurrentMetricResult` object.
234
+ # Contains information about a set of real-time metrics.
222
235
  #
223
236
  # @!attribute [rw] dimensions
224
- # The `Dimensions` for the `CurrentMetricResult` object.
237
+ # The dimensions for the metrics.
225
238
  # @return [Types::Dimensions]
226
239
  #
227
240
  # @!attribute [rw] collections
228
- # The `Collections` for the `CurrentMetricResult` object.
241
+ # The set of metrics.
229
242
  # @return [Array<Types::CurrentMetricData>]
230
243
  #
231
244
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CurrentMetricResult AWS API Documentation
@@ -245,17 +258,11 @@ module Aws::Connect
245
258
  # }
246
259
  #
247
260
  # @!attribute [rw] instance_id
248
- # The identifier for your Amazon Connect instance. To find the ID of
249
- # your instance, open the AWS console and select Amazon Connect.
250
- # Select the alias of the instance in the Instance alias column. The
251
- # instance ID is displayed in the Overview section of your instance
252
- # settings. For example, the instance ID is the set of characters at
253
- # the end of the instance ARN, after instance/, such as
254
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
261
+ # The identifier of the Amazon Connect instance.
255
262
  # @return [String]
256
263
  #
257
264
  # @!attribute [rw] user_id
258
- # The unique identifier of the user to delete.
265
+ # The identifier of the user.
259
266
  # @return [String]
260
267
  #
261
268
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteUserRequest AWS API Documentation
@@ -275,17 +282,11 @@ module Aws::Connect
275
282
  # }
276
283
  #
277
284
  # @!attribute [rw] hierarchy_group_id
278
- # The identifier for the hierarchy group to return.
285
+ # The identifier of the hierarchy group.
279
286
  # @return [String]
280
287
  #
281
288
  # @!attribute [rw] instance_id
282
- # The identifier for your Amazon Connect instance. To find the ID of
283
- # your instance, open the AWS console and select Amazon Connect.
284
- # Select the alias of the instance in the Instance alias column. The
285
- # instance ID is displayed in the Overview section of your instance
286
- # settings. For example, the instance ID is the set of characters at
287
- # the end of the instance ARN, after instance/, such as
288
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
289
+ # The identifier of the Amazon Connect instance.
289
290
  # @return [String]
290
291
  #
291
292
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyGroupRequest AWS API Documentation
@@ -297,7 +298,7 @@ module Aws::Connect
297
298
  end
298
299
 
299
300
  # @!attribute [rw] hierarchy_group
300
- # Returns a `HierarchyGroup` object.
301
+ # Information about the hierarchy group.
301
302
  # @return [Types::HierarchyGroup]
302
303
  #
303
304
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyGroupResponse AWS API Documentation
@@ -315,13 +316,7 @@ module Aws::Connect
315
316
  # }
316
317
  #
317
318
  # @!attribute [rw] instance_id
318
- # The identifier for your Amazon Connect instance. To find the ID of
319
- # your instance, open the AWS console and select Amazon Connect.
320
- # Select the alias of the instance in the Instance alias column. The
321
- # instance ID is displayed in the Overview section of your instance
322
- # settings. For example, the instance ID is the set of characters at
323
- # the end of the instance ARN, after instance/, such as
324
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
319
+ # The identifier of the Amazon Connect instance.
325
320
  # @return [String]
326
321
  #
327
322
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyStructureRequest AWS API Documentation
@@ -332,7 +327,7 @@ module Aws::Connect
332
327
  end
333
328
 
334
329
  # @!attribute [rw] hierarchy_structure
335
- # A `HierarchyStructure` object.
330
+ # Information about the hierarchy structure.
336
331
  # @return [Types::HierarchyStructure]
337
332
  #
338
333
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyStructureResponse AWS API Documentation
@@ -351,17 +346,11 @@ module Aws::Connect
351
346
  # }
352
347
  #
353
348
  # @!attribute [rw] user_id
354
- # Unique identifier for the user account to return.
349
+ # The identifier of the user account.
355
350
  # @return [String]
356
351
  #
357
352
  # @!attribute [rw] instance_id
358
- # The identifier for your Amazon Connect instance. To find the ID of
359
- # your instance, open the AWS console and select Amazon Connect.
360
- # Select the alias of the instance in the Instance alias column. The
361
- # instance ID is displayed in the Overview section of your instance
362
- # settings. For example, the instance ID is the set of characters at
363
- # the end of the instance ARN, after instance/, such as
364
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
353
+ # The identifier of the Amazon Connect instance.
365
354
  # @return [String]
366
355
  #
367
356
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserRequest AWS API Documentation
@@ -373,8 +362,7 @@ module Aws::Connect
373
362
  end
374
363
 
375
364
  # @!attribute [rw] user
376
- # A `User` object that contains information about the user account and
377
- # configuration settings.
365
+ # Information about the user account and configuration settings.
378
366
  # @return [Types::User]
379
367
  #
380
368
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserResponse AWS API Documentation
@@ -397,16 +385,14 @@ module Aws::Connect
397
385
  include Aws::Structure
398
386
  end
399
387
 
400
- # A `Dimensions` object that includes the Channel and Queue for the
401
- # metric.
388
+ # Contains information about the dimensions for a set of metrics.
402
389
  #
403
390
  # @!attribute [rw] queue
404
- # A `QueueReference` object used as one part of dimension for the
405
- # metrics results.
391
+ # Information about the queue for which metrics are returned.
406
392
  # @return [Types::QueueReference]
407
393
  #
408
394
  # @!attribute [rw] channel
409
- # The channel used for grouping and filters. Only VOICE is supported.
395
+ # The channel used for grouping and filters.
410
396
  # @return [String]
411
397
  #
412
398
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Dimensions AWS API Documentation
@@ -417,7 +403,7 @@ module Aws::Connect
417
403
  include Aws::Structure
418
404
  end
419
405
 
420
- # A resource with that name already exists.
406
+ # A resource with the specified name already exists.
421
407
  #
422
408
  # @!attribute [rw] message
423
409
  # @return [String]
@@ -429,8 +415,7 @@ module Aws::Connect
429
415
  include Aws::Structure
430
416
  end
431
417
 
432
- # The filter, either channel or queues, to apply to the metric results
433
- # retrieved.
418
+ # Contains the filter to apply when retrieving metrics.
434
419
  #
435
420
  # @note When making an API call, you may pass Filters
436
421
  # data as a hash:
@@ -441,13 +426,12 @@ module Aws::Connect
441
426
  # }
442
427
  #
443
428
  # @!attribute [rw] queues
444
- # A list of up to 100 queue IDs or queue ARNs to use to filter the
445
- # metrics retrieved. You can include both IDs and ARNs in a request.
429
+ # The queues to use to filter the metrics. You can specify up to 100
430
+ # queues per request.
446
431
  # @return [Array<String>]
447
432
  #
448
433
  # @!attribute [rw] channels
449
- # The Channel to use as a filter for the metrics returned. Only VOICE
450
- # is supported.
434
+ # The channel to use to filter the metrics.
451
435
  # @return [Array<String>]
452
436
  #
453
437
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Filters AWS API Documentation
@@ -467,13 +451,11 @@ module Aws::Connect
467
451
  # }
468
452
  #
469
453
  # @!attribute [rw] instance_id
470
- # The instance ID for the instance from which to retrieve contact
471
- # attributes.
454
+ # The identifier of the Amazon Connect instance.
472
455
  # @return [String]
473
456
  #
474
457
  # @!attribute [rw] initial_contact_id
475
- # The ID for the initial contact in Amazon Connect associated with the
476
- # attributes to update.
458
+ # The identifier of the initial contact.
477
459
  # @return [String]
478
460
  #
479
461
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetContactAttributesRequest AWS API Documentation
@@ -485,7 +467,7 @@ module Aws::Connect
485
467
  end
486
468
 
487
469
  # @!attribute [rw] attributes
488
- # The attributes to update.
470
+ # Information about the attributes.
489
471
  # @return [Hash<String,String>]
490
472
  #
491
473
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetContactAttributesResponse AWS API Documentation
@@ -516,76 +498,57 @@ module Aws::Connect
516
498
  # }
517
499
  #
518
500
  # @!attribute [rw] instance_id
519
- # The identifier for your Amazon Connect instance. To find the ID of
520
- # your instance, open the AWS console and select Amazon Connect.
521
- # Select the alias of the instance in the Instance alias column. The
522
- # instance ID is displayed in the Overview section of your instance
523
- # settings. For example, the instance ID is the set of characters at
524
- # the end of the instance ARN, after instance/, such as
525
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
501
+ # The identifier of the Amazon Connect instance.
526
502
  # @return [String]
527
503
  #
528
504
  # @!attribute [rw] filters
529
- # A `Filters` object that contains a list of queue IDs or queue ARNs,
530
- # up to 100, or list of Channels to use to filter the metrics returned
531
- # in the response. Metric data is retrieved only for the resources
532
- # associated with the queue IDs, ARNs, or Channels included in the
533
- # filter. You can include both IDs and ARNs in the same request. To
534
- # retrieve metrics for all queues, add the queue ID or ARN for each
535
- # queue in your instance. Only VOICE is supported for Channels.
536
- #
537
- # To find the ARN for a queue, open the queue you want to use in the
538
- # Amazon Connect Queue editor. The ARN for the queue is displayed in
539
- # the address bar as part of the URL. For example, the queue ARN is
540
- # the set of characters at the end of the URL, after 'id=' such as
541
- # `arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61`.
542
- # The queue ID is also included in the URL, and is the string after
543
- # 'queue/'.
505
+ # The queues, up to 100, or channels, to use to filter the metrics
506
+ # returned. Metric data is retrieved only for the resources associated
507
+ # with the queues or channels included in the filter. You can include
508
+ # both queue IDs and queue ARNs in the same request. The only
509
+ # supported channel is `VOICE`.
544
510
  # @return [Types::Filters]
545
511
  #
546
512
  # @!attribute [rw] groupings
547
513
  # The grouping applied to the metrics returned. For example, when
548
- # grouped by QUEUE, the metrics returned apply to each queue rather
549
- # than aggregated for all queues. If you group by CHANNEL, you should
550
- # include a Channels filter. The only supported channel is VOICE.
514
+ # grouped by `QUEUE`, the metrics returned apply to each queue rather
515
+ # than aggregated for all queues. If you group by `CHANNEL`, you
516
+ # should include a Channels filter. The only supported channel is
517
+ # `VOICE`.
551
518
  #
552
- # If no `Grouping` is included in the request, a summary of
553
- # `CurrentMetrics` is returned.
519
+ # If no `Grouping` is included in the request, a summary of metrics is
520
+ # returned.
554
521
  # @return [Array<String>]
555
522
  #
556
523
  # @!attribute [rw] current_metrics
557
- # A list of `CurrentMetric` objects for the metrics to retrieve. Each
558
- # `CurrentMetric` includes a name of a metric to retrieve and the unit
559
- # to use for it. You must list each metric to retrieve data for in the
560
- # request.
561
- #
524
+ # The metrics to retrieve. Specify the name and unit for each metric.
562
525
  # The following metrics are available:
563
526
  #
564
- # AGENTS\_AVAILABLE
527
+ # AGENTS\_AFTER\_CONTACT\_WORK
565
528
  #
566
529
  # : Unit: COUNT
567
530
  #
568
- # AGENTS\_ONLINE
531
+ # AGENTS\_AVAILABLE
569
532
  #
570
533
  # : Unit: COUNT
571
534
  #
572
- # AGENTS\_ON\_CALL
535
+ # AGENTS\_ERROR
573
536
  #
574
537
  # : Unit: COUNT
575
538
  #
576
- # AGENTS\_STAFFED
539
+ # AGENTS\_NON\_PRODUCTIVE
577
540
  #
578
541
  # : Unit: COUNT
579
542
  #
580
- # AGENTS\_AFTER\_CONTACT\_WORK
543
+ # AGENTS\_ON\_CALL
581
544
  #
582
545
  # : Unit: COUNT
583
546
  #
584
- # AGENTS\_NON\_PRODUCTIVE
547
+ # AGENTS\_ONLINE
585
548
  #
586
549
  # : Unit: COUNT
587
550
  #
588
- # AGENTS\_ERROR
551
+ # AGENTS\_STAFFED
589
552
  #
590
553
  # : Unit: COUNT
591
554
  #
@@ -593,13 +556,13 @@ module Aws::Connect
593
556
  #
594
557
  # : Unit: COUNT
595
558
  #
596
- # OLDEST\_CONTACT\_AGE
597
- #
598
- # : Unit: SECONDS
599
- #
600
559
  # CONTACTS\_SCHEDULED
601
560
  #
602
561
  # : Unit: COUNT
562
+ #
563
+ # OLDEST\_CONTACT\_AGE
564
+ #
565
+ # : Unit: SECONDS
603
566
  # @return [Array<Types::CurrentMetric>]
604
567
  #
605
568
  # @!attribute [rw] next_token
@@ -608,13 +571,12 @@ module Aws::Connect
608
571
  # results.
609
572
  #
610
573
  # The token expires after 5 minutes from the time it is created.
611
- # Subsequent requests that use the [NextToken]() must use the same
612
- # request parameters as the request that generated the token.
574
+ # Subsequent requests that use the token must use the same request
575
+ # parameters as the request that generated the token.
613
576
  # @return [String]
614
577
  #
615
578
  # @!attribute [rw] max_results
616
- # `MaxResults` indicates the maximum number of results to return per
617
- # page in the response, between 1 and 100.
579
+ # The maximimum number of results to return per page.
618
580
  # @return [Integer]
619
581
  #
620
582
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetCurrentMetricDataRequest AWS API Documentation
@@ -630,32 +592,20 @@ module Aws::Connect
630
592
  end
631
593
 
632
594
  # @!attribute [rw] next_token
633
- # A string returned in the response. Use the value returned in the
634
- # response as the value of the NextToken in a subsequent request to
635
- # retrieve the next set of results.
595
+ # If there are additional results, this is the token for the next set
596
+ # of results.
636
597
  #
637
598
  # The token expires after 5 minutes from the time it is created.
638
- # Subsequent requests that use the NextToken must use the same request
599
+ # Subsequent requests that use the token must use the same request
639
600
  # parameters as the request that generated the token.
640
601
  # @return [String]
641
602
  #
642
603
  # @!attribute [rw] metric_results
643
- # A list of `CurrentMetricResult` objects organized by `Dimensions`
644
- # combining with `CurrentMetricDataCollections`.
645
- #
646
- # `Dimensions` is the resourceId specified in the `Filters` of the
647
- # request.
648
- #
649
- # `Collections` is a list of `CurrentMetricData` objects with
650
- # corresponding values to the `CurrentMetrics` specified in the
651
- # request.
652
- #
653
- # If no `Grouping` is specified in the request, `Collections` is a
654
- # summary for the `CurrentMetric` returned.
604
+ # Information about the real-time metrics.
655
605
  # @return [Array<Types::CurrentMetricResult>]
656
606
  #
657
607
  # @!attribute [rw] data_snapshot_time
658
- # The time at which `CurrentMetricData` was retrieved and cached for
608
+ # The time at which the metrics were retrieved and cached for
659
609
  # pagination.
660
610
  # @return [Time]
661
611
  #
@@ -676,13 +626,7 @@ module Aws::Connect
676
626
  # }
677
627
  #
678
628
  # @!attribute [rw] instance_id
679
- # The identifier for your Amazon Connect instance. To find the ID of
680
- # your instance, open the AWS console and select Amazon Connect.
681
- # Select the alias of the instance in the Instance alias column. The
682
- # instance ID is displayed in the Overview section of your instance
683
- # settings. For example, the instance ID is the set of characters at
684
- # the end of the instance ARN, after instance/, such as
685
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
629
+ # The identifier of the Amazon Connect instance.
686
630
  # @return [String]
687
631
  #
688
632
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetFederationTokenRequest AWS API Documentation
@@ -731,13 +675,7 @@ module Aws::Connect
731
675
  # }
732
676
  #
733
677
  # @!attribute [rw] instance_id
734
- # The identifier for your Amazon Connect instance. To find the ID of
735
- # your instance, open the AWS console and select Amazon Connect.
736
- # Select the alias of the instance in the Instance alias column. The
737
- # instance ID is displayed in the Overview section of your instance
738
- # settings. For example, the instance ID is the set of characters at
739
- # the end of the instance ARN, after instance/, such as
740
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
678
+ # The identifier of the Amazon Connect instance.
741
679
  # @return [String]
742
680
  #
743
681
  # @!attribute [rw] start_time
@@ -746,219 +684,194 @@ module Aws::Connect
746
684
  # time must be specified using a multiple of 5 minutes, such as 10:05,
747
685
  # 10:10, 10:15.
748
686
  #
749
- # `StartTime` cannot be earlier than 24 hours before the time of the
750
- # request. Historical metrics are available in Amazon Connect only for
751
- # 24 hours.
687
+ # The start time cannot be earlier than 24 hours before the time of
688
+ # the request. Historical metrics are available only for 24 hours.
752
689
  # @return [Time]
753
690
  #
754
691
  # @!attribute [rw] end_time
755
692
  # The timestamp, in UNIX Epoch time format, at which to end the
756
693
  # reporting interval for the retrieval of historical metrics data. The
757
694
  # time must be specified using an interval of 5 minutes, such as
758
- # 11:00, 11:05, 11:10, and must be later than the `StartTime`
695
+ # 11:00, 11:05, 11:10, and must be later than the start time
759
696
  # timestamp.
760
697
  #
761
- # The time range between `StartTime` and `EndTime` must be less than
762
- # 24 hours.
698
+ # The time range between the start and end time must be less than 24
699
+ # hours.
763
700
  # @return [Time]
764
701
  #
765
702
  # @!attribute [rw] filters
766
- # A `Filters` object that contains a list of queue IDs or queue ARNs,
767
- # up to 100, or a list of Channels to use to filter the metrics
768
- # returned in the response. Metric data is retrieved only for the
769
- # resources associated with the IDs, ARNs, or Channels included in the
770
- # filter. You can use both IDs and ARNs together in a request. Only
771
- # VOICE is supported for Channel.
772
- #
773
- # To find the ARN for a queue, open the queue you want to use in the
774
- # Amazon Connect Queue editor. The ARN for the queue is displayed in
775
- # the address bar as part of the URL. For example, the queue ARN is
776
- # the set of characters at the end of the URL, after 'id=' such as
777
- # `arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61`.
778
- # The queue ID is also included in the URL, and is the string after
779
- # 'queue/'.
703
+ # The queues, up to 100, or channels, to use to filter the metrics
704
+ # returned. Metric data is retrieved only for the resources associated
705
+ # with the queues or channels included in the filter. You can include
706
+ # both queue IDs and queue ARNs in the same request. The only
707
+ # supported channel is `VOICE`.
780
708
  # @return [Types::Filters]
781
709
  #
782
710
  # @!attribute [rw] groupings
783
711
  # The grouping applied to the metrics returned. For example, when
784
- # results are grouped by queueId, the metrics returned are grouped by
712
+ # results are grouped by queue, the metrics returned are grouped by
785
713
  # queue. The values returned apply to the metrics for each queue
786
714
  # rather than aggregated for all queues.
787
715
  #
788
- # The current version supports grouping by Queue
716
+ # The only supported grouping is `QUEUE`.
789
717
  #
790
- # If no `Grouping` is included in the request, a summary of
791
- # `HistoricalMetrics` for all queues is returned.
718
+ # If no grouping is specified, a summary of metrics for all queues is
719
+ # returned.
792
720
  # @return [Array<String>]
793
721
  #
794
722
  # @!attribute [rw] historical_metrics
795
- # A list of `HistoricalMetric` objects that contain the metrics to
796
- # retrieve with the request.
723
+ # The metrics to retrieve. Specify the name, unit, and statistic for
724
+ # each metric. The following historical metrics are available:
797
725
  #
798
- # A `HistoricalMetric` object contains: `HistoricalMetricName`,
799
- # `Statistic`, `Threshold`, and `Unit`.
726
+ # ABANDON\_TIME
800
727
  #
801
- # You must list each metric to retrieve data for in the request. For
802
- # each historical metric you include in the request, you must include
803
- # a `Unit` and a `Statistic`.
728
+ # : Unit: SECONDS
804
729
  #
805
- # The following historical metrics are available:
730
+ # Statistic: AVG
806
731
  #
807
- # CONTACTS\_QUEUED
732
+ # AFTER\_CONTACT\_WORK\_TIME
808
733
  #
809
- # : Unit: COUNT
734
+ # : Unit: SECONDS
810
735
  #
811
- # Statistic: SUM
736
+ # Statistic: AVG
812
737
  #
813
- # CONTACTS\_HANDLED
738
+ # API\_CONTACTS\_HANDLED
814
739
  #
815
740
  # : Unit: COUNT
816
741
  #
817
- # Statistics: SUM
742
+ # Statistic: SUM
818
743
  #
819
- # CONTACTS\_ABANDONED
744
+ # CALLBACK\_CONTACTS\_HANDLED
820
745
  #
821
746
  # : Unit: COUNT
822
747
  #
823
- # Statistics: SUM
748
+ # Statistic: SUM
824
749
  #
825
- # CONTACTS\_CONSULTED
750
+ # CONTACTS\_ABANDONED
826
751
  #
827
752
  # : Unit: COUNT
828
753
  #
829
- # Statistics: SUM
754
+ # Statistic: SUM
830
755
  #
831
756
  # CONTACTS\_AGENT\_HUNG\_UP\_FIRST
832
757
  #
833
758
  # : Unit: COUNT
834
759
  #
835
- # Statistics: SUM
760
+ # Statistic: SUM
836
761
  #
837
- # CONTACTS\_HANDLED\_INCOMING
762
+ # CONTACTS\_CONSULTED
838
763
  #
839
764
  # : Unit: COUNT
840
765
  #
841
- # Statistics: SUM
766
+ # Statistic: SUM
842
767
  #
843
- # CONTACTS\_HANDLED\_OUTBOUND
768
+ # CONTACTS\_HANDLED
844
769
  #
845
770
  # : Unit: COUNT
846
771
  #
847
- # Statistics: SUM
772
+ # Statistic: SUM
848
773
  #
849
- # CONTACTS\_HOLD\_ABANDONS
774
+ # CONTACTS\_HANDLED\_INCOMING
850
775
  #
851
776
  # : Unit: COUNT
852
777
  #
853
- # Statistics: SUM
778
+ # Statistic: SUM
854
779
  #
855
- # CONTACTS\_TRANSFERRED\_IN
780
+ # CONTACTS\_HANDLED\_OUTBOUND
856
781
  #
857
782
  # : Unit: COUNT
858
783
  #
859
- # Statistics: SUM
784
+ # Statistic: SUM
860
785
  #
861
- # CONTACTS\_TRANSFERRED\_OUT
786
+ # CONTACTS\_HOLD\_ABANDONS
862
787
  #
863
788
  # : Unit: COUNT
864
789
  #
865
- # Statistics: SUM
790
+ # Statistic: SUM
866
791
  #
867
- # CONTACTS\_TRANSFERRED\_IN\_FROM\_QUEUE
792
+ # CONTACTS\_MISSED
868
793
  #
869
794
  # : Unit: COUNT
870
795
  #
871
- # Statistics: SUM
796
+ # Statistic: SUM
872
797
  #
873
- # CONTACTS\_TRANSFERRED\_OUT\_FROM\_QUEUE
798
+ # CONTACTS\_QUEUED
874
799
  #
875
800
  # : Unit: COUNT
876
801
  #
877
- # Statistics: SUM
802
+ # Statistic: SUM
878
803
  #
879
- # CALLBACK\_CONTACTS\_HANDLED
804
+ # CONTACTS\_TRANSFERRED\_IN
880
805
  #
881
806
  # : Unit: COUNT
882
807
  #
883
- # Statistics: SUM
808
+ # Statistic: SUM
884
809
  #
885
- # CALLBACK\_CONTACTS\_HANDLED
810
+ # CONTACTS\_TRANSFERRED\_IN\_FROM\_QUEUE
886
811
  #
887
812
  # : Unit: COUNT
888
813
  #
889
- # Statistics: SUM
814
+ # Statistic: SUM
890
815
  #
891
- # API\_CONTACTS\_HANDLED
816
+ # CONTACTS\_TRANSFERRED\_OUT
892
817
  #
893
818
  # : Unit: COUNT
894
819
  #
895
- # Statistics: SUM
820
+ # Statistic: SUM
896
821
  #
897
- # CONTACTS\_MISSED
822
+ # CONTACTS\_TRANSFERRED\_OUT\_FROM\_QUEUE
898
823
  #
899
824
  # : Unit: COUNT
900
825
  #
901
- # Statistics: SUM
902
- #
903
- # OCCUPANCY
904
- #
905
- # : Unit: PERCENT
906
- #
907
- # Statistics: AVG
826
+ # Statistic: SUM
908
827
  #
909
828
  # HANDLE\_TIME
910
829
  #
911
830
  # : Unit: SECONDS
912
831
  #
913
- # Statistics: AVG
832
+ # Statistic: AVG
914
833
  #
915
- # AFTER\_CONTACT\_WORK\_TIME
834
+ # HOLD\_TIME
916
835
  #
917
836
  # : Unit: SECONDS
918
837
  #
919
- # Statistics: AVG
838
+ # Statistic: AVG
920
839
  #
921
- # QUEUED\_TIME
840
+ # INTERACTION\_AND\_HOLD\_TIME
922
841
  #
923
842
  # : Unit: SECONDS
924
843
  #
925
- # Statistics: MAX
926
- #
927
- # ABANDON\_TIME
928
- #
929
- # : Unit: COUNT
844
+ # Statistic: AVG
930
845
  #
931
- # Statistics: SUM
932
- #
933
- # QUEUE\_ANSWER\_TIME
846
+ # INTERACTION\_TIME
934
847
  #
935
848
  # : Unit: SECONDS
936
849
  #
937
- # Statistics: AVG
850
+ # Statistic: AVG
938
851
  #
939
- # HOLD\_TIME
852
+ # OCCUPANCY
940
853
  #
941
- # : Unit: SECONDS
854
+ # : Unit: PERCENT
942
855
  #
943
- # Statistics: AVG
856
+ # Statistic: AVG
944
857
  #
945
- # INTERACTION\_TIME
858
+ # QUEUE\_ANSWER\_TIME
946
859
  #
947
860
  # : Unit: SECONDS
948
861
  #
949
- # Statistics: AVG
862
+ # Statistic: AVG
950
863
  #
951
- # INTERACTION\_AND\_HOLD\_TIME
864
+ # QUEUED\_TIME
952
865
  #
953
866
  # : Unit: SECONDS
954
867
  #
955
- # Statistics: AVG
868
+ # Statistic: MAX
956
869
  #
957
870
  # SERVICE\_LEVEL
958
871
  #
959
872
  # : Unit: PERCENT
960
873
  #
961
- # Statistics: AVG
874
+ # Statistic: AVG
962
875
  #
963
876
  # Threshold: Only "Less than" comparisons are supported, with the
964
877
  # following service level thresholds: 15, 20, 25, 30, 45, 60, 90,
@@ -972,8 +885,7 @@ module Aws::Connect
972
885
  # @return [String]
973
886
  #
974
887
  # @!attribute [rw] max_results
975
- # Indicates the maximum number of results to return per page in the
976
- # response, between 1-100.
888
+ # The maximimum number of results to return per page.
977
889
  # @return [Integer]
978
890
  #
979
891
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetMetricDataRequest AWS API Documentation
@@ -991,24 +903,18 @@ module Aws::Connect
991
903
  end
992
904
 
993
905
  # @!attribute [rw] next_token
994
- # A string returned in the response. Use the value returned in the
995
- # response as the value of the NextToken in a subsequent request to
996
- # retrieve the next set of results.
906
+ # If there are additional results, this is the token for the next set
907
+ # of results.
997
908
  #
998
909
  # The token expires after 5 minutes from the time it is created.
999
- # Subsequent requests that use the NextToken must use the same request
910
+ # Subsequent requests that use the token must use the same request
1000
911
  # parameters as the request that generated the token.
1001
912
  # @return [String]
1002
913
  #
1003
914
  # @!attribute [rw] metric_results
1004
- # A list of `HistoricalMetricResult` objects, organized by
1005
- # `Dimensions`, which is the ID of the resource specified in the
1006
- # `Filters` used for the request. The metrics are combined with the
1007
- # metrics included in `Collections`, which is a list of
1008
- # `HisotricalMetricData` objects.
1009
- #
1010
- # If no `Grouping` is specified in the request, `Collections` includes
1011
- # summary data for the `HistoricalMetrics`.
915
+ # Information about the historical metrics.
916
+ #
917
+ # If no grouping is specified, a summary of metric data is returned.
1012
918
  # @return [Array<Types::HistoricalMetricResult>]
1013
919
  #
1014
920
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetMetricDataResponse AWS API Documentation
@@ -1019,28 +925,26 @@ module Aws::Connect
1019
925
  include Aws::Structure
1020
926
  end
1021
927
 
1022
- # A `HierarchyGroup` object that contains information about a hierarchy
1023
- # group in your Amazon Connect instance.
928
+ # Contains information about a hierarchy group.
1024
929
  #
1025
930
  # @!attribute [rw] id
1026
- # The identifier for the hierarchy group.
931
+ # The identifier of the hierarchy group.
1027
932
  # @return [String]
1028
933
  #
1029
934
  # @!attribute [rw] arn
1030
- # The Amazon Resource Name (ARN) for the hierarchy group.
935
+ # The Amazon Resource Name (ARN) of the hierarchy group.
1031
936
  # @return [String]
1032
937
  #
1033
938
  # @!attribute [rw] name
1034
- # The name of the hierarchy group in your instance.
939
+ # The name of the hierarchy group.
1035
940
  # @return [String]
1036
941
  #
1037
942
  # @!attribute [rw] level_id
1038
- # The identifier for the level in the hierarchy group.
943
+ # The identifier of the level in the hierarchy group.
1039
944
  # @return [String]
1040
945
  #
1041
946
  # @!attribute [rw] hierarchy_path
1042
- # A `HierarchyPath` object that contains information about the levels
1043
- # in the hierarchy group.
947
+ # Information about the levels in the hierarchy group.
1044
948
  # @return [Types::HierarchyPath]
1045
949
  #
1046
950
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HierarchyGroup AWS API Documentation
@@ -1054,15 +958,14 @@ module Aws::Connect
1054
958
  include Aws::Structure
1055
959
  end
1056
960
 
1057
- # A `HierarchyGroupSummary` object that contains information about the
1058
- # hierarchy group, including ARN, Id, and Name.
961
+ # Contains summary information about a hierarchy group.
1059
962
  #
1060
963
  # @!attribute [rw] id
1061
964
  # The identifier of the hierarchy group.
1062
965
  # @return [String]
1063
966
  #
1064
967
  # @!attribute [rw] arn
1065
- # The ARN for the hierarchy group.
968
+ # The Amazon Resource Name (ARN) of the hierarchy group.
1066
969
  # @return [String]
1067
970
  #
1068
971
  # @!attribute [rw] name
@@ -1078,19 +981,18 @@ module Aws::Connect
1078
981
  include Aws::Structure
1079
982
  end
1080
983
 
1081
- # A `HierarchyLevel` object that contains information about the levels
1082
- # in a hierarchy group, including ARN, Id, and Name.
984
+ # Contains information about a hierarchy level.
1083
985
  #
1084
986
  # @!attribute [rw] id
1085
- # The identifier for the hierarchy group level.
987
+ # The identifier of the hierarchy level.
1086
988
  # @return [String]
1087
989
  #
1088
990
  # @!attribute [rw] arn
1089
- # The ARN for the hierarchy group level.
991
+ # The Amazon Resource Name (ARN) of the hierarchy level.
1090
992
  # @return [String]
1091
993
  #
1092
994
  # @!attribute [rw] name
1093
- # The name of the hierarchy group level.
995
+ # The name of the hierarchy level.
1094
996
  # @return [String]
1095
997
  #
1096
998
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HierarchyLevel AWS API Documentation
@@ -1102,32 +1004,26 @@ module Aws::Connect
1102
1004
  include Aws::Structure
1103
1005
  end
1104
1006
 
1105
- # A `HierarchyPath` object that contains information about the levels of
1106
- # the hierarchy group.
1007
+ # Contains information about the levels of a hierarchy group.
1107
1008
  #
1108
1009
  # @!attribute [rw] level_one
1109
- # A `HierarchyGroupSummary` object that contains information about the
1110
- # level of the hierarchy group, including ARN, Id, and Name.
1010
+ # Information about level one.
1111
1011
  # @return [Types::HierarchyGroupSummary]
1112
1012
  #
1113
1013
  # @!attribute [rw] level_two
1114
- # A `HierarchyGroupSummary` object that contains information about the
1115
- # level of the hierarchy group, including ARN, Id, and Name.
1014
+ # Information about level two.
1116
1015
  # @return [Types::HierarchyGroupSummary]
1117
1016
  #
1118
1017
  # @!attribute [rw] level_three
1119
- # A `HierarchyGroupSummary` object that contains information about the
1120
- # level of the hierarchy group, including ARN, Id, and Name.
1018
+ # Information about level three.
1121
1019
  # @return [Types::HierarchyGroupSummary]
1122
1020
  #
1123
1021
  # @!attribute [rw] level_four
1124
- # A `HierarchyGroupSummary` object that contains information about the
1125
- # level of the hierarchy group, including ARN, Id, and Name.
1022
+ # Information about level four.
1126
1023
  # @return [Types::HierarchyGroupSummary]
1127
1024
  #
1128
1025
  # @!attribute [rw] level_five
1129
- # A `HierarchyGroupSummary` object that contains information about the
1130
- # level of the hierarchy group, including ARN, Id, and Name.
1026
+ # Information about level five.
1131
1027
  # @return [Types::HierarchyGroupSummary]
1132
1028
  #
1133
1029
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HierarchyPath AWS API Documentation
@@ -1141,32 +1037,26 @@ module Aws::Connect
1141
1037
  include Aws::Structure
1142
1038
  end
1143
1039
 
1144
- # A `HierarchyStructure` object that contains information about the
1145
- # hierarchy group structure.
1040
+ # Contains information about a hierarchy structure.
1146
1041
  #
1147
1042
  # @!attribute [rw] level_one
1148
- # A `HierarchyLevel` object that contains information about the
1149
- # hierarchy group level.
1043
+ # Information about level one.
1150
1044
  # @return [Types::HierarchyLevel]
1151
1045
  #
1152
1046
  # @!attribute [rw] level_two
1153
- # A `HierarchyLevel` object that contains information about the
1154
- # hierarchy group level.
1047
+ # Information about level two.
1155
1048
  # @return [Types::HierarchyLevel]
1156
1049
  #
1157
1050
  # @!attribute [rw] level_three
1158
- # A `HierarchyLevel` object that contains information about the
1159
- # hierarchy group level.
1051
+ # Information about level three.
1160
1052
  # @return [Types::HierarchyLevel]
1161
1053
  #
1162
1054
  # @!attribute [rw] level_four
1163
- # A `HierarchyLevel` object that contains information about the
1164
- # hierarchy group level.
1055
+ # Information about level four.
1165
1056
  # @return [Types::HierarchyLevel]
1166
1057
  #
1167
1058
  # @!attribute [rw] level_five
1168
- # A `HierarchyLevel` object that contains information about the
1169
- # hierarchy group level.
1059
+ # Information about level five.
1170
1060
  # @return [Types::HierarchyLevel]
1171
1061
  #
1172
1062
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HierarchyStructure AWS API Documentation
@@ -1180,8 +1070,7 @@ module Aws::Connect
1180
1070
  include Aws::Structure
1181
1071
  end
1182
1072
 
1183
- # A `HistoricalMetric` object that contains the Name, Unit, Statistic,
1184
- # and Threshold for the metric.
1073
+ # Contains information about a historical metric.
1185
1074
  #
1186
1075
  # @note When making an API call, you may pass HistoricalMetric
1187
1076
  # data as a hash:
@@ -1197,7 +1086,7 @@ module Aws::Connect
1197
1086
  # }
1198
1087
  #
1199
1088
  # @!attribute [rw] name
1200
- # The name of the historical metric.
1089
+ # The name of the metric.
1201
1090
  # @return [String]
1202
1091
  #
1203
1092
  # @!attribute [rw] threshold
@@ -1222,15 +1111,14 @@ module Aws::Connect
1222
1111
  include Aws::Structure
1223
1112
  end
1224
1113
 
1225
- # A `HistoricalMetricData` object than contains a `Metric` and a
1226
- # `Value`.
1114
+ # Contains the data for a historical metric.
1227
1115
  #
1228
1116
  # @!attribute [rw] metric
1229
- # A `HistoricalMetric` object.
1117
+ # Information about the metric.
1230
1118
  # @return [Types::HistoricalMetric]
1231
1119
  #
1232
1120
  # @!attribute [rw] value
1233
- # The `Value` of the metric.
1121
+ # The value of the metric.
1234
1122
  # @return [Float]
1235
1123
  #
1236
1124
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HistoricalMetricData AWS API Documentation
@@ -1241,14 +1129,14 @@ module Aws::Connect
1241
1129
  include Aws::Structure
1242
1130
  end
1243
1131
 
1244
- # The metrics data returned from a `GetMetricData` operation.
1132
+ # Contains information about the historical metrics retrieved.
1245
1133
  #
1246
1134
  # @!attribute [rw] dimensions
1247
- # The `Dimensions` for the metrics.
1135
+ # The dimension for the metrics.
1248
1136
  # @return [Types::Dimensions]
1249
1137
  #
1250
1138
  # @!attribute [rw] collections
1251
- # A list of `HistoricalMetricData` objects.
1139
+ # The set of metrics.
1252
1140
  # @return [Array<Types::HistoricalMetricData>]
1253
1141
  #
1254
1142
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HistoricalMetricResult AWS API Documentation
@@ -1259,6 +1147,30 @@ module Aws::Connect
1259
1147
  include Aws::Structure
1260
1148
  end
1261
1149
 
1150
+ # Contains summary information about hours of operation for a contact
1151
+ # center.
1152
+ #
1153
+ # @!attribute [rw] id
1154
+ # The identifier of the hours of operation.
1155
+ # @return [String]
1156
+ #
1157
+ # @!attribute [rw] arn
1158
+ # The Amazon Resource Name (ARN) of the hours of operation.
1159
+ # @return [String]
1160
+ #
1161
+ # @!attribute [rw] name
1162
+ # The name of the hours of operation.
1163
+ # @return [String]
1164
+ #
1165
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HoursOfOperationSummary AWS API Documentation
1166
+ #
1167
+ class HoursOfOperationSummary < Struct.new(
1168
+ :id,
1169
+ :arn,
1170
+ :name)
1171
+ include Aws::Structure
1172
+ end
1173
+
1262
1174
  # Request processing failed due to an error or failure with the service.
1263
1175
  #
1264
1176
  # @!attribute [rw] message
@@ -1272,7 +1184,7 @@ module Aws::Connect
1272
1184
  include Aws::Structure
1273
1185
  end
1274
1186
 
1275
- # One or more of the parameters provided to the operation are not valid.
1187
+ # One or more of the specified parameters are not valid.
1276
1188
  #
1277
1189
  # @!attribute [rw] message
1278
1190
  # The message.
@@ -1298,7 +1210,7 @@ module Aws::Connect
1298
1210
  include Aws::Structure
1299
1211
  end
1300
1212
 
1301
- # The allowed limit for the resource has been reached.
1213
+ # The allowed limit for the resource has been exceeded.
1302
1214
  #
1303
1215
  # @!attribute [rw] message
1304
1216
  # The message.
@@ -1311,6 +1223,226 @@ module Aws::Connect
1311
1223
  include Aws::Structure
1312
1224
  end
1313
1225
 
1226
+ # @note When making an API call, you may pass ListContactFlowsRequest
1227
+ # data as a hash:
1228
+ #
1229
+ # {
1230
+ # instance_id: "InstanceId", # required
1231
+ # contact_flow_types: ["CONTACT_FLOW"], # accepts CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER
1232
+ # next_token: "NextToken",
1233
+ # max_results: 1,
1234
+ # }
1235
+ #
1236
+ # @!attribute [rw] instance_id
1237
+ # The identifier of the Amazon Connect instance.
1238
+ # @return [String]
1239
+ #
1240
+ # @!attribute [rw] contact_flow_types
1241
+ # The type of contact flow.
1242
+ # @return [Array<String>]
1243
+ #
1244
+ # @!attribute [rw] next_token
1245
+ # The token for the next set of results. Use the value returned in the
1246
+ # previous response in the next request to retrieve the next set of
1247
+ # results.
1248
+ # @return [String]
1249
+ #
1250
+ # @!attribute [rw] max_results
1251
+ # The maximimum number of results to return per page.
1252
+ # @return [Integer]
1253
+ #
1254
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactFlowsRequest AWS API Documentation
1255
+ #
1256
+ class ListContactFlowsRequest < Struct.new(
1257
+ :instance_id,
1258
+ :contact_flow_types,
1259
+ :next_token,
1260
+ :max_results)
1261
+ include Aws::Structure
1262
+ end
1263
+
1264
+ # @!attribute [rw] contact_flow_summary_list
1265
+ # Information about the contact flows.
1266
+ # @return [Array<Types::ContactFlowSummary>]
1267
+ #
1268
+ # @!attribute [rw] next_token
1269
+ # If there are additional results, this is the token for the next set
1270
+ # of results.
1271
+ # @return [String]
1272
+ #
1273
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactFlowsResponse AWS API Documentation
1274
+ #
1275
+ class ListContactFlowsResponse < Struct.new(
1276
+ :contact_flow_summary_list,
1277
+ :next_token)
1278
+ include Aws::Structure
1279
+ end
1280
+
1281
+ # @note When making an API call, you may pass ListHoursOfOperationsRequest
1282
+ # data as a hash:
1283
+ #
1284
+ # {
1285
+ # instance_id: "InstanceId", # required
1286
+ # next_token: "NextToken",
1287
+ # max_results: 1,
1288
+ # }
1289
+ #
1290
+ # @!attribute [rw] instance_id
1291
+ # The identifier of the Amazon Connect instance.
1292
+ # @return [String]
1293
+ #
1294
+ # @!attribute [rw] next_token
1295
+ # The token for the next set of results. Use the value returned in the
1296
+ # previous response in the next request to retrieve the next set of
1297
+ # results.
1298
+ # @return [String]
1299
+ #
1300
+ # @!attribute [rw] max_results
1301
+ # The maximimum number of results to return per page.
1302
+ # @return [Integer]
1303
+ #
1304
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListHoursOfOperationsRequest AWS API Documentation
1305
+ #
1306
+ class ListHoursOfOperationsRequest < Struct.new(
1307
+ :instance_id,
1308
+ :next_token,
1309
+ :max_results)
1310
+ include Aws::Structure
1311
+ end
1312
+
1313
+ # @!attribute [rw] hours_of_operation_summary_list
1314
+ # Information about the hours of operation.
1315
+ # @return [Array<Types::HoursOfOperationSummary>]
1316
+ #
1317
+ # @!attribute [rw] next_token
1318
+ # If there are additional results, this is the token for the next set
1319
+ # of results.
1320
+ # @return [String]
1321
+ #
1322
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListHoursOfOperationsResponse AWS API Documentation
1323
+ #
1324
+ class ListHoursOfOperationsResponse < Struct.new(
1325
+ :hours_of_operation_summary_list,
1326
+ :next_token)
1327
+ include Aws::Structure
1328
+ end
1329
+
1330
+ # @note When making an API call, you may pass ListPhoneNumbersRequest
1331
+ # data as a hash:
1332
+ #
1333
+ # {
1334
+ # instance_id: "InstanceId", # required
1335
+ # phone_number_types: ["TOLL_FREE"], # accepts TOLL_FREE, DID
1336
+ # phone_number_country_codes: ["AF"], # accepts AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, PF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GU, GT, GG, GN, GW, GY, HT, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, KR, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, UA, AE, GB, US, UY, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW
1337
+ # next_token: "NextToken",
1338
+ # max_results: 1,
1339
+ # }
1340
+ #
1341
+ # @!attribute [rw] instance_id
1342
+ # The identifier of the Amazon Connect instance.
1343
+ # @return [String]
1344
+ #
1345
+ # @!attribute [rw] phone_number_types
1346
+ # The type of phone number.
1347
+ # @return [Array<String>]
1348
+ #
1349
+ # @!attribute [rw] phone_number_country_codes
1350
+ # The ISO country code.
1351
+ # @return [Array<String>]
1352
+ #
1353
+ # @!attribute [rw] next_token
1354
+ # The token for the next set of results. Use the value returned in the
1355
+ # previous response in the next request to retrieve the next set of
1356
+ # results.
1357
+ # @return [String]
1358
+ #
1359
+ # @!attribute [rw] max_results
1360
+ # The maximimum number of results to return per page.
1361
+ # @return [Integer]
1362
+ #
1363
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPhoneNumbersRequest AWS API Documentation
1364
+ #
1365
+ class ListPhoneNumbersRequest < Struct.new(
1366
+ :instance_id,
1367
+ :phone_number_types,
1368
+ :phone_number_country_codes,
1369
+ :next_token,
1370
+ :max_results)
1371
+ include Aws::Structure
1372
+ end
1373
+
1374
+ # @!attribute [rw] phone_number_summary_list
1375
+ # Information about the phone numbers.
1376
+ # @return [Array<Types::PhoneNumberSummary>]
1377
+ #
1378
+ # @!attribute [rw] next_token
1379
+ # If there are additional results, this is the token for the next set
1380
+ # of results.
1381
+ # @return [String]
1382
+ #
1383
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPhoneNumbersResponse AWS API Documentation
1384
+ #
1385
+ class ListPhoneNumbersResponse < Struct.new(
1386
+ :phone_number_summary_list,
1387
+ :next_token)
1388
+ include Aws::Structure
1389
+ end
1390
+
1391
+ # @note When making an API call, you may pass ListQueuesRequest
1392
+ # data as a hash:
1393
+ #
1394
+ # {
1395
+ # instance_id: "InstanceId", # required
1396
+ # queue_types: ["STANDARD"], # accepts STANDARD, AGENT
1397
+ # next_token: "NextToken",
1398
+ # max_results: 1,
1399
+ # }
1400
+ #
1401
+ # @!attribute [rw] instance_id
1402
+ # The identifier of the Amazon Connect instance.
1403
+ # @return [String]
1404
+ #
1405
+ # @!attribute [rw] queue_types
1406
+ # The type of queue.
1407
+ # @return [Array<String>]
1408
+ #
1409
+ # @!attribute [rw] next_token
1410
+ # The token for the next set of results. Use the value returned in the
1411
+ # previous response in the next request to retrieve the next set of
1412
+ # results.
1413
+ # @return [String]
1414
+ #
1415
+ # @!attribute [rw] max_results
1416
+ # The maximimum number of results to return per page.
1417
+ # @return [Integer]
1418
+ #
1419
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListQueuesRequest AWS API Documentation
1420
+ #
1421
+ class ListQueuesRequest < Struct.new(
1422
+ :instance_id,
1423
+ :queue_types,
1424
+ :next_token,
1425
+ :max_results)
1426
+ include Aws::Structure
1427
+ end
1428
+
1429
+ # @!attribute [rw] queue_summary_list
1430
+ # Information about the queues.
1431
+ # @return [Array<Types::QueueSummary>]
1432
+ #
1433
+ # @!attribute [rw] next_token
1434
+ # If there are additional results, this is the token for the next set
1435
+ # of results.
1436
+ # @return [String]
1437
+ #
1438
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListQueuesResponse AWS API Documentation
1439
+ #
1440
+ class ListQueuesResponse < Struct.new(
1441
+ :queue_summary_list,
1442
+ :next_token)
1443
+ include Aws::Structure
1444
+ end
1445
+
1314
1446
  # @note When making an API call, you may pass ListRoutingProfilesRequest
1315
1447
  # data as a hash:
1316
1448
  #
@@ -1321,13 +1453,7 @@ module Aws::Connect
1321
1453
  # }
1322
1454
  #
1323
1455
  # @!attribute [rw] instance_id
1324
- # The identifier for your Amazon Connect instance. To find the ID of
1325
- # your instance, open the AWS console and select Amazon Connect.
1326
- # Select the alias of the instance in the Instance alias column. The
1327
- # instance ID is displayed in the Overview section of your instance
1328
- # settings. For example, the instance ID is the set of characters at
1329
- # the end of the instance ARN, after instance/, such as
1330
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
1456
+ # The identifier of the Amazon Connect instance.
1331
1457
  # @return [String]
1332
1458
  #
1333
1459
  # @!attribute [rw] next_token
@@ -1337,7 +1463,7 @@ module Aws::Connect
1337
1463
  # @return [String]
1338
1464
  #
1339
1465
  # @!attribute [rw] max_results
1340
- # The maximum number of routing profiles to return in the response.
1466
+ # The maximimum number of results to return per page.
1341
1467
  # @return [Integer]
1342
1468
  #
1343
1469
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfilesRequest AWS API Documentation
@@ -1350,14 +1476,12 @@ module Aws::Connect
1350
1476
  end
1351
1477
 
1352
1478
  # @!attribute [rw] routing_profile_summary_list
1353
- # An array of `RoutingProfileSummary` objects that include the ARN,
1354
- # Id, and Name of the routing profile.
1479
+ # Information about the routing profiles.
1355
1480
  # @return [Array<Types::RoutingProfileSummary>]
1356
1481
  #
1357
1482
  # @!attribute [rw] next_token
1358
- # A string returned in the response. Use the value returned in the
1359
- # response as the value of the NextToken in a subsequent request to
1360
- # retrieve the next set of results.
1483
+ # If there are additional results, this is the token for the next set
1484
+ # of results.
1361
1485
  # @return [String]
1362
1486
  #
1363
1487
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfilesResponse AWS API Documentation
@@ -1378,13 +1502,7 @@ module Aws::Connect
1378
1502
  # }
1379
1503
  #
1380
1504
  # @!attribute [rw] instance_id
1381
- # The identifier for your Amazon Connect instance. To find the ID of
1382
- # your instance, open the AWS console and select Amazon Connect.
1383
- # Select the alias of the instance in the Instance alias column. The
1384
- # instance ID is displayed in the Overview section of your instance
1385
- # settings. For example, the instance ID is the set of characters at
1386
- # the end of the instance ARN, after instance/, such as
1387
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
1505
+ # The identifier of the Amazon Connect instance.
1388
1506
  # @return [String]
1389
1507
  #
1390
1508
  # @!attribute [rw] next_token
@@ -1394,7 +1512,7 @@ module Aws::Connect
1394
1512
  # @return [String]
1395
1513
  #
1396
1514
  # @!attribute [rw] max_results
1397
- # The maximum number of security profiles to return.
1515
+ # The maximimum number of results to return per page.
1398
1516
  # @return [Integer]
1399
1517
  #
1400
1518
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityProfilesRequest AWS API Documentation
@@ -1407,13 +1525,12 @@ module Aws::Connect
1407
1525
  end
1408
1526
 
1409
1527
  # @!attribute [rw] security_profile_summary_list
1410
- # An array of `SecurityProfileSummary` objects.
1528
+ # Information about the security profiles.
1411
1529
  # @return [Array<Types::SecurityProfileSummary>]
1412
1530
  #
1413
1531
  # @!attribute [rw] next_token
1414
- # A string returned in the response. Use the value returned in the
1415
- # response as the value of the NextToken in a subsequent request to
1416
- # retrieve the next set of results.
1532
+ # If there are additional results, this is the token for the next set
1533
+ # of results.
1417
1534
  # @return [String]
1418
1535
  #
1419
1536
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityProfilesResponse AWS API Documentation
@@ -1434,13 +1551,7 @@ module Aws::Connect
1434
1551
  # }
1435
1552
  #
1436
1553
  # @!attribute [rw] instance_id
1437
- # The identifier for your Amazon Connect instance. To find the ID of
1438
- # your instance, open the AWS console and select Amazon Connect.
1439
- # Select the alias of the instance in the Instance alias column. The
1440
- # instance ID is displayed in the Overview section of your instance
1441
- # settings. For example, the instance ID is the set of characters at
1442
- # the end of the instance ARN, after instance/, such as
1443
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
1554
+ # The identifier of the Amazon Connect instance.
1444
1555
  # @return [String]
1445
1556
  #
1446
1557
  # @!attribute [rw] next_token
@@ -1450,7 +1561,7 @@ module Aws::Connect
1450
1561
  # @return [String]
1451
1562
  #
1452
1563
  # @!attribute [rw] max_results
1453
- # The maximum number of hierarchy groups to return.
1564
+ # The maximimum number of results to return per page.
1454
1565
  # @return [Integer]
1455
1566
  #
1456
1567
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUserHierarchyGroupsRequest AWS API Documentation
@@ -1463,13 +1574,12 @@ module Aws::Connect
1463
1574
  end
1464
1575
 
1465
1576
  # @!attribute [rw] user_hierarchy_group_summary_list
1466
- # An array of `HierarchyGroupSummary` objects.
1577
+ # Information about the hierarchy groups.
1467
1578
  # @return [Array<Types::HierarchyGroupSummary>]
1468
1579
  #
1469
1580
  # @!attribute [rw] next_token
1470
- # A string returned in the response. Use the value returned in the
1471
- # response as the value of the NextToken in a subsequent request to
1472
- # retrieve the next set of results.
1581
+ # If there are additional results, this is the token for the next set
1582
+ # of results.
1473
1583
  # @return [String]
1474
1584
  #
1475
1585
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUserHierarchyGroupsResponse AWS API Documentation
@@ -1490,13 +1600,7 @@ module Aws::Connect
1490
1600
  # }
1491
1601
  #
1492
1602
  # @!attribute [rw] instance_id
1493
- # The identifier for your Amazon Connect instance. To find the ID of
1494
- # your instance, open the AWS console and select Amazon Connect.
1495
- # Select the alias of the instance in the Instance alias column. The
1496
- # instance ID is displayed in the Overview section of your instance
1497
- # settings. For example, the instance ID is the set of characters at
1498
- # the end of the instance ARN, after instance/, such as
1499
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
1603
+ # The identifier of the Amazon Connect instance.
1500
1604
  # @return [String]
1501
1605
  #
1502
1606
  # @!attribute [rw] next_token
@@ -1506,7 +1610,7 @@ module Aws::Connect
1506
1610
  # @return [String]
1507
1611
  #
1508
1612
  # @!attribute [rw] max_results
1509
- # The maximum number of results to return in the response.
1613
+ # The maximimum number of results to return per page.
1510
1614
  # @return [Integer]
1511
1615
  #
1512
1616
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUsersRequest AWS API Documentation
@@ -1519,14 +1623,12 @@ module Aws::Connect
1519
1623
  end
1520
1624
 
1521
1625
  # @!attribute [rw] user_summary_list
1522
- # An array of `UserSummary` objects that contain information about the
1523
- # users in your instance.
1626
+ # Information about the users.
1524
1627
  # @return [Array<Types::UserSummary>]
1525
1628
  #
1526
1629
  # @!attribute [rw] next_token
1527
- # A string returned in the response. Use the value returned in the
1528
- # response as the value of the NextToken in a subsequent request to
1529
- # retrieve the next set of results.
1630
+ # If there are additional results, this is the token for the next set
1631
+ # of results.
1530
1632
  # @return [String]
1531
1633
  #
1532
1634
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUsersResponse AWS API Documentation
@@ -1550,15 +1652,49 @@ module Aws::Connect
1550
1652
  include Aws::Structure
1551
1653
  end
1552
1654
 
1553
- # A QueueReference object that contains the the QueueId and ARN for the
1554
- # queue resource for which metrics are returned.
1655
+ # Contains summary information about a phone number for a contact
1656
+ # center.
1657
+ #
1658
+ # @!attribute [rw] id
1659
+ # The identifier of the phone number.
1660
+ # @return [String]
1661
+ #
1662
+ # @!attribute [rw] arn
1663
+ # The Amazon Resource Name (ARN) of the phone number.
1664
+ # @return [String]
1665
+ #
1666
+ # @!attribute [rw] phone_number
1667
+ # The phone number.
1668
+ # @return [String]
1669
+ #
1670
+ # @!attribute [rw] phone_number_type
1671
+ # The type of phone number.
1672
+ # @return [String]
1673
+ #
1674
+ # @!attribute [rw] phone_number_country_code
1675
+ # The ISO country code.
1676
+ # @return [String]
1677
+ #
1678
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/PhoneNumberSummary AWS API Documentation
1679
+ #
1680
+ class PhoneNumberSummary < Struct.new(
1681
+ :id,
1682
+ :arn,
1683
+ :phone_number,
1684
+ :phone_number_type,
1685
+ :phone_number_country_code)
1686
+ include Aws::Structure
1687
+ end
1688
+
1689
+ # Contains information about a queue resource for which metrics are
1690
+ # returned.
1555
1691
  #
1556
1692
  # @!attribute [rw] id
1557
- # The ID of the queue associated with the metrics returned.
1693
+ # The identifier of the queue.
1558
1694
  # @return [String]
1559
1695
  #
1560
1696
  # @!attribute [rw] arn
1561
- # The Amazon Resource Name (ARN) of queue.
1697
+ # The Amazon Resource Name (ARN) of the queue.
1562
1698
  # @return [String]
1563
1699
  #
1564
1700
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/QueueReference AWS API Documentation
@@ -1569,6 +1705,34 @@ module Aws::Connect
1569
1705
  include Aws::Structure
1570
1706
  end
1571
1707
 
1708
+ # Contains summary information about a queue.
1709
+ #
1710
+ # @!attribute [rw] id
1711
+ # The identifier of the queue.
1712
+ # @return [String]
1713
+ #
1714
+ # @!attribute [rw] arn
1715
+ # The Amazon Resource Name (ARN) of the queue.
1716
+ # @return [String]
1717
+ #
1718
+ # @!attribute [rw] name
1719
+ # The name of the queue.
1720
+ # @return [String]
1721
+ #
1722
+ # @!attribute [rw] queue_type
1723
+ # The type of queue.
1724
+ # @return [String]
1725
+ #
1726
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/QueueSummary AWS API Documentation
1727
+ #
1728
+ class QueueSummary < Struct.new(
1729
+ :id,
1730
+ :arn,
1731
+ :name,
1732
+ :queue_type)
1733
+ include Aws::Structure
1734
+ end
1735
+
1572
1736
  # The specified resource was not found.
1573
1737
  #
1574
1738
  # @!attribute [rw] message
@@ -1582,15 +1746,14 @@ module Aws::Connect
1582
1746
  include Aws::Structure
1583
1747
  end
1584
1748
 
1585
- # A `RoutingProfileSummary` object that contains information about a
1586
- # routing profile, including ARN, Id, and Name.
1749
+ # Contains summary information about a routing profile.
1587
1750
  #
1588
1751
  # @!attribute [rw] id
1589
1752
  # The identifier of the routing profile.
1590
1753
  # @return [String]
1591
1754
  #
1592
1755
  # @!attribute [rw] arn
1593
- # The ARN of the routing profile.
1756
+ # The Amazon Resource Name (ARN) of the routing profile.
1594
1757
  # @return [String]
1595
1758
  #
1596
1759
  # @!attribute [rw] name
@@ -1606,15 +1769,14 @@ module Aws::Connect
1606
1769
  include Aws::Structure
1607
1770
  end
1608
1771
 
1609
- # A `SecurityProfileSummary` object that contains information about a
1610
- # security profile, including ARN, Id, Name.
1772
+ # Contains information about a security profile.
1611
1773
  #
1612
1774
  # @!attribute [rw] id
1613
1775
  # The identifier of the security profile.
1614
1776
  # @return [String]
1615
1777
  #
1616
1778
  # @!attribute [rw] arn
1617
- # The ARN of the security profile.
1779
+ # The Amazon Resource Name (ARN) of the security profile.
1618
1780
  # @return [String]
1619
1781
  #
1620
1782
  # @!attribute [rw] name
@@ -1646,28 +1808,15 @@ module Aws::Connect
1646
1808
  # }
1647
1809
  #
1648
1810
  # @!attribute [rw] destination_phone_number
1649
- # The phone number of the customer in E.164 format.
1811
+ # The phone number of the customer, in E.164 format.
1650
1812
  # @return [String]
1651
1813
  #
1652
1814
  # @!attribute [rw] contact_flow_id
1653
- # The identifier for the contact flow to connect the outbound call to.
1654
- #
1655
- # To find the `ContactFlowId`, open the contact flow you want to use
1656
- # in the Amazon Connect contact flow editor. The ID for the contact
1657
- # flow is displayed in the address bar as part of the URL. For
1658
- # example, the contact flow ID is the set of characters at the end of
1659
- # the URL, after 'contact-flow/' such as
1660
- # `78ea8fd5-2659-4f2b-b528-699760ccfc1b`.
1815
+ # The identifier of the contact flow for the outbound call.
1661
1816
  # @return [String]
1662
1817
  #
1663
1818
  # @!attribute [rw] instance_id
1664
- # The identifier for your Amazon Connect instance. To find the ID of
1665
- # your instance, open the AWS console and select Amazon Connect.
1666
- # Select the alias of the instance in the Instance alias column. The
1667
- # instance ID is displayed in the Overview section of your instance
1668
- # settings. For example, the instance ID is the set of characters at
1669
- # the end of the instance ARN, after instance/, such as
1670
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
1819
+ # The identifier of the Amazon Connect instance.
1671
1820
  # @return [String]
1672
1821
  #
1673
1822
  # @!attribute [rw] client_token
@@ -1681,35 +1830,27 @@ module Aws::Connect
1681
1830
  # @return [String]
1682
1831
  #
1683
1832
  # @!attribute [rw] source_phone_number
1684
- # The phone number, in E.164 format, associated with your Amazon
1685
- # Connect instance to use for the outbound call.
1833
+ # The phone number associated with the Amazon Connect instance, in
1834
+ # E.164 format. If you do not specify a source phone number, you must
1835
+ # specify a queue.
1686
1836
  # @return [String]
1687
1837
  #
1688
1838
  # @!attribute [rw] queue_id
1689
- # The queue to add the call to. If you specify a queue, the phone
1690
- # displayed for caller ID is the phone number specified in the queue.
1691
- # If you do not specify a queue, the queue used will be the queue
1692
- # defined in the contact flow.
1693
- #
1694
- # To find the `QueueId`, open the queue you want to use in the Amazon
1695
- # Connect Queue editor. The ID for the queue is displayed in the
1696
- # address bar as part of the URL. For example, the queue ID is the set
1697
- # of characters at the end of the URL, after 'queue/' such as
1698
- # `queue/aeg40574-2d01-51c3-73d6-bf8624d2168c`.
1839
+ # The queue for the call. If you specify a queue, the phone displayed
1840
+ # for caller ID is the phone number specified in the queue. If you do
1841
+ # not specify a queue, the queue defined in the contact flow is used.
1842
+ # If you do not specify a queue, you must specify a source phone
1843
+ # number.
1699
1844
  # @return [String]
1700
1845
  #
1701
1846
  # @!attribute [rw] attributes
1702
- # Specify a custom key-value pair using an attribute map. The
1703
- # attributes are standard Amazon Connect attributes, and can be
1704
- # accessed in contact flows just like any other contact attributes.
1847
+ # A custom key-value pair using an attribute map. The attributes are
1848
+ # standard Amazon Connect attributes, and can be accessed in contact
1849
+ # flows just like any other contact attributes.
1705
1850
  #
1706
1851
  # There can be up to 32,768 UTF-8 bytes across all key-value pairs per
1707
1852
  # contact. Attribute keys can include only alphanumeric, dash, and
1708
1853
  # underscore characters.
1709
- #
1710
- # For example, if you want play a greeting when the customer answers
1711
- # the call, you can pass the customer name in attributes similar to
1712
- # the following:
1713
1854
  # @return [Hash<String,String>]
1714
1855
  #
1715
1856
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundVoiceContactRequest AWS API Documentation
@@ -1726,8 +1867,7 @@ module Aws::Connect
1726
1867
  end
1727
1868
 
1728
1869
  # @!attribute [rw] contact_id
1729
- # The unique identifier of this contact within your Amazon Connect
1730
- # instance.
1870
+ # The identifier of this contact within the Amazon Connect instance.
1731
1871
  # @return [String]
1732
1872
  #
1733
1873
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundVoiceContactResponse AWS API Documentation
@@ -1746,17 +1886,11 @@ module Aws::Connect
1746
1886
  # }
1747
1887
  #
1748
1888
  # @!attribute [rw] contact_id
1749
- # The unique identifier of the contact to end.
1889
+ # The ID of the contact.
1750
1890
  # @return [String]
1751
1891
  #
1752
1892
  # @!attribute [rw] instance_id
1753
- # The identifier for your Amazon Connect instance. To find the ID of
1754
- # your instance, open the AWS console and select Amazon Connect.
1755
- # Select the alias of the instance in the Instance alias column. The
1756
- # instance ID is displayed in the Overview section of your instance
1757
- # settings. For example, the instance ID is the set of characters at
1758
- # the end of the instance ARN, after instance/, such as
1759
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
1893
+ # The identifier of the Amazon Connect instance.
1760
1894
  # @return [String]
1761
1895
  #
1762
1896
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContactRequest AWS API Documentation
@@ -1771,8 +1905,7 @@ module Aws::Connect
1771
1905
  #
1772
1906
  class StopContactResponse < Aws::EmptyStructure; end
1773
1907
 
1774
- # A `Threshold` object that includes a comparison and `ThresholdValue`
1775
- # to compare to. Used with service level metrics.
1908
+ # Contains information about the threshold for service level metrics.
1776
1909
  #
1777
1910
  # @note When making an API call, you may pass Threshold
1778
1911
  # data as a hash:
@@ -1783,13 +1916,12 @@ module Aws::Connect
1783
1916
  # }
1784
1917
  #
1785
1918
  # @!attribute [rw] comparison
1786
- # The Threshold to use to compare service level metrics to. Only
1787
- # "Less than" (LT) comparisons are supported.
1919
+ # The type of comparison. Only "less than" (LT) comparisons are
1920
+ # supported.
1788
1921
  # @return [String]
1789
1922
  #
1790
1923
  # @!attribute [rw] threshold_value
1791
- # The value of the threshold to compare the metric to. Only "Less
1792
- # than" (LT) comparisons are supported.
1924
+ # The threshold value to compare.
1793
1925
  # @return [Float]
1794
1926
  #
1795
1927
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Threshold AWS API Documentation
@@ -1824,27 +1956,19 @@ module Aws::Connect
1824
1956
  # }
1825
1957
  #
1826
1958
  # @!attribute [rw] initial_contact_id
1827
- # The unique identifier of the contact for which to update attributes.
1828
- # This is the identifier for the contact associated with the first
1829
- # interaction with the contact center.
1959
+ # The identifier of the contact. This is the identifier of the contact
1960
+ # associated with the first interaction with the contact center.
1830
1961
  # @return [String]
1831
1962
  #
1832
1963
  # @!attribute [rw] instance_id
1833
- # The identifier for your Amazon Connect instance. To find the ID of
1834
- # your instance, open the AWS console and select Amazon Connect.
1835
- # Select the alias of the instance in the Instance alias column. The
1836
- # instance ID is displayed in the Overview section of your instance
1837
- # settings. For example, the instance ID is the set of characters at
1838
- # the end of the instance ARN, after instance/, such as
1839
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
1964
+ # The identifier of the Amazon Connect instance.
1840
1965
  # @return [String]
1841
1966
  #
1842
1967
  # @!attribute [rw] attributes
1843
- # Specify a custom key-value pair using an attribute map. The
1844
- # attributes are standard Amazon Connect attributes, and can be
1845
- # accessed in contact flows just like any other contact attributes.
1968
+ # The Amazon Connect attributes. These attributes can be accessed in
1969
+ # contact flows just like any other contact attributes.
1846
1970
  #
1847
- # There can be up to 32,768 UTF-8 bytes across all key-value pairs per
1971
+ # You can have up to 32,768 UTF-8 bytes across all attributes for a
1848
1972
  # contact. Attribute keys can include only alphanumeric, dash, and
1849
1973
  # underscore characters.
1850
1974
  # @return [Hash<String,String>]
@@ -1872,21 +1996,15 @@ module Aws::Connect
1872
1996
  # }
1873
1997
  #
1874
1998
  # @!attribute [rw] hierarchy_group_id
1875
- # The identifier for the hierarchy group to assign to the user.
1999
+ # The identifier of the hierarchy group.
1876
2000
  # @return [String]
1877
2001
  #
1878
2002
  # @!attribute [rw] user_id
1879
- # The identifier of the user account to assign the hierarchy group to.
2003
+ # The identifier of the user account.
1880
2004
  # @return [String]
1881
2005
  #
1882
2006
  # @!attribute [rw] instance_id
1883
- # The identifier for your Amazon Connect instance. To find the ID of
1884
- # your instance, open the AWS console and select Amazon Connect.
1885
- # Select the alias of the instance in the Instance alias column. The
1886
- # instance ID is displayed in the Overview section of your instance
1887
- # settings. For example, the instance ID is the set of characters at
1888
- # the end of the instance ARN, after instance/, such as
1889
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
2007
+ # The identifier of the Amazon Connect instance.
1890
2008
  # @return [String]
1891
2009
  #
1892
2010
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserHierarchyRequest AWS API Documentation
@@ -1912,22 +2030,15 @@ module Aws::Connect
1912
2030
  # }
1913
2031
  #
1914
2032
  # @!attribute [rw] identity_info
1915
- # A `UserIdentityInfo` object.
2033
+ # The identity information for the user.
1916
2034
  # @return [Types::UserIdentityInfo]
1917
2035
  #
1918
2036
  # @!attribute [rw] user_id
1919
- # The identifier for the user account to update identity information
1920
- # for.
2037
+ # The identifier of the user account.
1921
2038
  # @return [String]
1922
2039
  #
1923
2040
  # @!attribute [rw] instance_id
1924
- # The identifier for your Amazon Connect instance. To find the ID of
1925
- # your instance, open the AWS console and select Amazon Connect.
1926
- # Select the alias of the instance in the Instance alias column. The
1927
- # instance ID is displayed in the Overview section of your instance
1928
- # settings. For example, the instance ID is the set of characters at
1929
- # the end of the instance ARN, after instance/, such as
1930
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
2041
+ # The identifier of the Amazon Connect instance.
1931
2042
  # @return [String]
1932
2043
  #
1933
2044
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserIdentityInfoRequest AWS API Documentation
@@ -1954,23 +2065,15 @@ module Aws::Connect
1954
2065
  # }
1955
2066
  #
1956
2067
  # @!attribute [rw] phone_config
1957
- # A `UserPhoneConfig` object that contains settings for
1958
- # `AfterContactWorkTimeLimit`, `AutoAccept`, `DeskPhoneNumber`, and
1959
- # `PhoneType` to assign to the user.
2068
+ # Information about phone configuration settings for the user.
1960
2069
  # @return [Types::UserPhoneConfig]
1961
2070
  #
1962
2071
  # @!attribute [rw] user_id
1963
- # The identifier for the user account to change phone settings for.
2072
+ # The identifier of the user account.
1964
2073
  # @return [String]
1965
2074
  #
1966
2075
  # @!attribute [rw] instance_id
1967
- # The identifier for your Amazon Connect instance. To find the ID of
1968
- # your instance, open the AWS console and select Amazon Connect.
1969
- # Select the alias of the instance in the Instance alias column. The
1970
- # instance ID is displayed in the Overview section of your instance
1971
- # settings. For example, the instance ID is the set of characters at
1972
- # the end of the instance ARN, after instance/, such as
1973
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
2076
+ # The identifier of the Amazon Connect instance.
1974
2077
  # @return [String]
1975
2078
  #
1976
2079
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserPhoneConfigRequest AWS API Documentation
@@ -1992,22 +2095,15 @@ module Aws::Connect
1992
2095
  # }
1993
2096
  #
1994
2097
  # @!attribute [rw] routing_profile_id
1995
- # The identifier of the routing profile to assign to the user.
2098
+ # The identifier of the routing profile for the user.
1996
2099
  # @return [String]
1997
2100
  #
1998
2101
  # @!attribute [rw] user_id
1999
- # The identifier for the user account to assign the routing profile
2000
- # to.
2102
+ # The identifier of the user account.
2001
2103
  # @return [String]
2002
2104
  #
2003
2105
  # @!attribute [rw] instance_id
2004
- # The identifier for your Amazon Connect instance. To find the ID of
2005
- # your instance, open the AWS console and select Amazon Connect.
2006
- # Select the alias of the instance in the Instance alias column. The
2007
- # instance ID is displayed in the Overview section of your instance
2008
- # settings. For example, the instance ID is the set of characters at
2009
- # the end of the instance ARN, after instance/, such as
2010
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
2106
+ # The identifier of the Amazon Connect instance.
2011
2107
  # @return [String]
2012
2108
  #
2013
2109
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserRoutingProfileRequest AWS API Documentation
@@ -2029,21 +2125,15 @@ module Aws::Connect
2029
2125
  # }
2030
2126
  #
2031
2127
  # @!attribute [rw] security_profile_ids
2032
- # The identifiers for the security profiles to assign to the user.
2128
+ # The identifiers of the security profiles for the user.
2033
2129
  # @return [Array<String>]
2034
2130
  #
2035
2131
  # @!attribute [rw] user_id
2036
- # The identifier of the user account to assign the security profiles.
2132
+ # The identifier of the user account.
2037
2133
  # @return [String]
2038
2134
  #
2039
2135
  # @!attribute [rw] instance_id
2040
- # The identifier for your Amazon Connect instance. To find the ID of
2041
- # your instance, open the AWS console and select Amazon Connect.
2042
- # Select the alias of the instance in the Instance alias column. The
2043
- # instance ID is displayed in the Overview section of your instance
2044
- # settings. For example, the instance ID is the set of characters at
2045
- # the end of the instance ARN, after instance/, such as
2046
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
2136
+ # The identifier of the Amazon Connect instance.
2047
2137
  # @return [String]
2048
2138
  #
2049
2139
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserSecurityProfilesRequest AWS API Documentation
@@ -2055,15 +2145,15 @@ module Aws::Connect
2055
2145
  include Aws::Structure
2056
2146
  end
2057
2147
 
2058
- # A `User` object that contains information about a user account in your
2059
- # Amazon Connect instance, including configuration settings.
2148
+ # Contains information about a user account for a Amazon Connect
2149
+ # instance.
2060
2150
  #
2061
2151
  # @!attribute [rw] id
2062
2152
  # The identifier of the user account.
2063
2153
  # @return [String]
2064
2154
  #
2065
2155
  # @!attribute [rw] arn
2066
- # The ARN of the user account.
2156
+ # The Amazon Resource Name (ARN) of the user account.
2067
2157
  # @return [String]
2068
2158
  #
2069
2159
  # @!attribute [rw] username
@@ -2071,28 +2161,28 @@ module Aws::Connect
2071
2161
  # @return [String]
2072
2162
  #
2073
2163
  # @!attribute [rw] identity_info
2074
- # A `UserIdentityInfo` object.
2164
+ # Information about the user identity.
2075
2165
  # @return [Types::UserIdentityInfo]
2076
2166
  #
2077
2167
  # @!attribute [rw] phone_config
2078
- # A `UserPhoneConfig` object.
2168
+ # Information about the phone configuration for the user.
2079
2169
  # @return [Types::UserPhoneConfig]
2080
2170
  #
2081
2171
  # @!attribute [rw] directory_user_id
2082
- # The directory Id for the user account in the existing directory used
2083
- # for identity management.
2172
+ # The identifier of the user account in the directory used for
2173
+ # identity management.
2084
2174
  # @return [String]
2085
2175
  #
2086
2176
  # @!attribute [rw] security_profile_ids
2087
- # The identifier(s) for the security profile assigned to the user.
2177
+ # The identifiers of the security profiles for the user.
2088
2178
  # @return [Array<String>]
2089
2179
  #
2090
2180
  # @!attribute [rw] routing_profile_id
2091
- # The identifier of the routing profile assigned to the user.
2181
+ # The identifier of the routing profile for the user.
2092
2182
  # @return [String]
2093
2183
  #
2094
2184
  # @!attribute [rw] hierarchy_group_id
2095
- # The identifier for the hierarchy group assigned to the user.
2185
+ # The identifier of the hierarchy group for the user.
2096
2186
  # @return [String]
2097
2187
  #
2098
2188
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/User AWS API Documentation
@@ -2110,8 +2200,7 @@ module Aws::Connect
2110
2200
  include Aws::Structure
2111
2201
  end
2112
2202
 
2113
- # A `UserIdentityInfo` object that contains information about the
2114
- # user's identity, including email address, first name, and last name.
2203
+ # Contains information about the identity of a user.
2115
2204
  #
2116
2205
  # @note When making an API call, you may pass UserIdentityInfo
2117
2206
  # data as a hash:
@@ -2123,19 +2212,18 @@ module Aws::Connect
2123
2212
  # }
2124
2213
  #
2125
2214
  # @!attribute [rw] first_name
2126
- # The first name used in the user account. This is required if you are
2127
- # using Amazon Connect or SAML for identity management.
2215
+ # The first name. This is required if you are using Amazon Connect or
2216
+ # SAML for identity management.
2128
2217
  # @return [String]
2129
2218
  #
2130
2219
  # @!attribute [rw] last_name
2131
- # The last name used in the user account. This is required if you are
2132
- # using Amazon Connect or SAML for identity management.
2220
+ # The last name. This is required if you are using Amazon Connect or
2221
+ # SAML for identity management.
2133
2222
  # @return [String]
2134
2223
  #
2135
2224
  # @!attribute [rw] email
2136
- # The email address added to the user account. If you are using SAML
2137
- # for identity management and include this parameter, an
2138
- # `InvalidRequestException` is returned.
2225
+ # The email address. If you are using SAML for identity management and
2226
+ # include this parameter, an error is returned.
2139
2227
  # @return [String]
2140
2228
  #
2141
2229
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserIdentityInfo AWS API Documentation
@@ -2160,8 +2248,8 @@ module Aws::Connect
2160
2248
  include Aws::Structure
2161
2249
  end
2162
2250
 
2163
- # A `UserPhoneConfig` object that contains information about the user
2164
- # phone configuration settings.
2251
+ # Contains information about the phone configuration settings for a
2252
+ # user.
2165
2253
  #
2166
2254
  # @note When making an API call, you may pass UserPhoneConfig
2167
2255
  # data as a hash:
@@ -2174,16 +2262,15 @@ module Aws::Connect
2174
2262
  # }
2175
2263
  #
2176
2264
  # @!attribute [rw] phone_type
2177
- # The phone type selected for the user, either Soft phone or Desk
2178
- # phone.
2265
+ # The phone type.
2179
2266
  # @return [String]
2180
2267
  #
2181
2268
  # @!attribute [rw] auto_accept
2182
- # The Auto accept setting for the user, Yes or No.
2269
+ # The Auto accept setting.
2183
2270
  # @return [Boolean]
2184
2271
  #
2185
2272
  # @!attribute [rw] after_contact_work_time_limit
2186
- # The After Call Work (ACW) timeout setting, in seconds, for the user.
2273
+ # The After Call Work (ACW) timeout setting, in seconds.
2187
2274
  # @return [Integer]
2188
2275
  #
2189
2276
  # @!attribute [rw] desk_phone_number
@@ -2200,19 +2287,18 @@ module Aws::Connect
2200
2287
  include Aws::Structure
2201
2288
  end
2202
2289
 
2203
- # A `UserSummary` object that contains Information about a user,
2204
- # including ARN, Id, and user name.
2290
+ # Contains summary information about a user.
2205
2291
  #
2206
2292
  # @!attribute [rw] id
2207
- # The identifier for the user account.
2293
+ # The identifier of the user account.
2208
2294
  # @return [String]
2209
2295
  #
2210
2296
  # @!attribute [rw] arn
2211
- # The ARN for the user account.
2297
+ # The Amazon Resource Name (ARN) of the user account.
2212
2298
  # @return [String]
2213
2299
  #
2214
2300
  # @!attribute [rw] username
2215
- # The Amazon Connect user name for the user account.
2301
+ # The Amazon Connect user name of the user account.
2216
2302
  # @return [String]
2217
2303
  #
2218
2304
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserSummary AWS API Documentation