aws-sdk-connect 1.71.0 → 1.72.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +521 -9
- data/lib/aws-sdk-connect/client_api.rb +315 -1
- data/lib/aws-sdk-connect/errors.rb +21 -0
- data/lib/aws-sdk-connect/types.rb +1089 -36
- data/lib/aws-sdk-connect.rb +1 -1
- metadata +2 -2
@@ -526,7 +526,7 @@ module Aws::Connect
|
|
526
526
|
include Aws::Structure
|
527
527
|
end
|
528
528
|
|
529
|
-
# Information about
|
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
|
-
#
|
537
|
+
# The location path of the attachment reference.
|
538
538
|
# @return [String]
|
539
539
|
#
|
540
540
|
# @!attribute [rw] status
|
541
|
-
# Status of
|
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
|
@@ -1889,6 +1889,140 @@ module Aws::Connect
|
|
1889
1889
|
include Aws::Structure
|
1890
1890
|
end
|
1891
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
|
+
|
1892
2026
|
# @note When making an API call, you may pass CreateUseCaseRequest
|
1893
2027
|
# data as a hash:
|
1894
2028
|
#
|
@@ -2326,6 +2460,26 @@ module Aws::Connect
|
|
2326
2460
|
include Aws::Structure
|
2327
2461
|
end
|
2328
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
|
+
|
2329
2483
|
# Contains information about a default vocabulary.
|
2330
2484
|
#
|
2331
2485
|
# @!attribute [rw] instance_id
|
@@ -2542,6 +2696,36 @@ module Aws::Connect
|
|
2542
2696
|
include Aws::Structure
|
2543
2697
|
end
|
2544
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
|
+
|
2545
2729
|
# @note When making an API call, you may pass DeleteUseCaseRequest
|
2546
2730
|
# data as a hash:
|
2547
2731
|
#
|
@@ -3634,6 +3818,26 @@ module Aws::Connect
|
|
3634
3818
|
include Aws::Structure
|
3635
3819
|
end
|
3636
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
|
+
|
3637
3841
|
# The encryption configuration.
|
3638
3842
|
#
|
3639
3843
|
# @note When making an API call, you may pass EncryptionConfig
|
@@ -4274,6 +4478,118 @@ module Aws::Connect
|
|
4274
4478
|
include Aws::Structure
|
4275
4479
|
end
|
4276
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
|
+
|
4277
4593
|
# Contains information about a hierarchy group.
|
4278
4594
|
#
|
4279
4595
|
# @!attribute [rw] id
|
@@ -5088,6 +5404,29 @@ module Aws::Connect
|
|
5088
5404
|
include Aws::Structure
|
5089
5405
|
end
|
5090
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
|
+
|
5091
5430
|
# Configuration information of a Kinesis Data Firehose delivery stream.
|
5092
5431
|
#
|
5093
5432
|
# @note When making an API call, you may pass KinesisFirehoseConfig
|
@@ -5543,7 +5882,7 @@ module Aws::Connect
|
|
5543
5882
|
# {
|
5544
5883
|
# instance_id: "InstanceId", # required
|
5545
5884
|
# contact_id: "ContactId", # required
|
5546
|
-
# reference_types: ["URL"], # required, accepts URL, ATTACHMENT
|
5885
|
+
# reference_types: ["URL"], # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
|
5547
5886
|
# next_token: "NextToken",
|
5548
5887
|
# }
|
5549
5888
|
#
|
@@ -6746,17 +7085,15 @@ module Aws::Connect
|
|
6746
7085
|
include Aws::Structure
|
6747
7086
|
end
|
6748
7087
|
|
6749
|
-
#
|
6750
|
-
# integration association.
|
6751
|
-
#
|
6752
|
-
# @note When making an API call, you may pass ListUseCasesRequest
|
7088
|
+
# @note When making an API call, you may pass ListTaskTemplatesRequest
|
6753
7089
|
# data as a hash:
|
6754
7090
|
#
|
6755
7091
|
# {
|
6756
7092
|
# instance_id: "InstanceId", # required
|
6757
|
-
# integration_association_id: "IntegrationAssociationId", # required
|
6758
7093
|
# next_token: "NextToken",
|
6759
7094
|
# max_results: 1,
|
7095
|
+
# status: "ACTIVE", # accepts ACTIVE, INACTIVE
|
7096
|
+
# name: "TaskTemplateName",
|
6760
7097
|
# }
|
6761
7098
|
#
|
6762
7099
|
# @!attribute [rw] instance_id
|
@@ -6764,50 +7101,127 @@ module Aws::Connect
|
|
6764
7101
|
# instanceId in the ARN of the instance.
|
6765
7102
|
# @return [String]
|
6766
7103
|
#
|
6767
|
-
# @!attribute [rw] integration_association_id
|
6768
|
-
# The identifier for the integration association.
|
6769
|
-
# @return [String]
|
6770
|
-
#
|
6771
7104
|
# @!attribute [rw] next_token
|
6772
7105
|
# The token for the next set of results. Use the value returned in the
|
6773
7106
|
# previous response in the next request to retrieve the next set of
|
6774
7107
|
# results.
|
7108
|
+
#
|
7109
|
+
# It is not expected that you set this because the value returned in
|
7110
|
+
# the previous response is always null.
|
6775
7111
|
# @return [String]
|
6776
7112
|
#
|
6777
7113
|
# @!attribute [rw] max_results
|
6778
7114
|
# The maximum number of results to return per page.
|
7115
|
+
#
|
7116
|
+
# It is not expected that you set this.
|
6779
7117
|
# @return [Integer]
|
6780
7118
|
#
|
6781
|
-
#
|
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]
|
6782
7125
|
#
|
6783
|
-
|
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(
|
6784
7133
|
:instance_id,
|
6785
|
-
:integration_association_id,
|
6786
7134
|
:next_token,
|
6787
|
-
:max_results
|
7135
|
+
:max_results,
|
7136
|
+
:status,
|
7137
|
+
:name)
|
6788
7138
|
SENSITIVE = []
|
6789
7139
|
include Aws::Structure
|
6790
7140
|
end
|
6791
7141
|
|
6792
|
-
# @!attribute [rw]
|
6793
|
-
#
|
6794
|
-
#
|
7142
|
+
# @!attribute [rw] task_templates
|
7143
|
+
# Provides details about a list of task templates belonging to an
|
7144
|
+
# instance.
|
7145
|
+
# @return [Array<Types::TaskTemplateMetadata>]
|
6795
7146
|
#
|
6796
7147
|
# @!attribute [rw] next_token
|
6797
7148
|
# If there are additional results, this is the token for the next set
|
6798
7149
|
# of results.
|
7150
|
+
#
|
7151
|
+
# This is always returned as a null in the response.
|
6799
7152
|
# @return [String]
|
6800
7153
|
#
|
6801
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
7154
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListTaskTemplatesResponse AWS API Documentation
|
6802
7155
|
#
|
6803
|
-
class
|
6804
|
-
:
|
7156
|
+
class ListTaskTemplatesResponse < Struct.new(
|
7157
|
+
:task_templates,
|
6805
7158
|
:next_token)
|
6806
7159
|
SENSITIVE = []
|
6807
7160
|
include Aws::Structure
|
6808
7161
|
end
|
6809
7162
|
|
6810
|
-
#
|
7163
|
+
# Provides summary information about the use cases for the specified
|
7164
|
+
# integration association.
|
7165
|
+
#
|
7166
|
+
# @note When making an API call, you may pass ListUseCasesRequest
|
7167
|
+
# data as a hash:
|
7168
|
+
#
|
7169
|
+
# {
|
7170
|
+
# instance_id: "InstanceId", # required
|
7171
|
+
# integration_association_id: "IntegrationAssociationId", # required
|
7172
|
+
# next_token: "NextToken",
|
7173
|
+
# max_results: 1,
|
7174
|
+
# }
|
7175
|
+
#
|
7176
|
+
# @!attribute [rw] instance_id
|
7177
|
+
# The identifier of the Amazon Connect instance. You can find the
|
7178
|
+
# instanceId in the ARN of the instance.
|
7179
|
+
# @return [String]
|
7180
|
+
#
|
7181
|
+
# @!attribute [rw] integration_association_id
|
7182
|
+
# The identifier for the integration association.
|
7183
|
+
# @return [String]
|
7184
|
+
#
|
7185
|
+
# @!attribute [rw] next_token
|
7186
|
+
# The token for the next set of results. Use the value returned in the
|
7187
|
+
# previous response in the next request to retrieve the next set of
|
7188
|
+
# results.
|
7189
|
+
# @return [String]
|
7190
|
+
#
|
7191
|
+
# @!attribute [rw] max_results
|
7192
|
+
# The maximum number of results to return per page.
|
7193
|
+
# @return [Integer]
|
7194
|
+
#
|
7195
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUseCasesRequest AWS API Documentation
|
7196
|
+
#
|
7197
|
+
class ListUseCasesRequest < Struct.new(
|
7198
|
+
:instance_id,
|
7199
|
+
:integration_association_id,
|
7200
|
+
:next_token,
|
7201
|
+
:max_results)
|
7202
|
+
SENSITIVE = []
|
7203
|
+
include Aws::Structure
|
7204
|
+
end
|
7205
|
+
|
7206
|
+
# @!attribute [rw] use_case_summary_list
|
7207
|
+
# The use cases.
|
7208
|
+
# @return [Array<Types::UseCase>]
|
7209
|
+
#
|
7210
|
+
# @!attribute [rw] next_token
|
7211
|
+
# If there are additional results, this is the token for the next set
|
7212
|
+
# of results.
|
7213
|
+
# @return [String]
|
7214
|
+
#
|
7215
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUseCasesResponse AWS API Documentation
|
7216
|
+
#
|
7217
|
+
class ListUseCasesResponse < Struct.new(
|
7218
|
+
:use_case_summary_list,
|
7219
|
+
:next_token)
|
7220
|
+
SENSITIVE = []
|
7221
|
+
include Aws::Structure
|
7222
|
+
end
|
7223
|
+
|
7224
|
+
# @note When making an API call, you may pass ListUserHierarchyGroupsRequest
|
6811
7225
|
# data as a hash:
|
6812
7226
|
#
|
6813
7227
|
# {
|
@@ -6947,6 +7361,26 @@ module Aws::Connect
|
|
6947
7361
|
include Aws::Structure
|
6948
7362
|
end
|
6949
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
|
+
|
6950
7384
|
# The outbound caller ID name, number, and outbound whisper flow.
|
6951
7385
|
#
|
6952
7386
|
# @note When making an API call, you may pass OutboundCallerConfig
|
@@ -7128,6 +7562,45 @@ module Aws::Connect
|
|
7128
7562
|
include Aws::Structure
|
7129
7563
|
end
|
7130
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
|
+
|
7131
7604
|
# @note When making an API call, you may pass PutUserStatusRequest
|
7132
7605
|
# data as a hash:
|
7133
7606
|
#
|
@@ -7441,15 +7914,39 @@ module Aws::Connect
|
|
7441
7914
|
include Aws::Structure
|
7442
7915
|
end
|
7443
7916
|
|
7444
|
-
#
|
7445
|
-
#
|
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.
|
7446
7943
|
#
|
7447
7944
|
# @note When making an API call, you may pass Reference
|
7448
7945
|
# data as a hash:
|
7449
7946
|
#
|
7450
7947
|
# {
|
7451
7948
|
# value: "ReferenceValue", # required
|
7452
|
-
# type: "URL", # required, accepts URL, ATTACHMENT
|
7949
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
|
7453
7950
|
# }
|
7454
7951
|
#
|
7455
7952
|
# @!attribute [rw] value
|
@@ -7459,8 +7956,7 @@ module Aws::Connect
|
|
7459
7956
|
# @return [String]
|
7460
7957
|
#
|
7461
7958
|
# @!attribute [rw] type
|
7462
|
-
# The type of the reference.
|
7463
|
-
# on a contact.
|
7959
|
+
# The type of the reference.
|
7464
7960
|
# @return [String]
|
7465
7961
|
#
|
7466
7962
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Reference AWS API Documentation
|
@@ -7479,20 +7975,44 @@ module Aws::Connect
|
|
7479
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.
|
7480
7976
|
#
|
7481
7977
|
# @!attribute [rw] url
|
7482
|
-
# Information about the
|
7978
|
+
# Information about the reference when the `referenceType` is `URL`.
|
7483
7979
|
# Otherwise, null.
|
7484
7980
|
# @return [Types::UrlReference]
|
7485
7981
|
#
|
7486
7982
|
# @!attribute [rw] attachment
|
7487
|
-
# Information about the
|
7983
|
+
# Information about the reference when the `referenceType` is
|
7488
7984
|
# `ATTACHMENT`. Otherwise, null.
|
7489
7985
|
# @return [Types::AttachmentReference]
|
7490
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
|
+
#
|
7491
8007
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ReferenceSummary AWS API Documentation
|
7492
8008
|
#
|
7493
8009
|
class ReferenceSummary < Struct.new(
|
7494
8010
|
:url,
|
7495
8011
|
:attachment,
|
8012
|
+
:string,
|
8013
|
+
:number,
|
8014
|
+
:date,
|
8015
|
+
:email,
|
7496
8016
|
:unknown)
|
7497
8017
|
SENSITIVE = []
|
7498
8018
|
include Aws::Structure
|
@@ -7500,6 +8020,10 @@ module Aws::Connect
|
|
7500
8020
|
|
7501
8021
|
class Url < ReferenceSummary; end
|
7502
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
|
7503
8027
|
class Unknown < ReferenceSummary; end
|
7504
8028
|
end
|
7505
8029
|
|
@@ -7532,6 +8056,29 @@ module Aws::Connect
|
|
7532
8056
|
include Aws::Structure
|
7533
8057
|
end
|
7534
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
|
+
|
7535
8082
|
# A resource already has that name.
|
7536
8083
|
#
|
7537
8084
|
# @!attribute [rw] message
|
@@ -8567,7 +9114,7 @@ module Aws::Connect
|
|
8567
9114
|
# {
|
8568
9115
|
# instance_id: "InstanceId", # required
|
8569
9116
|
# previous_contact_id: "ContactId",
|
8570
|
-
# contact_flow_id: "ContactFlowId",
|
9117
|
+
# contact_flow_id: "ContactFlowId",
|
8571
9118
|
# attributes: {
|
8572
9119
|
# "AttributeName" => "AttributeValue",
|
8573
9120
|
# },
|
@@ -8575,12 +9122,14 @@ module Aws::Connect
|
|
8575
9122
|
# references: {
|
8576
9123
|
# "ReferenceKey" => {
|
8577
9124
|
# value: "ReferenceValue", # required
|
8578
|
-
# type: "URL", # required, accepts URL, ATTACHMENT
|
9125
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
|
8579
9126
|
# },
|
8580
9127
|
# },
|
8581
9128
|
# description: "Description",
|
8582
9129
|
# client_token: "ClientToken",
|
8583
9130
|
# scheduled_time: Time.now,
|
9131
|
+
# task_template_id: "TaskTemplateId",
|
9132
|
+
# quick_connect_id: "QuickConnectId",
|
8584
9133
|
# }
|
8585
9134
|
#
|
8586
9135
|
# @!attribute [rw] instance_id
|
@@ -8642,6 +9191,14 @@ module Aws::Connect
|
|
8642
9191
|
# the past. It must be within up to 6 days in future.
|
8643
9192
|
# @return [Time]
|
8644
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
|
+
#
|
8645
9202
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartTaskContactRequest AWS API Documentation
|
8646
9203
|
#
|
8647
9204
|
class StartTaskContactRequest < Struct.new(
|
@@ -8653,7 +9210,9 @@ module Aws::Connect
|
|
8653
9210
|
:references,
|
8654
9211
|
:description,
|
8655
9212
|
:client_token,
|
8656
|
-
:scheduled_time
|
9213
|
+
:scheduled_time,
|
9214
|
+
:task_template_id,
|
9215
|
+
:quick_connect_id)
|
8657
9216
|
SENSITIVE = []
|
8658
9217
|
include Aws::Structure
|
8659
9218
|
end
|
@@ -8810,6 +9369,26 @@ module Aws::Connect
|
|
8810
9369
|
include Aws::Structure
|
8811
9370
|
end
|
8812
9371
|
|
9372
|
+
# Information about a reference when the `referenceType` is `STRING`.
|
9373
|
+
# Otherwise, null.
|
9374
|
+
#
|
9375
|
+
# @!attribute [rw] name
|
9376
|
+
# Identifier of the string reference.
|
9377
|
+
# @return [String]
|
9378
|
+
#
|
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
|
+
|
8813
9392
|
# @note When making an API call, you may pass SuspendContactRecordingRequest
|
8814
9393
|
# data as a hash:
|
8815
9394
|
#
|
@@ -8903,6 +9482,223 @@ module Aws::Connect
|
|
8903
9482
|
include Aws::Structure
|
8904
9483
|
end
|
8905
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
|
+
|
8906
9702
|
# Contains information about the threshold for service level metrics.
|
8907
9703
|
#
|
8908
9704
|
# @note When making an API call, you may pass Threshold
|
@@ -8944,6 +9740,77 @@ module Aws::Connect
|
|
8944
9740
|
include Aws::Structure
|
8945
9741
|
end
|
8946
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
|
+
|
8947
9814
|
# @note When making an API call, you may pass UntagResourceRequest
|
8948
9815
|
# data as a hash:
|
8949
9816
|
#
|
@@ -9282,7 +10149,7 @@ module Aws::Connect
|
|
9282
10149
|
# references: {
|
9283
10150
|
# "ReferenceKey" => {
|
9284
10151
|
# value: "ReferenceValue", # required
|
9285
|
-
# type: "URL", # required, accepts URL, ATTACHMENT
|
10152
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
|
9286
10153
|
# },
|
9287
10154
|
# },
|
9288
10155
|
# }
|
@@ -9306,7 +10173,7 @@ module Aws::Connect
|
|
9306
10173
|
# @return [String]
|
9307
10174
|
#
|
9308
10175
|
# @!attribute [rw] references
|
9309
|
-
#
|
10176
|
+
# Well-formed data on contact, shown to agents on Contact Control
|
9310
10177
|
# Panel (CCP).
|
9311
10178
|
# @return [Hash<String,Types::Reference>]
|
9312
10179
|
#
|
@@ -10026,6 +10893,192 @@ module Aws::Connect
|
|
10026
10893
|
include Aws::Structure
|
10027
10894
|
end
|
10028
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
|
+
|
10029
11082
|
# @note When making an API call, you may pass UpdateUserHierarchyGroupNameRequest
|
10030
11083
|
# data as a hash:
|
10031
11084
|
#
|