aws-sdk-connect 1.69.0 → 1.72.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -526,7 +526,7 @@ module Aws::Connect
526
526
  include Aws::Structure
527
527
  end
528
528
 
529
- # Information about the attachment reference if the `referenceType` is
529
+ # Information about a reference when the `referenceType` is
530
530
  # `ATTACHMENT`. Otherwise, null.
531
531
  #
532
532
  # @!attribute [rw] name
@@ -534,11 +534,11 @@ module Aws::Connect
534
534
  # @return [String]
535
535
  #
536
536
  # @!attribute [rw] value
537
- # Contains the location path of the attachment reference.
537
+ # The location path of the attachment reference.
538
538
  # @return [String]
539
539
  #
540
540
  # @!attribute [rw] status
541
- # Status of an attachment reference type.
541
+ # Status of the attachment reference type.
542
542
  # @return [String]
543
543
  #
544
544
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AttachmentReference AWS API Documentation
@@ -699,7 +699,7 @@ module Aws::Connect
699
699
  end
700
700
 
701
701
  # @!attribute [rw] phone_number_id
702
- # The identifier of the phone number.
702
+ # A unique identifier for the phone number.
703
703
  # @return [String]
704
704
  #
705
705
  # @!attribute [rw] phone_number_arn
@@ -719,7 +719,7 @@ module Aws::Connect
719
719
  # Connect instance.
720
720
  #
721
721
  # @!attribute [rw] phone_number_id
722
- # The identifier of the phone number.
722
+ # A unique identifier for the phone number.
723
723
  # @return [String]
724
724
  #
725
725
  # @!attribute [rw] phone_number_arn
@@ -1064,6 +1064,64 @@ module Aws::Connect
1064
1064
  include Aws::Structure
1065
1065
  end
1066
1066
 
1067
+ # An object that can be used to specify Tag conditions inside the
1068
+ # `SearchFilter`. This accepts an `OR` of `AND` (List of List) input
1069
+ # where:
1070
+ #
1071
+ # * Top level list specifies conditions that need to be applied with
1072
+ # `OR` operator
1073
+ #
1074
+ # * Inner list specifies conditions that need to be applied with `AND`
1075
+ # operator.
1076
+ #
1077
+ # @note When making an API call, you may pass ControlPlaneTagFilter
1078
+ # data as a hash:
1079
+ #
1080
+ # {
1081
+ # or_conditions: [
1082
+ # [
1083
+ # {
1084
+ # tag_key: "String",
1085
+ # tag_value: "String",
1086
+ # },
1087
+ # ],
1088
+ # ],
1089
+ # and_conditions: [
1090
+ # {
1091
+ # tag_key: "String",
1092
+ # tag_value: "String",
1093
+ # },
1094
+ # ],
1095
+ # tag_condition: {
1096
+ # tag_key: "String",
1097
+ # tag_value: "String",
1098
+ # },
1099
+ # }
1100
+ #
1101
+ # @!attribute [rw] or_conditions
1102
+ # A list of conditions which would be applied together with an `OR`
1103
+ # condition.
1104
+ # @return [Array<Array<Types::TagCondition>>]
1105
+ #
1106
+ # @!attribute [rw] and_conditions
1107
+ # A list of conditions which would be applied together with an `AND`
1108
+ # condition.
1109
+ # @return [Array<Types::TagCondition>]
1110
+ #
1111
+ # @!attribute [rw] tag_condition
1112
+ # A leaf node condition which can be used to specify a tag condition.
1113
+ # @return [Types::TagCondition]
1114
+ #
1115
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ControlPlaneTagFilter AWS API Documentation
1116
+ #
1117
+ class ControlPlaneTagFilter < Struct.new(
1118
+ :or_conditions,
1119
+ :and_conditions,
1120
+ :tag_condition)
1121
+ SENSITIVE = []
1122
+ include Aws::Structure
1123
+ end
1124
+
1067
1125
  # @note When making an API call, you may pass CreateAgentStatusRequest
1068
1126
  # data as a hash:
1069
1127
  #
@@ -1831,6 +1889,140 @@ module Aws::Connect
1831
1889
  include Aws::Structure
1832
1890
  end
1833
1891
 
1892
+ # @note When making an API call, you may pass CreateTaskTemplateRequest
1893
+ # data as a hash:
1894
+ #
1895
+ # {
1896
+ # instance_id: "InstanceId", # required
1897
+ # name: "TaskTemplateName", # required
1898
+ # description: "TaskTemplateDescription",
1899
+ # contact_flow_id: "ContactFlowId",
1900
+ # constraints: {
1901
+ # required_fields: [
1902
+ # {
1903
+ # id: {
1904
+ # name: "TaskTemplateFieldName",
1905
+ # },
1906
+ # },
1907
+ # ],
1908
+ # read_only_fields: [
1909
+ # {
1910
+ # id: {
1911
+ # name: "TaskTemplateFieldName",
1912
+ # },
1913
+ # },
1914
+ # ],
1915
+ # invisible_fields: [
1916
+ # {
1917
+ # id: {
1918
+ # name: "TaskTemplateFieldName",
1919
+ # },
1920
+ # },
1921
+ # ],
1922
+ # },
1923
+ # defaults: {
1924
+ # default_field_values: [
1925
+ # {
1926
+ # id: {
1927
+ # name: "TaskTemplateFieldName",
1928
+ # },
1929
+ # default_value: "TaskTemplateFieldValue",
1930
+ # },
1931
+ # ],
1932
+ # },
1933
+ # status: "ACTIVE", # accepts ACTIVE, INACTIVE
1934
+ # fields: [ # required
1935
+ # {
1936
+ # id: { # required
1937
+ # name: "TaskTemplateFieldName",
1938
+ # },
1939
+ # description: "TaskTemplateFieldDescription",
1940
+ # type: "NAME", # accepts NAME, DESCRIPTION, SCHEDULED_TIME, QUICK_CONNECT, URL, NUMBER, TEXT, TEXT_AREA, DATE_TIME, BOOLEAN, SINGLE_SELECT, EMAIL
1941
+ # single_select_options: ["TaskTemplateSingleSelectOption"],
1942
+ # },
1943
+ # ],
1944
+ # client_token: "ClientToken",
1945
+ # }
1946
+ #
1947
+ # @!attribute [rw] instance_id
1948
+ # The identifier of the Amazon Connect instance. You can find the
1949
+ # instanceId in the ARN of the instance.
1950
+ # @return [String]
1951
+ #
1952
+ # @!attribute [rw] name
1953
+ # The name of the task template.
1954
+ # @return [String]
1955
+ #
1956
+ # @!attribute [rw] description
1957
+ # The description of the task template.
1958
+ # @return [String]
1959
+ #
1960
+ # @!attribute [rw] contact_flow_id
1961
+ # The identifier of the flow that runs by default when a task is
1962
+ # created by referencing this template.
1963
+ # @return [String]
1964
+ #
1965
+ # @!attribute [rw] constraints
1966
+ # Constraints that are applicable to the fields listed.
1967
+ # @return [Types::TaskTemplateConstraints]
1968
+ #
1969
+ # @!attribute [rw] defaults
1970
+ # The default values for fields when a task is created by referencing
1971
+ # this template.
1972
+ # @return [Types::TaskTemplateDefaults]
1973
+ #
1974
+ # @!attribute [rw] status
1975
+ # Marks a template as `ACTIVE` or `INACTIVE` for a task to refer to
1976
+ # it. Tasks can only be created from `ACTIVE` templates. If a template
1977
+ # is marked as `INACTIVE`, then a task that refers to this template
1978
+ # cannot be created.
1979
+ # @return [String]
1980
+ #
1981
+ # @!attribute [rw] fields
1982
+ # Fields that are part of the template.
1983
+ # @return [Array<Types::TaskTemplateField>]
1984
+ #
1985
+ # @!attribute [rw] client_token
1986
+ # A unique, case-sensitive identifier that you provide to ensure the
1987
+ # idempotency of the request.
1988
+ #
1989
+ # **A suitable default value is auto-generated.** You should normally
1990
+ # not need to pass this option.
1991
+ # @return [String]
1992
+ #
1993
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateTaskTemplateRequest AWS API Documentation
1994
+ #
1995
+ class CreateTaskTemplateRequest < Struct.new(
1996
+ :instance_id,
1997
+ :name,
1998
+ :description,
1999
+ :contact_flow_id,
2000
+ :constraints,
2001
+ :defaults,
2002
+ :status,
2003
+ :fields,
2004
+ :client_token)
2005
+ SENSITIVE = []
2006
+ include Aws::Structure
2007
+ end
2008
+
2009
+ # @!attribute [rw] id
2010
+ # The identifier of the task template resource.
2011
+ # @return [String]
2012
+ #
2013
+ # @!attribute [rw] arn
2014
+ # The Amazon Resource Name (ARN) for the task template resource.
2015
+ # @return [String]
2016
+ #
2017
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateTaskTemplateResponse AWS API Documentation
2018
+ #
2019
+ class CreateTaskTemplateResponse < Struct.new(
2020
+ :id,
2021
+ :arn)
2022
+ SENSITIVE = []
2023
+ include Aws::Structure
2024
+ end
2025
+
1834
2026
  # @note When making an API call, you may pass CreateUseCaseRequest
1835
2027
  # data as a hash:
1836
2028
  #
@@ -2268,6 +2460,26 @@ module Aws::Connect
2268
2460
  include Aws::Structure
2269
2461
  end
2270
2462
 
2463
+ # Information about a reference when the `referenceType` is `DATE`.
2464
+ # Otherwise, null.
2465
+ #
2466
+ # @!attribute [rw] name
2467
+ # Identifier of the date reference.
2468
+ # @return [String]
2469
+ #
2470
+ # @!attribute [rw] value
2471
+ # A valid date.
2472
+ # @return [String]
2473
+ #
2474
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DateReference AWS API Documentation
2475
+ #
2476
+ class DateReference < Struct.new(
2477
+ :name,
2478
+ :value)
2479
+ SENSITIVE = []
2480
+ include Aws::Structure
2481
+ end
2482
+
2271
2483
  # Contains information about a default vocabulary.
2272
2484
  #
2273
2485
  # @!attribute [rw] instance_id
@@ -2484,6 +2696,36 @@ module Aws::Connect
2484
2696
  include Aws::Structure
2485
2697
  end
2486
2698
 
2699
+ # @note When making an API call, you may pass DeleteTaskTemplateRequest
2700
+ # data as a hash:
2701
+ #
2702
+ # {
2703
+ # instance_id: "InstanceId", # required
2704
+ # task_template_id: "TaskTemplateId", # required
2705
+ # }
2706
+ #
2707
+ # @!attribute [rw] instance_id
2708
+ # The identifier of the Amazon Connect instance. You can find the
2709
+ # instanceId in the ARN of the instance.
2710
+ # @return [String]
2711
+ #
2712
+ # @!attribute [rw] task_template_id
2713
+ # A unique identifier for the task template.
2714
+ # @return [String]
2715
+ #
2716
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteTaskTemplateRequest AWS API Documentation
2717
+ #
2718
+ class DeleteTaskTemplateRequest < Struct.new(
2719
+ :instance_id,
2720
+ :task_template_id)
2721
+ SENSITIVE = []
2722
+ include Aws::Structure
2723
+ end
2724
+
2725
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteTaskTemplateResponse AWS API Documentation
2726
+ #
2727
+ class DeleteTaskTemplateResponse < Aws::EmptyStructure; end
2728
+
2487
2729
  # @note When making an API call, you may pass DeleteUseCaseRequest
2488
2730
  # data as a hash:
2489
2731
  #
@@ -2928,7 +3170,7 @@ module Aws::Connect
2928
3170
  # }
2929
3171
  #
2930
3172
  # @!attribute [rw] phone_number_id
2931
- # The identifier of the phone number.
3173
+ # A unique identifier for the phone number.
2932
3174
  # @return [String]
2933
3175
  #
2934
3176
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribePhoneNumberRequest AWS API Documentation
@@ -3450,7 +3692,7 @@ module Aws::Connect
3450
3692
  # }
3451
3693
  #
3452
3694
  # @!attribute [rw] phone_number_id
3453
- # The identifier of the phone number.
3695
+ # A unique identifier for the phone number.
3454
3696
  # @return [String]
3455
3697
  #
3456
3698
  # @!attribute [rw] instance_id
@@ -3576,6 +3818,26 @@ module Aws::Connect
3576
3818
  include Aws::Structure
3577
3819
  end
3578
3820
 
3821
+ # Information about a reference when the `referenceType` is `EMAIL`.
3822
+ # Otherwise, null.
3823
+ #
3824
+ # @!attribute [rw] name
3825
+ # Identifier of the email reference.
3826
+ # @return [String]
3827
+ #
3828
+ # @!attribute [rw] value
3829
+ # A valid email address.
3830
+ # @return [String]
3831
+ #
3832
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EmailReference AWS API Documentation
3833
+ #
3834
+ class EmailReference < Struct.new(
3835
+ :name,
3836
+ :value)
3837
+ SENSITIVE = []
3838
+ include Aws::Structure
3839
+ end
3840
+
3579
3841
  # The encryption configuration.
3580
3842
  #
3581
3843
  # @note When making an API call, you may pass EncryptionConfig
@@ -4216,6 +4478,118 @@ module Aws::Connect
4216
4478
  include Aws::Structure
4217
4479
  end
4218
4480
 
4481
+ # @note When making an API call, you may pass GetTaskTemplateRequest
4482
+ # data as a hash:
4483
+ #
4484
+ # {
4485
+ # instance_id: "InstanceId", # required
4486
+ # task_template_id: "TaskTemplateId", # required
4487
+ # snapshot_version: "SnapshotVersion",
4488
+ # }
4489
+ #
4490
+ # @!attribute [rw] instance_id
4491
+ # The identifier of the Amazon Connect instance. You can find the
4492
+ # instanceId in the ARN of the instance.
4493
+ # @return [String]
4494
+ #
4495
+ # @!attribute [rw] task_template_id
4496
+ # A unique identifier for the task template.
4497
+ # @return [String]
4498
+ #
4499
+ # @!attribute [rw] snapshot_version
4500
+ # The system generated version of a task template that is associated
4501
+ # with a task, when the task is created.
4502
+ # @return [String]
4503
+ #
4504
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetTaskTemplateRequest AWS API Documentation
4505
+ #
4506
+ class GetTaskTemplateRequest < Struct.new(
4507
+ :instance_id,
4508
+ :task_template_id,
4509
+ :snapshot_version)
4510
+ SENSITIVE = []
4511
+ include Aws::Structure
4512
+ end
4513
+
4514
+ # @!attribute [rw] instance_id
4515
+ # The identifier of the Amazon Connect instance. You can find the
4516
+ # instanceId in the ARN of the instance.
4517
+ # @return [String]
4518
+ #
4519
+ # @!attribute [rw] id
4520
+ # A unique identifier for the task template.
4521
+ # @return [String]
4522
+ #
4523
+ # @!attribute [rw] arn
4524
+ # The Amazon Resource Name (ARN).
4525
+ # @return [String]
4526
+ #
4527
+ # @!attribute [rw] name
4528
+ # The name of the task template.
4529
+ # @return [String]
4530
+ #
4531
+ # @!attribute [rw] description
4532
+ # The description of the task template.
4533
+ # @return [String]
4534
+ #
4535
+ # @!attribute [rw] contact_flow_id
4536
+ # The identifier of the flow that runs by default when a task is
4537
+ # created by referencing this template.
4538
+ # @return [String]
4539
+ #
4540
+ # @!attribute [rw] constraints
4541
+ # Constraints that are applicable to the fields listed.
4542
+ # @return [Types::TaskTemplateConstraints]
4543
+ #
4544
+ # @!attribute [rw] defaults
4545
+ # The default values for fields when a task is created by referencing
4546
+ # this template.
4547
+ # @return [Types::TaskTemplateDefaults]
4548
+ #
4549
+ # @!attribute [rw] fields
4550
+ # Fields that are part of the template.
4551
+ # @return [Array<Types::TaskTemplateField>]
4552
+ #
4553
+ # @!attribute [rw] status
4554
+ # Marks a template as `ACTIVE` or `INACTIVE` for a task to refer to
4555
+ # it. Tasks can only be created from `ACTIVE` templates. If a template
4556
+ # is marked as `INACTIVE`, then a task that refers to this template
4557
+ # cannot be created.
4558
+ # @return [String]
4559
+ #
4560
+ # @!attribute [rw] last_modified_time
4561
+ # The timestamp when the task template was last modified.
4562
+ # @return [Time]
4563
+ #
4564
+ # @!attribute [rw] created_time
4565
+ # The timestamp when the task template was created.
4566
+ # @return [Time]
4567
+ #
4568
+ # @!attribute [rw] tags
4569
+ # The tags used to organize, track, or control access for this
4570
+ # resource.
4571
+ # @return [Hash<String,String>]
4572
+ #
4573
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetTaskTemplateResponse AWS API Documentation
4574
+ #
4575
+ class GetTaskTemplateResponse < Struct.new(
4576
+ :instance_id,
4577
+ :id,
4578
+ :arn,
4579
+ :name,
4580
+ :description,
4581
+ :contact_flow_id,
4582
+ :constraints,
4583
+ :defaults,
4584
+ :fields,
4585
+ :status,
4586
+ :last_modified_time,
4587
+ :created_time,
4588
+ :tags)
4589
+ SENSITIVE = []
4590
+ include Aws::Structure
4591
+ end
4592
+
4219
4593
  # Contains information about a hierarchy group.
4220
4594
  #
4221
4595
  # @!attribute [rw] id
@@ -4256,6 +4630,34 @@ module Aws::Connect
4256
4630
  include Aws::Structure
4257
4631
  end
4258
4632
 
4633
+ # A leaf node condition which can be used to specify a hierarchy group
4634
+ # condition.
4635
+ #
4636
+ # @note When making an API call, you may pass HierarchyGroupCondition
4637
+ # data as a hash:
4638
+ #
4639
+ # {
4640
+ # value: "String",
4641
+ # hierarchy_group_match_type: "EXACT", # accepts EXACT, WITH_CHILD_GROUPS
4642
+ # }
4643
+ #
4644
+ # @!attribute [rw] value
4645
+ # The value in the hierarchy group condition.
4646
+ # @return [String]
4647
+ #
4648
+ # @!attribute [rw] hierarchy_group_match_type
4649
+ # The type of hierarchy group match.
4650
+ # @return [String]
4651
+ #
4652
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HierarchyGroupCondition AWS API Documentation
4653
+ #
4654
+ class HierarchyGroupCondition < Struct.new(
4655
+ :value,
4656
+ :hierarchy_group_match_type)
4657
+ SENSITIVE = []
4658
+ include Aws::Structure
4659
+ end
4660
+
4259
4661
  # Contains summary information about a hierarchy group.
4260
4662
  #
4261
4663
  # @!attribute [rw] id
@@ -5002,6 +5404,29 @@ module Aws::Connect
5002
5404
  include Aws::Structure
5003
5405
  end
5004
5406
 
5407
+ # A field that is invisible to an agent.
5408
+ #
5409
+ # @note When making an API call, you may pass InvisibleFieldInfo
5410
+ # data as a hash:
5411
+ #
5412
+ # {
5413
+ # id: {
5414
+ # name: "TaskTemplateFieldName",
5415
+ # },
5416
+ # }
5417
+ #
5418
+ # @!attribute [rw] id
5419
+ # Identifier of the invisible field.
5420
+ # @return [Types::TaskTemplateFieldIdentifier]
5421
+ #
5422
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/InvisibleFieldInfo AWS API Documentation
5423
+ #
5424
+ class InvisibleFieldInfo < Struct.new(
5425
+ :id)
5426
+ SENSITIVE = []
5427
+ include Aws::Structure
5428
+ end
5429
+
5005
5430
  # Configuration information of a Kinesis Data Firehose delivery stream.
5006
5431
  #
5007
5432
  # @note When making an API call, you may pass KinesisFirehoseConfig
@@ -5457,7 +5882,7 @@ module Aws::Connect
5457
5882
  # {
5458
5883
  # instance_id: "InstanceId", # required
5459
5884
  # contact_id: "ContactId", # required
5460
- # reference_types: ["URL"], # required, accepts URL, ATTACHMENT
5885
+ # reference_types: ["URL"], # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
5461
5886
  # next_token: "NextToken",
5462
5887
  # }
5463
5888
  #
@@ -6017,7 +6442,7 @@ module Aws::Connect
6017
6442
  # Connect instance.
6018
6443
  #
6019
6444
  # @!attribute [rw] phone_number_id
6020
- # The identifier of the phone number.
6445
+ # A unique identifier for the phone number.
6021
6446
  # @return [String]
6022
6447
  #
6023
6448
  # @!attribute [rw] phone_number_arn
@@ -6660,7 +7085,82 @@ module Aws::Connect
6660
7085
  include Aws::Structure
6661
7086
  end
6662
7087
 
6663
- # Provides summary information about the use cases for the specified
7088
+ # @note When making an API call, you may pass ListTaskTemplatesRequest
7089
+ # data as a hash:
7090
+ #
7091
+ # {
7092
+ # instance_id: "InstanceId", # required
7093
+ # next_token: "NextToken",
7094
+ # max_results: 1,
7095
+ # status: "ACTIVE", # accepts ACTIVE, INACTIVE
7096
+ # name: "TaskTemplateName",
7097
+ # }
7098
+ #
7099
+ # @!attribute [rw] instance_id
7100
+ # The identifier of the Amazon Connect instance. You can find the
7101
+ # instanceId in the ARN of the instance.
7102
+ # @return [String]
7103
+ #
7104
+ # @!attribute [rw] next_token
7105
+ # The token for the next set of results. Use the value returned in the
7106
+ # previous response in the next request to retrieve the next set of
7107
+ # results.
7108
+ #
7109
+ # It is not expected that you set this because the value returned in
7110
+ # the previous response is always null.
7111
+ # @return [String]
7112
+ #
7113
+ # @!attribute [rw] max_results
7114
+ # The maximum number of results to return per page.
7115
+ #
7116
+ # It is not expected that you set this.
7117
+ # @return [Integer]
7118
+ #
7119
+ # @!attribute [rw] status
7120
+ # Marks a template as `ACTIVE` or `INACTIVE` for a task to refer to
7121
+ # it. Tasks can only be created from `ACTIVE` templates. If a template
7122
+ # is marked as `INACTIVE`, then a task that refers to this template
7123
+ # cannot be created.
7124
+ # @return [String]
7125
+ #
7126
+ # @!attribute [rw] name
7127
+ # The name of the task template.
7128
+ # @return [String]
7129
+ #
7130
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListTaskTemplatesRequest AWS API Documentation
7131
+ #
7132
+ class ListTaskTemplatesRequest < Struct.new(
7133
+ :instance_id,
7134
+ :next_token,
7135
+ :max_results,
7136
+ :status,
7137
+ :name)
7138
+ SENSITIVE = []
7139
+ include Aws::Structure
7140
+ end
7141
+
7142
+ # @!attribute [rw] task_templates
7143
+ # Provides details about a list of task templates belonging to an
7144
+ # instance.
7145
+ # @return [Array<Types::TaskTemplateMetadata>]
7146
+ #
7147
+ # @!attribute [rw] next_token
7148
+ # If there are additional results, this is the token for the next set
7149
+ # of results.
7150
+ #
7151
+ # This is always returned as a null in the response.
7152
+ # @return [String]
7153
+ #
7154
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListTaskTemplatesResponse AWS API Documentation
7155
+ #
7156
+ class ListTaskTemplatesResponse < Struct.new(
7157
+ :task_templates,
7158
+ :next_token)
7159
+ SENSITIVE = []
7160
+ include Aws::Structure
7161
+ end
7162
+
7163
+ # Provides summary information about the use cases for the specified
6664
7164
  # integration association.
6665
7165
  #
6666
7166
  # @note When making an API call, you may pass ListUseCasesRequest
@@ -6861,6 +7361,26 @@ module Aws::Connect
6861
7361
  include Aws::Structure
6862
7362
  end
6863
7363
 
7364
+ # Information about a reference when the `referenceType` is `NUMBER`.
7365
+ # Otherwise, null.
7366
+ #
7367
+ # @!attribute [rw] name
7368
+ # Identifier of the number reference.
7369
+ # @return [String]
7370
+ #
7371
+ # @!attribute [rw] value
7372
+ # A valid number.
7373
+ # @return [String]
7374
+ #
7375
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/NumberReference AWS API Documentation
7376
+ #
7377
+ class NumberReference < Struct.new(
7378
+ :name,
7379
+ :value)
7380
+ SENSITIVE = []
7381
+ include Aws::Structure
7382
+ end
7383
+
6864
7384
  # The outbound caller ID name, number, and outbound whisper flow.
6865
7385
  #
6866
7386
  # @note When making an API call, you may pass OutboundCallerConfig
@@ -7042,6 +7562,81 @@ module Aws::Connect
7042
7562
  include Aws::Structure
7043
7563
  end
7044
7564
 
7565
+ # @!attribute [rw] message
7566
+ # @return [String]
7567
+ #
7568
+ # @!attribute [rw] property_list
7569
+ # @return [Array<Types::PropertyValidationExceptionProperty>]
7570
+ #
7571
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/PropertyValidationException AWS API Documentation
7572
+ #
7573
+ class PropertyValidationException < Struct.new(
7574
+ :message,
7575
+ :property_list)
7576
+ SENSITIVE = []
7577
+ include Aws::Structure
7578
+ end
7579
+
7580
+ # Contains information about why a property is not valid.
7581
+ #
7582
+ # @!attribute [rw] property_path
7583
+ # The full property path.
7584
+ # @return [String]
7585
+ #
7586
+ # @!attribute [rw] reason
7587
+ # Why the property is not valid.
7588
+ # @return [String]
7589
+ #
7590
+ # @!attribute [rw] message
7591
+ # A message describing why the property is not valid.
7592
+ # @return [String]
7593
+ #
7594
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/PropertyValidationExceptionProperty AWS API Documentation
7595
+ #
7596
+ class PropertyValidationExceptionProperty < Struct.new(
7597
+ :property_path,
7598
+ :reason,
7599
+ :message)
7600
+ SENSITIVE = []
7601
+ include Aws::Structure
7602
+ end
7603
+
7604
+ # @note When making an API call, you may pass PutUserStatusRequest
7605
+ # data as a hash:
7606
+ #
7607
+ # {
7608
+ # user_id: "UserId", # required
7609
+ # instance_id: "InstanceId", # required
7610
+ # agent_status_id: "AgentStatusId", # required
7611
+ # }
7612
+ #
7613
+ # @!attribute [rw] user_id
7614
+ # The identifier of the user.
7615
+ # @return [String]
7616
+ #
7617
+ # @!attribute [rw] instance_id
7618
+ # The identifier of the Amazon Connect instance. You can find the
7619
+ # instanceId in the ARN of the instance.
7620
+ # @return [String]
7621
+ #
7622
+ # @!attribute [rw] agent_status_id
7623
+ # The identifier of the agent status.
7624
+ # @return [String]
7625
+ #
7626
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/PutUserStatusRequest AWS API Documentation
7627
+ #
7628
+ class PutUserStatusRequest < Struct.new(
7629
+ :user_id,
7630
+ :instance_id,
7631
+ :agent_status_id)
7632
+ SENSITIVE = []
7633
+ include Aws::Structure
7634
+ end
7635
+
7636
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/PutUserStatusResponse AWS API Documentation
7637
+ #
7638
+ class PutUserStatusResponse < Aws::EmptyStructure; end
7639
+
7045
7640
  # Contains information about a queue.
7046
7641
  #
7047
7642
  # @!attribute [rw] name
@@ -7319,15 +7914,39 @@ module Aws::Connect
7319
7914
  include Aws::Structure
7320
7915
  end
7321
7916
 
7322
- # A link that an agent selects to complete a given task. You can have up
7323
- # to 4,096 UTF-8 bytes across all references for a contact.
7917
+ # Indicates a field that is read-only to an agent.
7918
+ #
7919
+ # @note When making an API call, you may pass ReadOnlyFieldInfo
7920
+ # data as a hash:
7921
+ #
7922
+ # {
7923
+ # id: {
7924
+ # name: "TaskTemplateFieldName",
7925
+ # },
7926
+ # }
7927
+ #
7928
+ # @!attribute [rw] id
7929
+ # Identifier of the read-only field.
7930
+ # @return [Types::TaskTemplateFieldIdentifier]
7931
+ #
7932
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ReadOnlyFieldInfo AWS API Documentation
7933
+ #
7934
+ class ReadOnlyFieldInfo < Struct.new(
7935
+ :id)
7936
+ SENSITIVE = []
7937
+ include Aws::Structure
7938
+ end
7939
+
7940
+ # Well-formed data on a contact, used by agents to complete a contact
7941
+ # request. You can have up to 4,096 UTF-8 bytes across all references
7942
+ # for a contact.
7324
7943
  #
7325
7944
  # @note When making an API call, you may pass Reference
7326
7945
  # data as a hash:
7327
7946
  #
7328
7947
  # {
7329
7948
  # value: "ReferenceValue", # required
7330
- # type: "URL", # required, accepts URL, ATTACHMENT
7949
+ # type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
7331
7950
  # }
7332
7951
  #
7333
7952
  # @!attribute [rw] value
@@ -7337,8 +7956,7 @@ module Aws::Connect
7337
7956
  # @return [String]
7338
7957
  #
7339
7958
  # @!attribute [rw] type
7340
- # The type of the reference. Only `URL` type can be added or updated
7341
- # on a contact.
7959
+ # The type of the reference.
7342
7960
  # @return [String]
7343
7961
  #
7344
7962
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Reference AWS API Documentation
@@ -7357,20 +7975,44 @@ module Aws::Connect
7357
7975
  # @note ReferenceSummary is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ReferenceSummary corresponding to the set member.
7358
7976
  #
7359
7977
  # @!attribute [rw] url
7360
- # Information about the URL reference if the `referenceType` is `URL`.
7978
+ # Information about the reference when the `referenceType` is `URL`.
7361
7979
  # Otherwise, null.
7362
7980
  # @return [Types::UrlReference]
7363
7981
  #
7364
7982
  # @!attribute [rw] attachment
7365
- # Information about the attachment reference if the `referenceType` is
7983
+ # Information about the reference when the `referenceType` is
7366
7984
  # `ATTACHMENT`. Otherwise, null.
7367
7985
  # @return [Types::AttachmentReference]
7368
7986
  #
7987
+ # @!attribute [rw] string
7988
+ # Information about a reference when the `referenceType` is `STRING`.
7989
+ # Otherwise, null.
7990
+ # @return [Types::StringReference]
7991
+ #
7992
+ # @!attribute [rw] number
7993
+ # Information about a reference when the `referenceType` is `NUMBER`.
7994
+ # Otherwise, null.
7995
+ # @return [Types::NumberReference]
7996
+ #
7997
+ # @!attribute [rw] date
7998
+ # Information about a reference when the `referenceType` is `DATE`.
7999
+ # Otherwise, null.
8000
+ # @return [Types::DateReference]
8001
+ #
8002
+ # @!attribute [rw] email
8003
+ # Information about a reference when the `referenceType` is `EMAIL`.
8004
+ # Otherwise, null.
8005
+ # @return [Types::EmailReference]
8006
+ #
7369
8007
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ReferenceSummary AWS API Documentation
7370
8008
  #
7371
8009
  class ReferenceSummary < Struct.new(
7372
8010
  :url,
7373
8011
  :attachment,
8012
+ :string,
8013
+ :number,
8014
+ :date,
8015
+ :email,
7374
8016
  :unknown)
7375
8017
  SENSITIVE = []
7376
8018
  include Aws::Structure
@@ -7378,6 +8020,10 @@ module Aws::Connect
7378
8020
 
7379
8021
  class Url < ReferenceSummary; end
7380
8022
  class Attachment < ReferenceSummary; end
8023
+ class String < ReferenceSummary; end
8024
+ class Number < ReferenceSummary; end
8025
+ class Date < ReferenceSummary; end
8026
+ class Email < ReferenceSummary; end
7381
8027
  class Unknown < ReferenceSummary; end
7382
8028
  end
7383
8029
 
@@ -7390,7 +8036,7 @@ module Aws::Connect
7390
8036
  # }
7391
8037
  #
7392
8038
  # @!attribute [rw] phone_number_id
7393
- # The identifier of the phone number.
8039
+ # A unique identifier for the phone number.
7394
8040
  # @return [String]
7395
8041
  #
7396
8042
  # @!attribute [rw] client_token
@@ -7410,6 +8056,29 @@ module Aws::Connect
7410
8056
  include Aws::Structure
7411
8057
  end
7412
8058
 
8059
+ # Information about a required field.
8060
+ #
8061
+ # @note When making an API call, you may pass RequiredFieldInfo
8062
+ # data as a hash:
8063
+ #
8064
+ # {
8065
+ # id: {
8066
+ # name: "TaskTemplateFieldName",
8067
+ # },
8068
+ # }
8069
+ #
8070
+ # @!attribute [rw] id
8071
+ # The unique identifier for the field.
8072
+ # @return [Types::TaskTemplateFieldIdentifier]
8073
+ #
8074
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RequiredFieldInfo AWS API Documentation
8075
+ #
8076
+ class RequiredFieldInfo < Struct.new(
8077
+ :id)
8078
+ SENSITIVE = []
8079
+ include Aws::Structure
8080
+ end
8081
+
7413
8082
  # A resource already has that name.
7414
8083
  #
7415
8084
  # @!attribute [rw] message
@@ -7809,6 +8478,116 @@ module Aws::Connect
7809
8478
  include Aws::Structure
7810
8479
  end
7811
8480
 
8481
+ # @note When making an API call, you may pass SearchUsersRequest
8482
+ # data as a hash:
8483
+ #
8484
+ # {
8485
+ # instance_id: "InstanceId",
8486
+ # next_token: "NextToken2500",
8487
+ # max_results: 1,
8488
+ # search_filter: {
8489
+ # tag_filter: {
8490
+ # or_conditions: [
8491
+ # [
8492
+ # {
8493
+ # tag_key: "String",
8494
+ # tag_value: "String",
8495
+ # },
8496
+ # ],
8497
+ # ],
8498
+ # and_conditions: [
8499
+ # {
8500
+ # tag_key: "String",
8501
+ # tag_value: "String",
8502
+ # },
8503
+ # ],
8504
+ # tag_condition: {
8505
+ # tag_key: "String",
8506
+ # tag_value: "String",
8507
+ # },
8508
+ # },
8509
+ # },
8510
+ # search_criteria: {
8511
+ # or_conditions: [
8512
+ # {
8513
+ # # recursive UserSearchCriteria
8514
+ # },
8515
+ # ],
8516
+ # and_conditions: [
8517
+ # {
8518
+ # # recursive UserSearchCriteria
8519
+ # },
8520
+ # ],
8521
+ # string_condition: {
8522
+ # field_name: "String",
8523
+ # value: "String",
8524
+ # comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
8525
+ # },
8526
+ # hierarchy_group_condition: {
8527
+ # value: "String",
8528
+ # hierarchy_group_match_type: "EXACT", # accepts EXACT, WITH_CHILD_GROUPS
8529
+ # },
8530
+ # },
8531
+ # }
8532
+ #
8533
+ # @!attribute [rw] instance_id
8534
+ # The identifier of the Amazon Connect instance. You can find the
8535
+ # instanceId in the ARN of the instance.
8536
+ # @return [String]
8537
+ #
8538
+ # @!attribute [rw] next_token
8539
+ # The token for the next set of results. Use the value returned in the
8540
+ # previous response in the next request to retrieve the next set of
8541
+ # results.
8542
+ # @return [String]
8543
+ #
8544
+ # @!attribute [rw] max_results
8545
+ # The maximum number of results to return per page.
8546
+ # @return [Integer]
8547
+ #
8548
+ # @!attribute [rw] search_filter
8549
+ # Filters to be applied to search results.
8550
+ # @return [Types::UserSearchFilter]
8551
+ #
8552
+ # @!attribute [rw] search_criteria
8553
+ # The search criteria to be used to return users.
8554
+ # @return [Types::UserSearchCriteria]
8555
+ #
8556
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchUsersRequest AWS API Documentation
8557
+ #
8558
+ class SearchUsersRequest < Struct.new(
8559
+ :instance_id,
8560
+ :next_token,
8561
+ :max_results,
8562
+ :search_filter,
8563
+ :search_criteria)
8564
+ SENSITIVE = []
8565
+ include Aws::Structure
8566
+ end
8567
+
8568
+ # @!attribute [rw] users
8569
+ # Information about the users.
8570
+ # @return [Array<Types::UserSearchSummary>]
8571
+ #
8572
+ # @!attribute [rw] next_token
8573
+ # If there are additional results, this is the token for the next set
8574
+ # of results.
8575
+ # @return [String]
8576
+ #
8577
+ # @!attribute [rw] approximate_total_count
8578
+ # The total number of users who matched your search query.
8579
+ # @return [Integer]
8580
+ #
8581
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchUsersResponse AWS API Documentation
8582
+ #
8583
+ class SearchUsersResponse < Struct.new(
8584
+ :users,
8585
+ :next_token,
8586
+ :approximate_total_count)
8587
+ SENSITIVE = []
8588
+ include Aws::Structure
8589
+ end
8590
+
7812
8591
  # @note When making an API call, you may pass SearchVocabulariesRequest
7813
8592
  # data as a hash:
7814
8593
  #
@@ -8335,7 +9114,7 @@ module Aws::Connect
8335
9114
  # {
8336
9115
  # instance_id: "InstanceId", # required
8337
9116
  # previous_contact_id: "ContactId",
8338
- # contact_flow_id: "ContactFlowId", # required
9117
+ # contact_flow_id: "ContactFlowId",
8339
9118
  # attributes: {
8340
9119
  # "AttributeName" => "AttributeValue",
8341
9120
  # },
@@ -8343,12 +9122,14 @@ module Aws::Connect
8343
9122
  # references: {
8344
9123
  # "ReferenceKey" => {
8345
9124
  # value: "ReferenceValue", # required
8346
- # type: "URL", # required, accepts URL, ATTACHMENT
9125
+ # type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
8347
9126
  # },
8348
9127
  # },
8349
9128
  # description: "Description",
8350
9129
  # client_token: "ClientToken",
8351
9130
  # scheduled_time: Time.now,
9131
+ # task_template_id: "TaskTemplateId",
9132
+ # quick_connect_id: "QuickConnectId",
8352
9133
  # }
8353
9134
  #
8354
9135
  # @!attribute [rw] instance_id
@@ -8410,6 +9191,14 @@ module Aws::Connect
8410
9191
  # the past. It must be within up to 6 days in future.
8411
9192
  # @return [Time]
8412
9193
  #
9194
+ # @!attribute [rw] task_template_id
9195
+ # A unique identifier for the task template.
9196
+ # @return [String]
9197
+ #
9198
+ # @!attribute [rw] quick_connect_id
9199
+ # The identifier for the quick connect.
9200
+ # @return [String]
9201
+ #
8413
9202
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartTaskContactRequest AWS API Documentation
8414
9203
  #
8415
9204
  class StartTaskContactRequest < Struct.new(
@@ -8421,7 +9210,9 @@ module Aws::Connect
8421
9210
  :references,
8422
9211
  :description,
8423
9212
  :client_token,
8424
- :scheduled_time)
9213
+ :scheduled_time,
9214
+ :task_template_id,
9215
+ :quick_connect_id)
8425
9216
  SENSITIVE = []
8426
9217
  include Aws::Structure
8427
9218
  end
@@ -8543,48 +9334,131 @@ module Aws::Connect
8543
9334
  #
8544
9335
  class StopContactStreamingResponse < Aws::EmptyStructure; end
8545
9336
 
8546
- # @note When making an API call, you may pass SuspendContactRecordingRequest
9337
+ # A leaf node condition which can be used to specify a string condition,
9338
+ # for example, `username = 'abc'`.
9339
+ #
9340
+ # @note When making an API call, you may pass StringCondition
8547
9341
  # data as a hash:
8548
9342
  #
8549
9343
  # {
8550
- # instance_id: "InstanceId", # required
8551
- # contact_id: "ContactId", # required
8552
- # initial_contact_id: "ContactId", # required
9344
+ # field_name: "String",
9345
+ # value: "String",
9346
+ # comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
8553
9347
  # }
8554
9348
  #
8555
- # @!attribute [rw] instance_id
8556
- # The identifier of the Amazon Connect instance. You can find the
8557
- # instanceId in the ARN of the instance.
9349
+ # @!attribute [rw] field_name
9350
+ # The name of the field in the string condition.
8558
9351
  # @return [String]
8559
9352
  #
8560
- # @!attribute [rw] contact_id
8561
- # The identifier of the contact.
9353
+ # @!attribute [rw] value
9354
+ # The value of the string.
8562
9355
  # @return [String]
8563
9356
  #
8564
- # @!attribute [rw] initial_contact_id
8565
- # The identifier of the contact. This is the identifier of the contact
8566
- # associated with the first interaction with the contact center.
9357
+ # @!attribute [rw] comparison_type
9358
+ # The type of comparison to be made when evaluating the string
9359
+ # condition.
8567
9360
  # @return [String]
8568
9361
  #
8569
- # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SuspendContactRecordingRequest AWS API Documentation
9362
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StringCondition AWS API Documentation
8570
9363
  #
8571
- class SuspendContactRecordingRequest < Struct.new(
8572
- :instance_id,
8573
- :contact_id,
8574
- :initial_contact_id)
9364
+ class StringCondition < Struct.new(
9365
+ :field_name,
9366
+ :value,
9367
+ :comparison_type)
8575
9368
  SENSITIVE = []
8576
9369
  include Aws::Structure
8577
9370
  end
8578
9371
 
8579
- # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SuspendContactRecordingResponse AWS API Documentation
9372
+ # Information about a reference when the `referenceType` is `STRING`.
9373
+ # Otherwise, null.
8580
9374
  #
8581
- class SuspendContactRecordingResponse < Aws::EmptyStructure; end
8582
-
8583
- # @note When making an API call, you may pass TagResourceRequest
8584
- # data as a hash:
9375
+ # @!attribute [rw] name
9376
+ # Identifier of the string reference.
9377
+ # @return [String]
8585
9378
  #
8586
- # {
8587
- # resource_arn: "ARN", # required
9379
+ # @!attribute [rw] value
9380
+ # A valid string.
9381
+ # @return [String]
9382
+ #
9383
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StringReference AWS API Documentation
9384
+ #
9385
+ class StringReference < Struct.new(
9386
+ :name,
9387
+ :value)
9388
+ SENSITIVE = []
9389
+ include Aws::Structure
9390
+ end
9391
+
9392
+ # @note When making an API call, you may pass SuspendContactRecordingRequest
9393
+ # data as a hash:
9394
+ #
9395
+ # {
9396
+ # instance_id: "InstanceId", # required
9397
+ # contact_id: "ContactId", # required
9398
+ # initial_contact_id: "ContactId", # required
9399
+ # }
9400
+ #
9401
+ # @!attribute [rw] instance_id
9402
+ # The identifier of the Amazon Connect instance. You can find the
9403
+ # instanceId in the ARN of the instance.
9404
+ # @return [String]
9405
+ #
9406
+ # @!attribute [rw] contact_id
9407
+ # The identifier of the contact.
9408
+ # @return [String]
9409
+ #
9410
+ # @!attribute [rw] initial_contact_id
9411
+ # The identifier of the contact. This is the identifier of the contact
9412
+ # associated with the first interaction with the contact center.
9413
+ # @return [String]
9414
+ #
9415
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SuspendContactRecordingRequest AWS API Documentation
9416
+ #
9417
+ class SuspendContactRecordingRequest < Struct.new(
9418
+ :instance_id,
9419
+ :contact_id,
9420
+ :initial_contact_id)
9421
+ SENSITIVE = []
9422
+ include Aws::Structure
9423
+ end
9424
+
9425
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SuspendContactRecordingResponse AWS API Documentation
9426
+ #
9427
+ class SuspendContactRecordingResponse < Aws::EmptyStructure; end
9428
+
9429
+ # A leaf node condition which can be used to specify a tag condition,
9430
+ # for example, `HAVE BPO = 123`.
9431
+ #
9432
+ # @note When making an API call, you may pass TagCondition
9433
+ # data as a hash:
9434
+ #
9435
+ # {
9436
+ # tag_key: "String",
9437
+ # tag_value: "String",
9438
+ # }
9439
+ #
9440
+ # @!attribute [rw] tag_key
9441
+ # The tag key in the tag condition.
9442
+ # @return [String]
9443
+ #
9444
+ # @!attribute [rw] tag_value
9445
+ # The tag value in the tag condition.
9446
+ # @return [String]
9447
+ #
9448
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TagCondition AWS API Documentation
9449
+ #
9450
+ class TagCondition < Struct.new(
9451
+ :tag_key,
9452
+ :tag_value)
9453
+ SENSITIVE = []
9454
+ include Aws::Structure
9455
+ end
9456
+
9457
+ # @note When making an API call, you may pass TagResourceRequest
9458
+ # data as a hash:
9459
+ #
9460
+ # {
9461
+ # resource_arn: "ARN", # required
8588
9462
  # tags: { # required
8589
9463
  # "TagKey" => "TagValue",
8590
9464
  # },
@@ -8608,6 +9482,223 @@ module Aws::Connect
8608
9482
  include Aws::Structure
8609
9483
  end
8610
9484
 
9485
+ # Describes constraints that apply to the template fields.
9486
+ #
9487
+ # @note When making an API call, you may pass TaskTemplateConstraints
9488
+ # data as a hash:
9489
+ #
9490
+ # {
9491
+ # required_fields: [
9492
+ # {
9493
+ # id: {
9494
+ # name: "TaskTemplateFieldName",
9495
+ # },
9496
+ # },
9497
+ # ],
9498
+ # read_only_fields: [
9499
+ # {
9500
+ # id: {
9501
+ # name: "TaskTemplateFieldName",
9502
+ # },
9503
+ # },
9504
+ # ],
9505
+ # invisible_fields: [
9506
+ # {
9507
+ # id: {
9508
+ # name: "TaskTemplateFieldName",
9509
+ # },
9510
+ # },
9511
+ # ],
9512
+ # }
9513
+ #
9514
+ # @!attribute [rw] required_fields
9515
+ # Lists the fields that are required to be filled by agents.
9516
+ # @return [Array<Types::RequiredFieldInfo>]
9517
+ #
9518
+ # @!attribute [rw] read_only_fields
9519
+ # Lists the fields that are read-only to agents, and cannot be edited.
9520
+ # @return [Array<Types::ReadOnlyFieldInfo>]
9521
+ #
9522
+ # @!attribute [rw] invisible_fields
9523
+ # Lists the fields that are invisible to agents.
9524
+ # @return [Array<Types::InvisibleFieldInfo>]
9525
+ #
9526
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TaskTemplateConstraints AWS API Documentation
9527
+ #
9528
+ class TaskTemplateConstraints < Struct.new(
9529
+ :required_fields,
9530
+ :read_only_fields,
9531
+ :invisible_fields)
9532
+ SENSITIVE = []
9533
+ include Aws::Structure
9534
+ end
9535
+
9536
+ # Describes a default field and its corresponding value.
9537
+ #
9538
+ # @note When making an API call, you may pass TaskTemplateDefaultFieldValue
9539
+ # data as a hash:
9540
+ #
9541
+ # {
9542
+ # id: {
9543
+ # name: "TaskTemplateFieldName",
9544
+ # },
9545
+ # default_value: "TaskTemplateFieldValue",
9546
+ # }
9547
+ #
9548
+ # @!attribute [rw] id
9549
+ # Identifier of a field.
9550
+ # @return [Types::TaskTemplateFieldIdentifier]
9551
+ #
9552
+ # @!attribute [rw] default_value
9553
+ # Default value for the field.
9554
+ # @return [String]
9555
+ #
9556
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TaskTemplateDefaultFieldValue AWS API Documentation
9557
+ #
9558
+ class TaskTemplateDefaultFieldValue < Struct.new(
9559
+ :id,
9560
+ :default_value)
9561
+ SENSITIVE = []
9562
+ include Aws::Structure
9563
+ end
9564
+
9565
+ # Describes default values for fields on a template.
9566
+ #
9567
+ # @note When making an API call, you may pass TaskTemplateDefaults
9568
+ # data as a hash:
9569
+ #
9570
+ # {
9571
+ # default_field_values: [
9572
+ # {
9573
+ # id: {
9574
+ # name: "TaskTemplateFieldName",
9575
+ # },
9576
+ # default_value: "TaskTemplateFieldValue",
9577
+ # },
9578
+ # ],
9579
+ # }
9580
+ #
9581
+ # @!attribute [rw] default_field_values
9582
+ # Default value for the field.
9583
+ # @return [Array<Types::TaskTemplateDefaultFieldValue>]
9584
+ #
9585
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TaskTemplateDefaults AWS API Documentation
9586
+ #
9587
+ class TaskTemplateDefaults < Struct.new(
9588
+ :default_field_values)
9589
+ SENSITIVE = []
9590
+ include Aws::Structure
9591
+ end
9592
+
9593
+ # Describes a single task template field.
9594
+ #
9595
+ # @note When making an API call, you may pass TaskTemplateField
9596
+ # data as a hash:
9597
+ #
9598
+ # {
9599
+ # id: { # required
9600
+ # name: "TaskTemplateFieldName",
9601
+ # },
9602
+ # description: "TaskTemplateFieldDescription",
9603
+ # type: "NAME", # accepts NAME, DESCRIPTION, SCHEDULED_TIME, QUICK_CONNECT, URL, NUMBER, TEXT, TEXT_AREA, DATE_TIME, BOOLEAN, SINGLE_SELECT, EMAIL
9604
+ # single_select_options: ["TaskTemplateSingleSelectOption"],
9605
+ # }
9606
+ #
9607
+ # @!attribute [rw] id
9608
+ # The unique identifier for the field.
9609
+ # @return [Types::TaskTemplateFieldIdentifier]
9610
+ #
9611
+ # @!attribute [rw] description
9612
+ # The description of the field.
9613
+ # @return [String]
9614
+ #
9615
+ # @!attribute [rw] type
9616
+ # Indicates the type of field.
9617
+ # @return [String]
9618
+ #
9619
+ # @!attribute [rw] single_select_options
9620
+ # A list of options for a single select field.
9621
+ # @return [Array<String>]
9622
+ #
9623
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TaskTemplateField AWS API Documentation
9624
+ #
9625
+ class TaskTemplateField < Struct.new(
9626
+ :id,
9627
+ :description,
9628
+ :type,
9629
+ :single_select_options)
9630
+ SENSITIVE = []
9631
+ include Aws::Structure
9632
+ end
9633
+
9634
+ # The identifier of the task template field.
9635
+ #
9636
+ # @note When making an API call, you may pass TaskTemplateFieldIdentifier
9637
+ # data as a hash:
9638
+ #
9639
+ # {
9640
+ # name: "TaskTemplateFieldName",
9641
+ # }
9642
+ #
9643
+ # @!attribute [rw] name
9644
+ # The name of the task template field.
9645
+ # @return [String]
9646
+ #
9647
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TaskTemplateFieldIdentifier AWS API Documentation
9648
+ #
9649
+ class TaskTemplateFieldIdentifier < Struct.new(
9650
+ :name)
9651
+ SENSITIVE = []
9652
+ include Aws::Structure
9653
+ end
9654
+
9655
+ # Contains summary information about the task template.
9656
+ #
9657
+ # @!attribute [rw] id
9658
+ # A unique identifier for the task template.
9659
+ # @return [String]
9660
+ #
9661
+ # @!attribute [rw] arn
9662
+ # The Amazon Resource Name (ARN) of the task template.
9663
+ # @return [String]
9664
+ #
9665
+ # @!attribute [rw] name
9666
+ # The name of the task template.
9667
+ # @return [String]
9668
+ #
9669
+ # @!attribute [rw] description
9670
+ # The description of the task template.
9671
+ # @return [String]
9672
+ #
9673
+ # @!attribute [rw] status
9674
+ # Marks a template as `ACTIVE` or `INACTIVE` for a task to refer to
9675
+ # it. Tasks can only be created from `ACTIVE` templates. If a template
9676
+ # is marked as `INACTIVE`, then a task that refers to this template
9677
+ # cannot be created.
9678
+ # @return [String]
9679
+ #
9680
+ # @!attribute [rw] last_modified_time
9681
+ # The timestamp when the task template was last modified.
9682
+ # @return [Time]
9683
+ #
9684
+ # @!attribute [rw] created_time
9685
+ # The timestamp when the task template was created.
9686
+ # @return [Time]
9687
+ #
9688
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TaskTemplateMetadata AWS API Documentation
9689
+ #
9690
+ class TaskTemplateMetadata < Struct.new(
9691
+ :id,
9692
+ :arn,
9693
+ :name,
9694
+ :description,
9695
+ :status,
9696
+ :last_modified_time,
9697
+ :created_time)
9698
+ SENSITIVE = []
9699
+ include Aws::Structure
9700
+ end
9701
+
8611
9702
  # Contains information about the threshold for service level metrics.
8612
9703
  #
8613
9704
  # @note When making an API call, you may pass Threshold
@@ -8649,6 +9740,77 @@ module Aws::Connect
8649
9740
  include Aws::Structure
8650
9741
  end
8651
9742
 
9743
+ # @note When making an API call, you may pass TransferContactRequest
9744
+ # data as a hash:
9745
+ #
9746
+ # {
9747
+ # instance_id: "InstanceId", # required
9748
+ # contact_id: "ContactId", # required
9749
+ # queue_id: "QueueId",
9750
+ # user_id: "AgentResourceId",
9751
+ # contact_flow_id: "ContactFlowId", # required
9752
+ # client_token: "ClientToken",
9753
+ # }
9754
+ #
9755
+ # @!attribute [rw] instance_id
9756
+ # The identifier of the Amazon Connect instance. You can find the
9757
+ # instanceId in the ARN of the instance.
9758
+ # @return [String]
9759
+ #
9760
+ # @!attribute [rw] contact_id
9761
+ # The identifier of the contact in this instance of Amazon Connect
9762
+ # @return [String]
9763
+ #
9764
+ # @!attribute [rw] queue_id
9765
+ # The identifier for the queue.
9766
+ # @return [String]
9767
+ #
9768
+ # @!attribute [rw] user_id
9769
+ # The identifier for the user.
9770
+ # @return [String]
9771
+ #
9772
+ # @!attribute [rw] contact_flow_id
9773
+ # The identifier of the contact flow.
9774
+ # @return [String]
9775
+ #
9776
+ # @!attribute [rw] client_token
9777
+ # A unique, case-sensitive identifier that you provide to ensure the
9778
+ # idempotency of the request.
9779
+ #
9780
+ # **A suitable default value is auto-generated.** You should normally
9781
+ # not need to pass this option.
9782
+ # @return [String]
9783
+ #
9784
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TransferContactRequest AWS API Documentation
9785
+ #
9786
+ class TransferContactRequest < Struct.new(
9787
+ :instance_id,
9788
+ :contact_id,
9789
+ :queue_id,
9790
+ :user_id,
9791
+ :contact_flow_id,
9792
+ :client_token)
9793
+ SENSITIVE = []
9794
+ include Aws::Structure
9795
+ end
9796
+
9797
+ # @!attribute [rw] contact_id
9798
+ # The identifier of the contact in this instance of Amazon Connect
9799
+ # @return [String]
9800
+ #
9801
+ # @!attribute [rw] contact_arn
9802
+ # The Amazon Resource Name (ARN) of the contact.
9803
+ # @return [String]
9804
+ #
9805
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TransferContactResponse AWS API Documentation
9806
+ #
9807
+ class TransferContactResponse < Struct.new(
9808
+ :contact_id,
9809
+ :contact_arn)
9810
+ SENSITIVE = []
9811
+ include Aws::Structure
9812
+ end
9813
+
8652
9814
  # @note When making an API call, you may pass UntagResourceRequest
8653
9815
  # data as a hash:
8654
9816
  #
@@ -8987,7 +10149,7 @@ module Aws::Connect
8987
10149
  # references: {
8988
10150
  # "ReferenceKey" => {
8989
10151
  # value: "ReferenceValue", # required
8990
- # type: "URL", # required, accepts URL, ATTACHMENT
10152
+ # type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
8991
10153
  # },
8992
10154
  # },
8993
10155
  # }
@@ -9011,7 +10173,7 @@ module Aws::Connect
9011
10173
  # @return [String]
9012
10174
  #
9013
10175
  # @!attribute [rw] references
9014
- # A formatted URL that is shown to an agent in the Contact Control
10176
+ # Well-formed data on contact, shown to agents on Contact Control
9015
10177
  # Panel (CCP).
9016
10178
  # @return [Hash<String,Types::Reference>]
9017
10179
  #
@@ -9243,7 +10405,7 @@ module Aws::Connect
9243
10405
  # }
9244
10406
  #
9245
10407
  # @!attribute [rw] phone_number_id
9246
- # The identifier of the phone number.
10408
+ # A unique identifier for the phone number.
9247
10409
  # @return [String]
9248
10410
  #
9249
10411
  # @!attribute [rw] target_arn
@@ -9270,7 +10432,7 @@ module Aws::Connect
9270
10432
  end
9271
10433
 
9272
10434
  # @!attribute [rw] phone_number_id
9273
- # The identifier of the phone number.
10435
+ # A unique identifier for the phone number.
9274
10436
  # @return [String]
9275
10437
  #
9276
10438
  # @!attribute [rw] phone_number_arn
@@ -9731,6 +10893,192 @@ module Aws::Connect
9731
10893
  include Aws::Structure
9732
10894
  end
9733
10895
 
10896
+ # @note When making an API call, you may pass UpdateTaskTemplateRequest
10897
+ # data as a hash:
10898
+ #
10899
+ # {
10900
+ # task_template_id: "TaskTemplateId", # required
10901
+ # instance_id: "InstanceId", # required
10902
+ # name: "TaskTemplateName",
10903
+ # description: "TaskTemplateDescription",
10904
+ # contact_flow_id: "ContactFlowId",
10905
+ # constraints: {
10906
+ # required_fields: [
10907
+ # {
10908
+ # id: {
10909
+ # name: "TaskTemplateFieldName",
10910
+ # },
10911
+ # },
10912
+ # ],
10913
+ # read_only_fields: [
10914
+ # {
10915
+ # id: {
10916
+ # name: "TaskTemplateFieldName",
10917
+ # },
10918
+ # },
10919
+ # ],
10920
+ # invisible_fields: [
10921
+ # {
10922
+ # id: {
10923
+ # name: "TaskTemplateFieldName",
10924
+ # },
10925
+ # },
10926
+ # ],
10927
+ # },
10928
+ # defaults: {
10929
+ # default_field_values: [
10930
+ # {
10931
+ # id: {
10932
+ # name: "TaskTemplateFieldName",
10933
+ # },
10934
+ # default_value: "TaskTemplateFieldValue",
10935
+ # },
10936
+ # ],
10937
+ # },
10938
+ # status: "ACTIVE", # accepts ACTIVE, INACTIVE
10939
+ # fields: [
10940
+ # {
10941
+ # id: { # required
10942
+ # name: "TaskTemplateFieldName",
10943
+ # },
10944
+ # description: "TaskTemplateFieldDescription",
10945
+ # type: "NAME", # accepts NAME, DESCRIPTION, SCHEDULED_TIME, QUICK_CONNECT, URL, NUMBER, TEXT, TEXT_AREA, DATE_TIME, BOOLEAN, SINGLE_SELECT, EMAIL
10946
+ # single_select_options: ["TaskTemplateSingleSelectOption"],
10947
+ # },
10948
+ # ],
10949
+ # }
10950
+ #
10951
+ # @!attribute [rw] task_template_id
10952
+ # A unique identifier for the task template.
10953
+ # @return [String]
10954
+ #
10955
+ # @!attribute [rw] instance_id
10956
+ # The identifier of the Amazon Connect instance. You can find the
10957
+ # instanceId in the ARN of the instance.
10958
+ # @return [String]
10959
+ #
10960
+ # @!attribute [rw] name
10961
+ # The name of the task template.
10962
+ # @return [String]
10963
+ #
10964
+ # @!attribute [rw] description
10965
+ # The description of the task template.
10966
+ # @return [String]
10967
+ #
10968
+ # @!attribute [rw] contact_flow_id
10969
+ # The identifier of the flow that runs by default when a task is
10970
+ # created by referencing this template.
10971
+ # @return [String]
10972
+ #
10973
+ # @!attribute [rw] constraints
10974
+ # Constraints that are applicable to the fields listed.
10975
+ # @return [Types::TaskTemplateConstraints]
10976
+ #
10977
+ # @!attribute [rw] defaults
10978
+ # The default values for fields when a task is created by referencing
10979
+ # this template.
10980
+ # @return [Types::TaskTemplateDefaults]
10981
+ #
10982
+ # @!attribute [rw] status
10983
+ # Marks a template as `ACTIVE` or `INACTIVE` for a task to refer to
10984
+ # it. Tasks can only be created from `ACTIVE` templates. If a template
10985
+ # is marked as `INACTIVE`, then a task that refers to this template
10986
+ # cannot be created.
10987
+ # @return [String]
10988
+ #
10989
+ # @!attribute [rw] fields
10990
+ # Fields that are part of the template.
10991
+ # @return [Array<Types::TaskTemplateField>]
10992
+ #
10993
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateTaskTemplateRequest AWS API Documentation
10994
+ #
10995
+ class UpdateTaskTemplateRequest < Struct.new(
10996
+ :task_template_id,
10997
+ :instance_id,
10998
+ :name,
10999
+ :description,
11000
+ :contact_flow_id,
11001
+ :constraints,
11002
+ :defaults,
11003
+ :status,
11004
+ :fields)
11005
+ SENSITIVE = []
11006
+ include Aws::Structure
11007
+ end
11008
+
11009
+ # @!attribute [rw] instance_id
11010
+ # The identifier of the Amazon Connect instance. You can find the
11011
+ # instanceId in the ARN of the instance.
11012
+ # @return [String]
11013
+ #
11014
+ # @!attribute [rw] id
11015
+ # The identifier of the task template resource.
11016
+ # @return [String]
11017
+ #
11018
+ # @!attribute [rw] arn
11019
+ # The Amazon Resource Name (ARN) for the task template resource.
11020
+ # @return [String]
11021
+ #
11022
+ # @!attribute [rw] name
11023
+ # The name of the task template.
11024
+ # @return [String]
11025
+ #
11026
+ # @!attribute [rw] description
11027
+ # The description of the task template.
11028
+ # @return [String]
11029
+ #
11030
+ # @!attribute [rw] contact_flow_id
11031
+ # The identifier of the flow that runs by default when a task is
11032
+ # created by referencing this template.
11033
+ # @return [String]
11034
+ #
11035
+ # @!attribute [rw] constraints
11036
+ # Constraints that are applicable to the fields listed.
11037
+ # @return [Types::TaskTemplateConstraints]
11038
+ #
11039
+ # @!attribute [rw] defaults
11040
+ # The default values for fields when a task is created by referencing
11041
+ # this template.
11042
+ # @return [Types::TaskTemplateDefaults]
11043
+ #
11044
+ # @!attribute [rw] fields
11045
+ # Fields that are part of the template.
11046
+ # @return [Array<Types::TaskTemplateField>]
11047
+ #
11048
+ # @!attribute [rw] status
11049
+ # Marks a template as `ACTIVE` or `INACTIVE` for a task to refer to
11050
+ # it. Tasks can only be created from `ACTIVE` templates. If a template
11051
+ # is marked as `INACTIVE`, then a task that refers to this template
11052
+ # cannot be created.
11053
+ # @return [String]
11054
+ #
11055
+ # @!attribute [rw] last_modified_time
11056
+ # The timestamp when the task template was last modified.
11057
+ # @return [Time]
11058
+ #
11059
+ # @!attribute [rw] created_time
11060
+ # The timestamp when the task template was created.
11061
+ # @return [Time]
11062
+ #
11063
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateTaskTemplateResponse AWS API Documentation
11064
+ #
11065
+ class UpdateTaskTemplateResponse < Struct.new(
11066
+ :instance_id,
11067
+ :id,
11068
+ :arn,
11069
+ :name,
11070
+ :description,
11071
+ :contact_flow_id,
11072
+ :constraints,
11073
+ :defaults,
11074
+ :fields,
11075
+ :status,
11076
+ :last_modified_time,
11077
+ :created_time)
11078
+ SENSITIVE = []
11079
+ include Aws::Structure
11080
+ end
11081
+
9734
11082
  # @note When making an API call, you may pass UpdateUserHierarchyGroupNameRequest
9735
11083
  # data as a hash:
9736
11084
  #
@@ -10117,6 +11465,25 @@ module Aws::Connect
10117
11465
  include Aws::Structure
10118
11466
  end
10119
11467
 
11468
+ # The user's first name and last name.
11469
+ #
11470
+ # @!attribute [rw] first_name
11471
+ # The user's first name.
11472
+ # @return [String]
11473
+ #
11474
+ # @!attribute [rw] last_name
11475
+ # The user's last name.
11476
+ # @return [String]
11477
+ #
11478
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserIdentityInfoLite AWS API Documentation
11479
+ #
11480
+ class UserIdentityInfoLite < Struct.new(
11481
+ :first_name,
11482
+ :last_name)
11483
+ SENSITIVE = []
11484
+ include Aws::Structure
11485
+ end
11486
+
10120
11487
  # No user with the specified credentials was found in the Amazon Connect
10121
11488
  # instance.
10122
11489
  #
@@ -10199,6 +11566,201 @@ module Aws::Connect
10199
11566
  include Aws::Structure
10200
11567
  end
10201
11568
 
11569
+ # The search criteria to be used to return users.
11570
+ #
11571
+ # @note When making an API call, you may pass UserSearchCriteria
11572
+ # data as a hash:
11573
+ #
11574
+ # {
11575
+ # or_conditions: [
11576
+ # {
11577
+ # or_conditions: {
11578
+ # # recursive UserSearchConditionList
11579
+ # },
11580
+ # and_conditions: {
11581
+ # # recursive UserSearchConditionList
11582
+ # },
11583
+ # string_condition: {
11584
+ # field_name: "String",
11585
+ # value: "String",
11586
+ # comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
11587
+ # },
11588
+ # hierarchy_group_condition: {
11589
+ # value: "String",
11590
+ # hierarchy_group_match_type: "EXACT", # accepts EXACT, WITH_CHILD_GROUPS
11591
+ # },
11592
+ # },
11593
+ # ],
11594
+ # and_conditions: [
11595
+ # {
11596
+ # or_conditions: {
11597
+ # # recursive UserSearchConditionList
11598
+ # },
11599
+ # and_conditions: {
11600
+ # # recursive UserSearchConditionList
11601
+ # },
11602
+ # string_condition: {
11603
+ # field_name: "String",
11604
+ # value: "String",
11605
+ # comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
11606
+ # },
11607
+ # hierarchy_group_condition: {
11608
+ # value: "String",
11609
+ # hierarchy_group_match_type: "EXACT", # accepts EXACT, WITH_CHILD_GROUPS
11610
+ # },
11611
+ # },
11612
+ # ],
11613
+ # string_condition: {
11614
+ # field_name: "String",
11615
+ # value: "String",
11616
+ # comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
11617
+ # },
11618
+ # hierarchy_group_condition: {
11619
+ # value: "String",
11620
+ # hierarchy_group_match_type: "EXACT", # accepts EXACT, WITH_CHILD_GROUPS
11621
+ # },
11622
+ # }
11623
+ #
11624
+ # @!attribute [rw] or_conditions
11625
+ # A list of conditions which would be applied together with an `OR`
11626
+ # condition.
11627
+ # @return [Array<Types::UserSearchCriteria>]
11628
+ #
11629
+ # @!attribute [rw] and_conditions
11630
+ # A list of conditions which would be applied together with an `AND`
11631
+ # condition.
11632
+ # @return [Array<Types::UserSearchCriteria>]
11633
+ #
11634
+ # @!attribute [rw] string_condition
11635
+ # A leaf node condition which can be used to specify a string
11636
+ # condition.
11637
+ # @return [Types::StringCondition]
11638
+ #
11639
+ # @!attribute [rw] hierarchy_group_condition
11640
+ # A leaf node condition which can be used to specify a hierarchy group
11641
+ # condition.
11642
+ # @return [Types::HierarchyGroupCondition]
11643
+ #
11644
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserSearchCriteria AWS API Documentation
11645
+ #
11646
+ class UserSearchCriteria < Struct.new(
11647
+ :or_conditions,
11648
+ :and_conditions,
11649
+ :string_condition,
11650
+ :hierarchy_group_condition)
11651
+ SENSITIVE = []
11652
+ include Aws::Structure
11653
+ end
11654
+
11655
+ # Filters to be applied to search results.
11656
+ #
11657
+ # @note When making an API call, you may pass UserSearchFilter
11658
+ # data as a hash:
11659
+ #
11660
+ # {
11661
+ # tag_filter: {
11662
+ # or_conditions: [
11663
+ # [
11664
+ # {
11665
+ # tag_key: "String",
11666
+ # tag_value: "String",
11667
+ # },
11668
+ # ],
11669
+ # ],
11670
+ # and_conditions: [
11671
+ # {
11672
+ # tag_key: "String",
11673
+ # tag_value: "String",
11674
+ # },
11675
+ # ],
11676
+ # tag_condition: {
11677
+ # tag_key: "String",
11678
+ # tag_value: "String",
11679
+ # },
11680
+ # },
11681
+ # }
11682
+ #
11683
+ # @!attribute [rw] tag_filter
11684
+ # An object that can be used to specify Tag conditions inside the
11685
+ # `SearchFilter`. This accepts an `OR` of `AND` (List of List) input
11686
+ # where:
11687
+ #
11688
+ # * Top level list specifies conditions that need to be applied with
11689
+ # `OR` operator
11690
+ #
11691
+ # * Inner list specifies conditions that need to be applied with `AND`
11692
+ # operator.
11693
+ # @return [Types::ControlPlaneTagFilter]
11694
+ #
11695
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserSearchFilter AWS API Documentation
11696
+ #
11697
+ class UserSearchFilter < Struct.new(
11698
+ :tag_filter)
11699
+ SENSITIVE = []
11700
+ include Aws::Structure
11701
+ end
11702
+
11703
+ # Information about the returned users.
11704
+ #
11705
+ # @!attribute [rw] arn
11706
+ # The Amazon Resource Name (ARN) of the user.
11707
+ # @return [String]
11708
+ #
11709
+ # @!attribute [rw] directory_user_id
11710
+ # The directory identifier of the user.
11711
+ # @return [String]
11712
+ #
11713
+ # @!attribute [rw] hierarchy_group_id
11714
+ # The identifier of the user's hierarchy group.
11715
+ # @return [String]
11716
+ #
11717
+ # @!attribute [rw] id
11718
+ # The identifier of the user's summary.
11719
+ # @return [String]
11720
+ #
11721
+ # @!attribute [rw] identity_info
11722
+ # The user's first name and last name.
11723
+ # @return [Types::UserIdentityInfoLite]
11724
+ #
11725
+ # @!attribute [rw] phone_config
11726
+ # Contains information about the phone configuration settings for a
11727
+ # user.
11728
+ # @return [Types::UserPhoneConfig]
11729
+ #
11730
+ # @!attribute [rw] routing_profile_id
11731
+ # The identifier of the user's routing profile.
11732
+ # @return [String]
11733
+ #
11734
+ # @!attribute [rw] security_profile_ids
11735
+ # The identifiers of the user's security profiles.
11736
+ # @return [Array<String>]
11737
+ #
11738
+ # @!attribute [rw] tags
11739
+ # The tags used to organize, track, or control access for this
11740
+ # resource.
11741
+ # @return [Hash<String,String>]
11742
+ #
11743
+ # @!attribute [rw] username
11744
+ # The name of the user.
11745
+ # @return [String]
11746
+ #
11747
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserSearchSummary AWS API Documentation
11748
+ #
11749
+ class UserSearchSummary < Struct.new(
11750
+ :arn,
11751
+ :directory_user_id,
11752
+ :hierarchy_group_id,
11753
+ :id,
11754
+ :identity_info,
11755
+ :phone_config,
11756
+ :routing_profile_id,
11757
+ :security_profile_ids,
11758
+ :tags,
11759
+ :username)
11760
+ SENSITIVE = []
11761
+ include Aws::Structure
11762
+ end
11763
+
10202
11764
  # Contains summary information about a user.
10203
11765
  #
10204
11766
  # @!attribute [rw] id