aws-sdk-connectcases 1.50.0 → 1.52.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -485,12 +485,12 @@ module Aws::ConnectCases
485
485
  #
486
486
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html
487
487
  #
488
- # @option params [required, Array<Types::CaseRuleIdentifier>] :case_rules
489
- # List of case rule identifiers.
490
- #
491
488
  # @option params [required, String] :domain_id
492
489
  # Unique identifier of a Cases domain.
493
490
  #
491
+ # @option params [required, Array<Types::CaseRuleIdentifier>] :case_rules
492
+ # List of case rule identifiers.
493
+ #
494
494
  # @return [Types::BatchGetCaseRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
495
495
  #
496
496
  # * {Types::BatchGetCaseRuleResponse#case_rules #case_rules} => Array&lt;Types::GetCaseRuleResponse&gt;
@@ -499,41 +499,41 @@ module Aws::ConnectCases
499
499
  # @example Request syntax with placeholder values
500
500
  #
501
501
  # resp = client.batch_get_case_rule({
502
+ # domain_id: "DomainId", # required
502
503
  # case_rules: [ # required
503
504
  # {
504
505
  # id: "CaseRuleId", # required
505
506
  # },
506
507
  # ],
507
- # domain_id: "DomainId", # required
508
508
  # })
509
509
  #
510
510
  # @example Response structure
511
511
  #
512
512
  # resp.case_rules #=> Array
513
- # resp.case_rules[0].case_rule_arn #=> String
514
513
  # resp.case_rules[0].case_rule_id #=> String
515
- # resp.case_rules[0].created_time #=> Time
516
- # resp.case_rules[0].deleted #=> Boolean
517
- # resp.case_rules[0].description #=> String
518
- # resp.case_rules[0].last_modified_time #=> Time
519
514
  # resp.case_rules[0].name #=> String
515
+ # resp.case_rules[0].case_rule_arn #=> String
516
+ # resp.case_rules[0].rule.required.default_value #=> Boolean
520
517
  # resp.case_rules[0].rule.required.conditions #=> Array
521
518
  # resp.case_rules[0].rule.required.conditions[0].equal_to.operand_one.field_id #=> String
519
+ # resp.case_rules[0].rule.required.conditions[0].equal_to.operand_two.string_value #=> String
522
520
  # resp.case_rules[0].rule.required.conditions[0].equal_to.operand_two.boolean_value #=> Boolean
523
521
  # resp.case_rules[0].rule.required.conditions[0].equal_to.operand_two.double_value #=> Float
524
- # resp.case_rules[0].rule.required.conditions[0].equal_to.operand_two.string_value #=> String
525
522
  # resp.case_rules[0].rule.required.conditions[0].equal_to.result #=> Boolean
526
523
  # resp.case_rules[0].rule.required.conditions[0].not_equal_to.operand_one.field_id #=> String
524
+ # resp.case_rules[0].rule.required.conditions[0].not_equal_to.operand_two.string_value #=> String
527
525
  # resp.case_rules[0].rule.required.conditions[0].not_equal_to.operand_two.boolean_value #=> Boolean
528
526
  # resp.case_rules[0].rule.required.conditions[0].not_equal_to.operand_two.double_value #=> Float
529
- # resp.case_rules[0].rule.required.conditions[0].not_equal_to.operand_two.string_value #=> String
530
527
  # resp.case_rules[0].rule.required.conditions[0].not_equal_to.result #=> Boolean
531
- # resp.case_rules[0].rule.required.default_value #=> Boolean
528
+ # resp.case_rules[0].description #=> String
529
+ # resp.case_rules[0].deleted #=> Boolean
530
+ # resp.case_rules[0].created_time #=> Time
531
+ # resp.case_rules[0].last_modified_time #=> Time
532
532
  # resp.case_rules[0].tags #=> Hash
533
533
  # resp.case_rules[0].tags["String"] #=> String
534
534
  # resp.errors #=> Array
535
- # resp.errors[0].error_code #=> String
536
535
  # resp.errors[0].id #=> String
536
+ # resp.errors[0].error_code #=> String
537
537
  # resp.errors[0].message #=> String
538
538
  #
539
539
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/BatchGetCaseRule AWS API Documentation
@@ -556,8 +556,8 @@ module Aws::ConnectCases
556
556
  #
557
557
  # @return [Types::BatchGetFieldResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
558
558
  #
559
- # * {Types::BatchGetFieldResponse#errors #errors} => Array&lt;Types::FieldError&gt;
560
559
  # * {Types::BatchGetFieldResponse#fields #fields} => Array&lt;Types::GetFieldResponse&gt;
560
+ # * {Types::BatchGetFieldResponse#errors #errors} => Array&lt;Types::FieldError&gt;
561
561
  #
562
562
  # @example Request syntax with placeholder values
563
563
  #
@@ -572,22 +572,22 @@ module Aws::ConnectCases
572
572
  #
573
573
  # @example Response structure
574
574
  #
575
- # resp.errors #=> Array
576
- # resp.errors[0].error_code #=> String
577
- # resp.errors[0].id #=> String
578
- # resp.errors[0].message #=> String
579
575
  # resp.fields #=> Array
580
- # resp.fields[0].created_time #=> Time
581
- # resp.fields[0].deleted #=> Boolean
582
- # resp.fields[0].description #=> String
583
- # resp.fields[0].field_arn #=> String
584
576
  # resp.fields[0].field_id #=> String
585
- # resp.fields[0].last_modified_time #=> Time
586
577
  # resp.fields[0].name #=> String
578
+ # resp.fields[0].field_arn #=> String
579
+ # resp.fields[0].description #=> String
580
+ # resp.fields[0].type #=> String, one of "Text", "Number", "Boolean", "DateTime", "SingleSelect", "Url", "User"
587
581
  # resp.fields[0].namespace #=> String, one of "System", "Custom"
588
582
  # resp.fields[0].tags #=> Hash
589
583
  # resp.fields[0].tags["String"] #=> String
590
- # resp.fields[0].type #=> String, one of "Text", "Number", "Boolean", "DateTime", "SingleSelect", "Url", "User"
584
+ # resp.fields[0].deleted #=> Boolean
585
+ # resp.fields[0].created_time #=> Time
586
+ # resp.fields[0].last_modified_time #=> Time
587
+ # resp.errors #=> Array
588
+ # resp.errors[0].id #=> String
589
+ # resp.errors[0].error_code #=> String
590
+ # resp.errors[0].message #=> String
591
591
  #
592
592
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/BatchGetField AWS API Documentation
593
593
  #
@@ -621,9 +621,9 @@ module Aws::ConnectCases
621
621
  # field_id: "FieldId", # required
622
622
  # options: [ # required
623
623
  # {
624
- # active: false, # required
625
624
  # name: "FieldOptionName", # required
626
625
  # value: "FieldOptionValue", # required
626
+ # active: false, # required
627
627
  # },
628
628
  # ],
629
629
  # })
@@ -631,8 +631,8 @@ module Aws::ConnectCases
631
631
  # @example Response structure
632
632
  #
633
633
  # resp.errors #=> Array
634
- # resp.errors[0].error_code #=> String
635
634
  # resp.errors[0].message #=> String
635
+ # resp.errors[0].error_code #=> String
636
636
  # resp.errors[0].value #=> String
637
637
  #
638
638
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/BatchPutFieldOptions AWS API Documentation
@@ -667,6 +667,16 @@ module Aws::ConnectCases
667
667
  #
668
668
  # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html
669
669
  #
670
+ # @option params [required, String] :domain_id
671
+ # The unique identifier of the Cases domain.
672
+ #
673
+ # @option params [required, String] :template_id
674
+ # A unique identifier of a template.
675
+ #
676
+ # @option params [required, Array<Types::FieldValue>] :fields
677
+ # An array of objects with field ID (matching ListFields/DescribeField)
678
+ # and value union data.
679
+ #
670
680
  # @option params [String] :client_token
671
681
  # A unique, case-sensitive identifier that you provide to ensure the
672
682
  # idempotency of the request. If not provided, the Amazon Web Services
@@ -680,53 +690,43 @@ module Aws::ConnectCases
680
690
  #
681
691
  # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
682
692
  #
683
- # @option params [required, String] :domain_id
684
- # The unique identifier of the Cases domain.
685
- #
686
- # @option params [required, Array<Types::FieldValue>] :fields
687
- # An array of objects with field ID (matching ListFields/DescribeField)
688
- # and value union data.
689
- #
690
693
  # @option params [Types::UserUnion] :performed_by
691
694
  # Represents the entity that performed the action.
692
695
  #
693
- # @option params [required, String] :template_id
694
- # A unique identifier of a template.
695
- #
696
696
  # @return [Types::CreateCaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
697
697
  #
698
- # * {Types::CreateCaseResponse#case_arn #case_arn} => String
699
698
  # * {Types::CreateCaseResponse#case_id #case_id} => String
699
+ # * {Types::CreateCaseResponse#case_arn #case_arn} => String
700
700
  #
701
701
  # @example Request syntax with placeholder values
702
702
  #
703
703
  # resp = client.create_case({
704
- # client_token: "CreateCaseRequestClientTokenString",
705
704
  # domain_id: "DomainId", # required
705
+ # template_id: "TemplateId", # required
706
706
  # fields: [ # required
707
707
  # {
708
708
  # id: "FieldId", # required
709
709
  # value: { # required
710
- # boolean_value: false,
710
+ # string_value: "FieldValueUnionStringValueString",
711
711
  # double_value: 1.0,
712
+ # boolean_value: false,
712
713
  # empty_value: {
713
714
  # },
714
- # string_value: "FieldValueUnionStringValueString",
715
715
  # user_arn_value: "String",
716
716
  # },
717
717
  # },
718
718
  # ],
719
+ # client_token: "CreateCaseRequestClientTokenString",
719
720
  # performed_by: {
720
- # custom_entity: "CustomEntity",
721
721
  # user_arn: "UserArn",
722
+ # custom_entity: "CustomEntity",
722
723
  # },
723
- # template_id: "TemplateId", # required
724
724
  # })
725
725
  #
726
726
  # @example Response structure
727
727
  #
728
- # resp.case_arn #=> String
729
728
  # resp.case_id #=> String
729
+ # resp.case_arn #=> String
730
730
  #
731
731
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CreateCase AWS API Documentation
732
732
  #
@@ -746,31 +746,32 @@ module Aws::ConnectCases
746
746
  #
747
747
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html
748
748
  #
749
- # @option params [String] :description
750
- # The description of a case rule.
751
- #
752
749
  # @option params [required, String] :domain_id
753
750
  # Unique identifier of a Cases domain.
754
751
  #
755
752
  # @option params [required, String] :name
756
753
  # Name of the case rule.
757
754
  #
755
+ # @option params [String] :description
756
+ # The description of a case rule.
757
+ #
758
758
  # @option params [required, Types::CaseRuleDetails] :rule
759
759
  # Represents what rule type should take place, under what conditions.
760
760
  #
761
761
  # @return [Types::CreateCaseRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
762
762
  #
763
- # * {Types::CreateCaseRuleResponse#case_rule_arn #case_rule_arn} => String
764
763
  # * {Types::CreateCaseRuleResponse#case_rule_id #case_rule_id} => String
764
+ # * {Types::CreateCaseRuleResponse#case_rule_arn #case_rule_arn} => String
765
765
  #
766
766
  # @example Request syntax with placeholder values
767
767
  #
768
768
  # resp = client.create_case_rule({
769
- # description: "CaseRuleDescription",
770
769
  # domain_id: "DomainId", # required
771
770
  # name: "CaseRuleName", # required
771
+ # description: "CaseRuleDescription",
772
772
  # rule: { # required
773
773
  # required: {
774
+ # default_value: false, # required
774
775
  # conditions: [ # required
775
776
  # {
776
777
  # equal_to: {
@@ -778,11 +779,11 @@ module Aws::ConnectCases
778
779
  # field_id: "FieldId",
779
780
  # },
780
781
  # operand_two: { # required
782
+ # string_value: "OperandTwoStringValueString",
781
783
  # boolean_value: false,
782
784
  # double_value: 1.0,
783
785
  # empty_value: {
784
786
  # },
785
- # string_value: "OperandTwoStringValueString",
786
787
  # },
787
788
  # result: false, # required
788
789
  # },
@@ -791,25 +792,24 @@ module Aws::ConnectCases
791
792
  # field_id: "FieldId",
792
793
  # },
793
794
  # operand_two: { # required
795
+ # string_value: "OperandTwoStringValueString",
794
796
  # boolean_value: false,
795
797
  # double_value: 1.0,
796
798
  # empty_value: {
797
799
  # },
798
- # string_value: "OperandTwoStringValueString",
799
800
  # },
800
801
  # result: false, # required
801
802
  # },
802
803
  # },
803
804
  # ],
804
- # default_value: false, # required
805
805
  # },
806
806
  # },
807
807
  # })
808
808
  #
809
809
  # @example Response structure
810
810
  #
811
- # resp.case_rule_arn #=> String
812
811
  # resp.case_rule_id #=> String
812
+ # resp.case_rule_arn #=> String
813
813
  #
814
814
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CreateCaseRule AWS API Documentation
815
815
  #
@@ -840,8 +840,8 @@ module Aws::ConnectCases
840
840
  #
841
841
  # @return [Types::CreateDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
842
842
  #
843
- # * {Types::CreateDomainResponse#domain_arn #domain_arn} => String
844
843
  # * {Types::CreateDomainResponse#domain_id #domain_id} => String
844
+ # * {Types::CreateDomainResponse#domain_arn #domain_arn} => String
845
845
  # * {Types::CreateDomainResponse#domain_status #domain_status} => String
846
846
  #
847
847
  # @example Request syntax with placeholder values
@@ -852,8 +852,8 @@ module Aws::ConnectCases
852
852
  #
853
853
  # @example Response structure
854
854
  #
855
- # resp.domain_arn #=> String
856
855
  # resp.domain_id #=> String
856
+ # resp.domain_arn #=> String
857
857
  # resp.domain_status #=> String, one of "Active", "CreationInProgress", "CreationFailed"
858
858
  #
859
859
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CreateDomain AWS API Documentation
@@ -869,9 +869,6 @@ module Aws::ConnectCases
869
869
  # case object model (that is, defines what data can be captured on
870
870
  # cases) in a Cases domain.
871
871
  #
872
- # @option params [String] :description
873
- # The description of the field.
874
- #
875
872
  # @option params [required, String] :domain_id
876
873
  # The unique identifier of the Cases domain.
877
874
  #
@@ -882,24 +879,27 @@ module Aws::ConnectCases
882
879
  # Defines the data type, some system constraints, and default display of
883
880
  # the field.
884
881
  #
882
+ # @option params [String] :description
883
+ # The description of the field.
884
+ #
885
885
  # @return [Types::CreateFieldResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
886
886
  #
887
- # * {Types::CreateFieldResponse#field_arn #field_arn} => String
888
887
  # * {Types::CreateFieldResponse#field_id #field_id} => String
888
+ # * {Types::CreateFieldResponse#field_arn #field_arn} => String
889
889
  #
890
890
  # @example Request syntax with placeholder values
891
891
  #
892
892
  # resp = client.create_field({
893
- # description: "FieldDescription",
894
893
  # domain_id: "DomainId", # required
895
894
  # name: "FieldName", # required
896
895
  # type: "Text", # required, accepts Text, Number, Boolean, DateTime, SingleSelect, Url, User
896
+ # description: "FieldDescription",
897
897
  # })
898
898
  #
899
899
  # @example Response structure
900
900
  #
901
- # resp.field_arn #=> String
902
901
  # resp.field_id #=> String
902
+ # resp.field_arn #=> String
903
903
  #
904
904
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CreateField AWS API Documentation
905
905
  #
@@ -923,64 +923,64 @@ module Aws::ConnectCases
923
923
  #
924
924
  # </note>
925
925
  #
926
- # @option params [required, Types::LayoutContent] :content
927
- # Information about which fields will be present in the layout, and
928
- # information about the order of the fields.
929
- #
930
926
  # @option params [required, String] :domain_id
931
927
  # The unique identifier of the Cases domain.
932
928
  #
933
929
  # @option params [required, String] :name
934
930
  # The name of the layout. It must be unique for the Cases domain.
935
931
  #
932
+ # @option params [required, Types::LayoutContent] :content
933
+ # Information about which fields will be present in the layout, and
934
+ # information about the order of the fields.
935
+ #
936
936
  # @return [Types::CreateLayoutResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
937
937
  #
938
- # * {Types::CreateLayoutResponse#layout_arn #layout_arn} => String
939
938
  # * {Types::CreateLayoutResponse#layout_id #layout_id} => String
939
+ # * {Types::CreateLayoutResponse#layout_arn #layout_arn} => String
940
940
  #
941
941
  # @example Request syntax with placeholder values
942
942
  #
943
943
  # resp = client.create_layout({
944
+ # domain_id: "DomainId", # required
945
+ # name: "LayoutName", # required
944
946
  # content: { # required
945
947
  # basic: {
946
- # more_info: {
948
+ # top_panel: {
947
949
  # sections: [
948
950
  # {
949
951
  # field_group: {
952
+ # name: "FieldGroupNameString",
950
953
  # fields: [ # required
951
954
  # {
952
955
  # id: "FieldId", # required
953
956
  # },
954
957
  # ],
955
- # name: "FieldGroupNameString",
956
958
  # },
957
959
  # },
958
960
  # ],
959
961
  # },
960
- # top_panel: {
962
+ # more_info: {
961
963
  # sections: [
962
964
  # {
963
965
  # field_group: {
966
+ # name: "FieldGroupNameString",
964
967
  # fields: [ # required
965
968
  # {
966
969
  # id: "FieldId", # required
967
970
  # },
968
971
  # ],
969
- # name: "FieldGroupNameString",
970
972
  # },
971
973
  # },
972
974
  # ],
973
975
  # },
974
976
  # },
975
977
  # },
976
- # domain_id: "DomainId", # required
977
- # name: "LayoutName", # required
978
978
  # })
979
979
  #
980
980
  # @example Response structure
981
981
  #
982
- # resp.layout_arn #=> String
983
982
  # resp.layout_id #=> String
983
+ # resp.layout_arn #=> String
984
984
  #
985
985
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CreateLayout AWS API Documentation
986
986
  #
@@ -1012,72 +1012,90 @@ module Aws::ConnectCases
1012
1012
  #
1013
1013
  # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html
1014
1014
  #
1015
+ # @option params [required, String] :domain_id
1016
+ # The unique identifier of the Cases domain.
1017
+ #
1015
1018
  # @option params [required, String] :case_id
1016
1019
  # A unique identifier of the case.
1017
1020
  #
1021
+ # @option params [required, String] :type
1022
+ # The type of a related item.
1023
+ #
1018
1024
  # @option params [required, Types::RelatedItemInputContent] :content
1019
1025
  # The content of a related item to be created.
1020
1026
  #
1021
- # @option params [required, String] :domain_id
1022
- # The unique identifier of the Cases domain.
1023
- #
1024
1027
  # @option params [Types::UserUnion] :performed_by
1025
1028
  # Represents the creator of the related item.
1026
1029
  #
1027
- # @option params [required, String] :type
1028
- # The type of a related item.
1029
- #
1030
1030
  # @return [Types::CreateRelatedItemResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1031
1031
  #
1032
- # * {Types::CreateRelatedItemResponse#related_item_arn #related_item_arn} => String
1033
1032
  # * {Types::CreateRelatedItemResponse#related_item_id #related_item_id} => String
1033
+ # * {Types::CreateRelatedItemResponse#related_item_arn #related_item_arn} => String
1034
1034
  #
1035
1035
  # @example Request syntax with placeholder values
1036
1036
  #
1037
1037
  # resp = client.create_related_item({
1038
+ # domain_id: "DomainId", # required
1038
1039
  # case_id: "CaseId", # required
1040
+ # type: "Contact", # required, accepts Contact, Comment, File, Sla, ConnectCase, Custom
1039
1041
  # content: { # required
1042
+ # contact: {
1043
+ # contact_arn: "ContactArn", # required
1044
+ # },
1040
1045
  # comment: {
1041
1046
  # body: "CommentBody", # required
1042
1047
  # content_type: "Text/Plain", # required, accepts Text/Plain
1043
1048
  # },
1044
- # contact: {
1045
- # contact_arn: "ContactArn", # required
1046
- # },
1047
1049
  # file: {
1048
1050
  # file_arn: "FileArn", # required
1049
1051
  # },
1050
1052
  # sla: {
1051
1053
  # sla_input_configuration: {
1052
- # field_id: "FieldId",
1053
1054
  # name: "SlaName", # required
1055
+ # type: "CaseField", # required, accepts CaseField
1056
+ # field_id: "FieldId",
1054
1057
  # target_field_values: [
1055
1058
  # {
1056
- # boolean_value: false,
1059
+ # string_value: "FieldValueUnionStringValueString",
1057
1060
  # double_value: 1.0,
1061
+ # boolean_value: false,
1058
1062
  # empty_value: {
1059
1063
  # },
1060
- # string_value: "FieldValueUnionStringValueString",
1061
1064
  # user_arn_value: "String",
1062
1065
  # },
1063
1066
  # ],
1064
1067
  # target_sla_minutes: 1, # required
1065
- # type: "CaseField", # required, accepts CaseField
1066
1068
  # },
1067
1069
  # },
1070
+ # connect_case: {
1071
+ # case_id: "CaseId", # required
1072
+ # },
1073
+ # custom: {
1074
+ # fields: [ # required
1075
+ # {
1076
+ # id: "FieldId", # required
1077
+ # value: { # required
1078
+ # string_value: "FieldValueUnionStringValueString",
1079
+ # double_value: 1.0,
1080
+ # boolean_value: false,
1081
+ # empty_value: {
1082
+ # },
1083
+ # user_arn_value: "String",
1084
+ # },
1085
+ # },
1086
+ # ],
1087
+ # },
1068
1088
  # },
1069
- # domain_id: "DomainId", # required
1070
1089
  # performed_by: {
1071
- # custom_entity: "CustomEntity",
1072
1090
  # user_arn: "UserArn",
1091
+ # custom_entity: "CustomEntity",
1073
1092
  # },
1074
- # type: "Contact", # required, accepts Contact, Comment, File, Sla
1075
1093
  # })
1076
1094
  #
1077
1095
  # @example Response structure
1078
1096
  #
1079
- # resp.related_item_arn #=> String
1080
1097
  # resp.related_item_id #=> String
1098
+ # resp.related_item_arn #=> String
1081
1099
  #
1082
1100
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CreateRelatedItem AWS API Documentation
1083
1101
  #
@@ -1114,22 +1132,25 @@ module Aws::ConnectCases
1114
1132
  # [3]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_ListTemplates.html
1115
1133
  # [4]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_UpdateTemplate.html
1116
1134
  #
1117
- # @option params [String] :description
1118
- # A brief description of the template.
1119
- #
1120
1135
  # @option params [required, String] :domain_id
1121
1136
  # The unique identifier of the Cases domain.
1122
1137
  #
1123
- # @option params [Types::LayoutConfiguration] :layout_configuration
1124
- # Configuration of layouts associated to the template.
1125
- #
1126
1138
  # @option params [required, String] :name
1127
1139
  # A name for the template. It must be unique per domain.
1128
1140
  #
1141
+ # @option params [String] :description
1142
+ # A brief description of the template.
1143
+ #
1144
+ # @option params [Types::LayoutConfiguration] :layout_configuration
1145
+ # Configuration of layouts associated to the template.
1146
+ #
1129
1147
  # @option params [Array<Types::RequiredField>] :required_fields
1130
1148
  # A list of fields that must contain a value for a case to be
1131
1149
  # successfully created with this template.
1132
1150
  #
1151
+ # @option params [String] :status
1152
+ # The status of the template.
1153
+ #
1133
1154
  # @option params [Array<Types::TemplateRule>] :rules
1134
1155
  # A list of case rules (also known as [case field conditions][1]) on a
1135
1156
  # template.
@@ -1138,41 +1159,38 @@ module Aws::ConnectCases
1138
1159
  #
1139
1160
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html
1140
1161
  #
1141
- # @option params [String] :status
1142
- # The status of the template.
1143
- #
1144
1162
  # @return [Types::CreateTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1145
1163
  #
1146
- # * {Types::CreateTemplateResponse#template_arn #template_arn} => String
1147
1164
  # * {Types::CreateTemplateResponse#template_id #template_id} => String
1165
+ # * {Types::CreateTemplateResponse#template_arn #template_arn} => String
1148
1166
  #
1149
1167
  # @example Request syntax with placeholder values
1150
1168
  #
1151
1169
  # resp = client.create_template({
1152
- # description: "TemplateDescription",
1153
1170
  # domain_id: "DomainId", # required
1171
+ # name: "TemplateName", # required
1172
+ # description: "TemplateDescription",
1154
1173
  # layout_configuration: {
1155
1174
  # default_layout: "LayoutId",
1156
1175
  # },
1157
- # name: "TemplateName", # required
1158
1176
  # required_fields: [
1159
1177
  # {
1160
1178
  # field_id: "FieldId", # required
1161
1179
  # },
1162
1180
  # ],
1181
+ # status: "Active", # accepts Active, Inactive
1163
1182
  # rules: [
1164
1183
  # {
1165
1184
  # case_rule_id: "CaseRuleId", # required
1166
1185
  # field_id: "FieldId", # required
1167
1186
  # },
1168
1187
  # ],
1169
- # status: "Active", # accepts Active, Inactive
1170
1188
  # })
1171
1189
  #
1172
1190
  # @example Response structure
1173
1191
  #
1174
- # resp.template_arn #=> String
1175
1192
  # resp.template_id #=> String
1193
+ # resp.template_arn #=> String
1176
1194
  #
1177
1195
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CreateTemplate AWS API Documentation
1178
1196
  #
@@ -1193,22 +1211,22 @@ module Aws::ConnectCases
1193
1211
  #
1194
1212
  # * Perform any operations that require the CaseID
1195
1213
  #
1196
- # This action is irreversible. Once you delete a case, you cannot
1214
+ # This action is irreversible. After you delete a case, you cannot
1197
1215
  # recover its data.
1198
1216
  #
1199
- # @option params [required, String] :case_id
1200
- # A unique identifier of the case.
1201
- #
1202
1217
  # @option params [required, String] :domain_id
1203
1218
  # A unique identifier of the Cases domain.
1204
1219
  #
1220
+ # @option params [required, String] :case_id
1221
+ # A unique identifier of the case.
1222
+ #
1205
1223
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1206
1224
  #
1207
1225
  # @example Request syntax with placeholder values
1208
1226
  #
1209
1227
  # resp = client.delete_case({
1210
- # case_id: "CaseId", # required
1211
1228
  # domain_id: "DomainId", # required
1229
+ # case_id: "CaseId", # required
1212
1230
  # })
1213
1231
  #
1214
1232
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/DeleteCase AWS API Documentation
@@ -1229,19 +1247,19 @@ module Aws::ConnectCases
1229
1247
  #
1230
1248
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html
1231
1249
  #
1232
- # @option params [required, String] :case_rule_id
1233
- # Unique identifier of a case rule.
1234
- #
1235
1250
  # @option params [required, String] :domain_id
1236
1251
  # Unique identifier of a Cases domain.
1237
1252
  #
1253
+ # @option params [required, String] :case_rule_id
1254
+ # Unique identifier of a case rule.
1255
+ #
1238
1256
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1239
1257
  #
1240
1258
  # @example Request syntax with placeholder values
1241
1259
  #
1242
1260
  # resp = client.delete_case_rule({
1243
- # case_rule_id: "CaseRuleId", # required
1244
1261
  # domain_id: "DomainId", # required
1262
+ # case_rule_id: "CaseRuleId", # required
1245
1263
  # })
1246
1264
  #
1247
1265
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/DeleteCaseRule AWS API Documentation
@@ -1398,12 +1416,12 @@ module Aws::ConnectCases
1398
1416
  #
1399
1417
  # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteAttachedFile.html
1400
1418
  #
1401
- # @option params [required, String] :case_id
1402
- # A unique identifier of the case.
1403
- #
1404
1419
  # @option params [required, String] :domain_id
1405
1420
  # A unique identifier of the Cases domain.
1406
1421
  #
1422
+ # @option params [required, String] :case_id
1423
+ # A unique identifier of the case.
1424
+ #
1407
1425
  # @option params [required, String] :related_item_id
1408
1426
  # A unique identifier of a related item.
1409
1427
  #
@@ -1412,8 +1430,8 @@ module Aws::ConnectCases
1412
1430
  # @example Request syntax with placeholder values
1413
1431
  #
1414
1432
  # resp = client.delete_related_item({
1415
- # case_id: "CaseId", # required
1416
1433
  # domain_id: "DomainId", # required
1434
+ # case_id: "CaseId", # required
1417
1435
  # related_item_id: "RelatedItemId", # required
1418
1436
  # })
1419
1437
  #
@@ -1482,9 +1500,9 @@ module Aws::ConnectCases
1482
1500
  # @return [Types::GetCaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1483
1501
  #
1484
1502
  # * {Types::GetCaseResponse#fields #fields} => Array&lt;Types::FieldValue&gt;
1503
+ # * {Types::GetCaseResponse#template_id #template_id} => String
1485
1504
  # * {Types::GetCaseResponse#next_token #next_token} => String
1486
1505
  # * {Types::GetCaseResponse#tags #tags} => Hash&lt;String,String&gt;
1487
- # * {Types::GetCaseResponse#template_id #template_id} => String
1488
1506
  #
1489
1507
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1490
1508
  #
@@ -1505,14 +1523,14 @@ module Aws::ConnectCases
1505
1523
  #
1506
1524
  # resp.fields #=> Array
1507
1525
  # resp.fields[0].id #=> String
1508
- # resp.fields[0].value.boolean_value #=> Boolean
1509
- # resp.fields[0].value.double_value #=> Float
1510
1526
  # resp.fields[0].value.string_value #=> String
1527
+ # resp.fields[0].value.double_value #=> Float
1528
+ # resp.fields[0].value.boolean_value #=> Boolean
1511
1529
  # resp.fields[0].value.user_arn_value #=> String
1530
+ # resp.template_id #=> String
1512
1531
  # resp.next_token #=> String
1513
1532
  # resp.tags #=> Hash
1514
1533
  # resp.tags["String"] #=> String
1515
- # resp.template_id #=> String
1516
1534
  #
1517
1535
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/GetCase AWS API Documentation
1518
1536
  #
@@ -1532,9 +1550,8 @@ module Aws::ConnectCases
1532
1550
  # The unique identifier of the Cases domain.
1533
1551
  #
1534
1552
  # @option params [Integer] :max_results
1535
- # The maximum number of audit events to return. The current maximum
1536
- # supported value is 25. This is also the default when no other value is
1537
- # provided.
1553
+ # The maximum number of audit events to return. When no value is
1554
+ # provided, 25 is the default.
1538
1555
  #
1539
1556
  # @option params [String] :next_token
1540
1557
  # The token for the next set of results. Use the value returned in the
@@ -1543,8 +1560,8 @@ module Aws::ConnectCases
1543
1560
  #
1544
1561
  # @return [Types::GetCaseAuditEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1545
1562
  #
1546
- # * {Types::GetCaseAuditEventsResponse#audit_events #audit_events} => Array&lt;Types::AuditEvent&gt;
1547
1563
  # * {Types::GetCaseAuditEventsResponse#next_token #next_token} => String
1564
+ # * {Types::GetCaseAuditEventsResponse#audit_events #audit_events} => Array&lt;Types::AuditEvent&gt;
1548
1565
  #
1549
1566
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1550
1567
  #
@@ -1559,25 +1576,25 @@ module Aws::ConnectCases
1559
1576
  #
1560
1577
  # @example Response structure
1561
1578
  #
1579
+ # resp.next_token #=> String
1562
1580
  # resp.audit_events #=> Array
1563
1581
  # resp.audit_events[0].event_id #=> String
1582
+ # resp.audit_events[0].type #=> String, one of "Case.Created", "Case.Updated", "RelatedItem.Created"
1583
+ # resp.audit_events[0].related_item_type #=> String, one of "Contact", "Comment", "File", "Sla", "ConnectCase", "Custom"
1584
+ # resp.audit_events[0].performed_time #=> Time
1564
1585
  # resp.audit_events[0].fields #=> Array
1565
1586
  # resp.audit_events[0].fields[0].event_field_id #=> String
1566
- # resp.audit_events[0].fields[0].new_value.boolean_value #=> Boolean
1567
- # resp.audit_events[0].fields[0].new_value.double_value #=> Float
1568
- # resp.audit_events[0].fields[0].new_value.string_value #=> String
1569
- # resp.audit_events[0].fields[0].new_value.user_arn_value #=> String
1570
- # resp.audit_events[0].fields[0].old_value.boolean_value #=> Boolean
1571
- # resp.audit_events[0].fields[0].old_value.double_value #=> Float
1572
1587
  # resp.audit_events[0].fields[0].old_value.string_value #=> String
1588
+ # resp.audit_events[0].fields[0].old_value.double_value #=> Float
1589
+ # resp.audit_events[0].fields[0].old_value.boolean_value #=> Boolean
1573
1590
  # resp.audit_events[0].fields[0].old_value.user_arn_value #=> String
1574
- # resp.audit_events[0].performed_by.iam_principal_arn #=> String
1575
- # resp.audit_events[0].performed_by.user.custom_entity #=> String
1591
+ # resp.audit_events[0].fields[0].new_value.string_value #=> String
1592
+ # resp.audit_events[0].fields[0].new_value.double_value #=> Float
1593
+ # resp.audit_events[0].fields[0].new_value.boolean_value #=> Boolean
1594
+ # resp.audit_events[0].fields[0].new_value.user_arn_value #=> String
1576
1595
  # resp.audit_events[0].performed_by.user.user_arn #=> String
1577
- # resp.audit_events[0].performed_time #=> Time
1578
- # resp.audit_events[0].related_item_type #=> String, one of "Contact", "Comment", "File", "Sla"
1579
- # resp.audit_events[0].type #=> String, one of "Case.Created", "Case.Updated", "RelatedItem.Created"
1580
- # resp.next_token #=> String
1596
+ # resp.audit_events[0].performed_by.user.custom_entity #=> String
1597
+ # resp.audit_events[0].performed_by.iam_principal_arn #=> String
1581
1598
  #
1582
1599
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/GetCaseAuditEvents AWS API Documentation
1583
1600
  #
@@ -1626,11 +1643,11 @@ module Aws::ConnectCases
1626
1643
  #
1627
1644
  # @return [Types::GetDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1628
1645
  #
1629
- # * {Types::GetDomainResponse#created_time #created_time} => Time
1630
- # * {Types::GetDomainResponse#domain_arn #domain_arn} => String
1631
1646
  # * {Types::GetDomainResponse#domain_id #domain_id} => String
1632
- # * {Types::GetDomainResponse#domain_status #domain_status} => String
1647
+ # * {Types::GetDomainResponse#domain_arn #domain_arn} => String
1633
1648
  # * {Types::GetDomainResponse#name #name} => String
1649
+ # * {Types::GetDomainResponse#created_time #created_time} => Time
1650
+ # * {Types::GetDomainResponse#domain_status #domain_status} => String
1634
1651
  # * {Types::GetDomainResponse#tags #tags} => Hash&lt;String,String&gt;
1635
1652
  #
1636
1653
  # @example Request syntax with placeholder values
@@ -1641,11 +1658,11 @@ module Aws::ConnectCases
1641
1658
  #
1642
1659
  # @example Response structure
1643
1660
  #
1644
- # resp.created_time #=> Time
1645
- # resp.domain_arn #=> String
1646
1661
  # resp.domain_id #=> String
1647
- # resp.domain_status #=> String, one of "Active", "CreationInProgress", "CreationFailed"
1662
+ # resp.domain_arn #=> String
1648
1663
  # resp.name #=> String
1664
+ # resp.created_time #=> Time
1665
+ # resp.domain_status #=> String, one of "Active", "CreationInProgress", "CreationFailed"
1649
1666
  # resp.tags #=> Hash
1650
1667
  # resp.tags["String"] #=> String
1651
1668
  #
@@ -1668,14 +1685,14 @@ module Aws::ConnectCases
1668
1685
  #
1669
1686
  # @return [Types::GetLayoutResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1670
1687
  #
1671
- # * {Types::GetLayoutResponse#content #content} => Types::LayoutContent
1672
- # * {Types::GetLayoutResponse#created_time #created_time} => Time
1673
- # * {Types::GetLayoutResponse#deleted #deleted} => Boolean
1674
- # * {Types::GetLayoutResponse#last_modified_time #last_modified_time} => Time
1675
- # * {Types::GetLayoutResponse#layout_arn #layout_arn} => String
1676
1688
  # * {Types::GetLayoutResponse#layout_id #layout_id} => String
1689
+ # * {Types::GetLayoutResponse#layout_arn #layout_arn} => String
1677
1690
  # * {Types::GetLayoutResponse#name #name} => String
1691
+ # * {Types::GetLayoutResponse#content #content} => Types::LayoutContent
1678
1692
  # * {Types::GetLayoutResponse#tags #tags} => Hash&lt;String,String&gt;
1693
+ # * {Types::GetLayoutResponse#deleted #deleted} => Boolean
1694
+ # * {Types::GetLayoutResponse#created_time #created_time} => Time
1695
+ # * {Types::GetLayoutResponse#last_modified_time #last_modified_time} => Time
1679
1696
  #
1680
1697
  # @example Request syntax with placeholder values
1681
1698
  #
@@ -1686,22 +1703,22 @@ module Aws::ConnectCases
1686
1703
  #
1687
1704
  # @example Response structure
1688
1705
  #
1689
- # resp.content.basic.more_info.sections #=> Array
1690
- # resp.content.basic.more_info.sections[0].field_group.fields #=> Array
1691
- # resp.content.basic.more_info.sections[0].field_group.fields[0].id #=> String
1692
- # resp.content.basic.more_info.sections[0].field_group.name #=> String
1706
+ # resp.layout_id #=> String
1707
+ # resp.layout_arn #=> String
1708
+ # resp.name #=> String
1693
1709
  # resp.content.basic.top_panel.sections #=> Array
1710
+ # resp.content.basic.top_panel.sections[0].field_group.name #=> String
1694
1711
  # resp.content.basic.top_panel.sections[0].field_group.fields #=> Array
1695
1712
  # resp.content.basic.top_panel.sections[0].field_group.fields[0].id #=> String
1696
- # resp.content.basic.top_panel.sections[0].field_group.name #=> String
1697
- # resp.created_time #=> Time
1698
- # resp.deleted #=> Boolean
1699
- # resp.last_modified_time #=> Time
1700
- # resp.layout_arn #=> String
1701
- # resp.layout_id #=> String
1702
- # resp.name #=> String
1713
+ # resp.content.basic.more_info.sections #=> Array
1714
+ # resp.content.basic.more_info.sections[0].field_group.name #=> String
1715
+ # resp.content.basic.more_info.sections[0].field_group.fields #=> Array
1716
+ # resp.content.basic.more_info.sections[0].field_group.fields[0].id #=> String
1703
1717
  # resp.tags #=> Hash
1704
1718
  # resp.tags["String"] #=> String
1719
+ # resp.deleted #=> Boolean
1720
+ # resp.created_time #=> Time
1721
+ # resp.last_modified_time #=> Time
1705
1722
  #
1706
1723
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/GetLayout AWS API Documentation
1707
1724
  #
@@ -1738,18 +1755,18 @@ module Aws::ConnectCases
1738
1755
  #
1739
1756
  # @return [Types::GetTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1740
1757
  #
1741
- # * {Types::GetTemplateResponse#created_time #created_time} => Time
1742
- # * {Types::GetTemplateResponse#deleted #deleted} => Boolean
1758
+ # * {Types::GetTemplateResponse#template_id #template_id} => String
1759
+ # * {Types::GetTemplateResponse#template_arn #template_arn} => String
1760
+ # * {Types::GetTemplateResponse#name #name} => String
1743
1761
  # * {Types::GetTemplateResponse#description #description} => String
1744
- # * {Types::GetTemplateResponse#last_modified_time #last_modified_time} => Time
1745
1762
  # * {Types::GetTemplateResponse#layout_configuration #layout_configuration} => Types::LayoutConfiguration
1746
- # * {Types::GetTemplateResponse#name #name} => String
1747
1763
  # * {Types::GetTemplateResponse#required_fields #required_fields} => Array&lt;Types::RequiredField&gt;
1748
- # * {Types::GetTemplateResponse#rules #rules} => Array&lt;Types::TemplateRule&gt;
1749
- # * {Types::GetTemplateResponse#status #status} => String
1750
1764
  # * {Types::GetTemplateResponse#tags #tags} => Hash&lt;String,String&gt;
1751
- # * {Types::GetTemplateResponse#template_arn #template_arn} => String
1752
- # * {Types::GetTemplateResponse#template_id #template_id} => String
1765
+ # * {Types::GetTemplateResponse#status #status} => String
1766
+ # * {Types::GetTemplateResponse#deleted #deleted} => Boolean
1767
+ # * {Types::GetTemplateResponse#created_time #created_time} => Time
1768
+ # * {Types::GetTemplateResponse#last_modified_time #last_modified_time} => Time
1769
+ # * {Types::GetTemplateResponse#rules #rules} => Array&lt;Types::TemplateRule&gt;
1753
1770
  #
1754
1771
  # @example Request syntax with placeholder values
1755
1772
  #
@@ -1760,22 +1777,22 @@ module Aws::ConnectCases
1760
1777
  #
1761
1778
  # @example Response structure
1762
1779
  #
1763
- # resp.created_time #=> Time
1764
- # resp.deleted #=> Boolean
1780
+ # resp.template_id #=> String
1781
+ # resp.template_arn #=> String
1782
+ # resp.name #=> String
1765
1783
  # resp.description #=> String
1766
- # resp.last_modified_time #=> Time
1767
1784
  # resp.layout_configuration.default_layout #=> String
1768
- # resp.name #=> String
1769
1785
  # resp.required_fields #=> Array
1770
1786
  # resp.required_fields[0].field_id #=> String
1787
+ # resp.tags #=> Hash
1788
+ # resp.tags["String"] #=> String
1789
+ # resp.status #=> String, one of "Active", "Inactive"
1790
+ # resp.deleted #=> Boolean
1791
+ # resp.created_time #=> Time
1792
+ # resp.last_modified_time #=> Time
1771
1793
  # resp.rules #=> Array
1772
1794
  # resp.rules[0].case_rule_id #=> String
1773
1795
  # resp.rules[0].field_id #=> String
1774
- # resp.status #=> String, one of "Active", "Inactive"
1775
- # resp.tags #=> Hash
1776
- # resp.tags["String"] #=> String
1777
- # resp.template_arn #=> String
1778
- # resp.template_id #=> String
1779
1796
  #
1780
1797
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/GetTemplate AWS API Documentation
1781
1798
  #
@@ -1824,11 +1841,11 @@ module Aws::ConnectCases
1824
1841
  # @example Response structure
1825
1842
  #
1826
1843
  # resp.case_rules #=> Array
1827
- # resp.case_rules[0].case_rule_arn #=> String
1828
1844
  # resp.case_rules[0].case_rule_id #=> String
1829
- # resp.case_rules[0].description #=> String
1830
1845
  # resp.case_rules[0].name #=> String
1846
+ # resp.case_rules[0].case_rule_arn #=> String
1831
1847
  # resp.case_rules[0].rule_type #=> String, one of "Required"
1848
+ # resp.case_rules[0].description #=> String
1832
1849
  # resp.next_token #=> String
1833
1850
  #
1834
1851
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ListCaseRules AWS API Documentation
@@ -1842,12 +1859,12 @@ module Aws::ConnectCases
1842
1859
 
1843
1860
  # Lists cases for a given contact.
1844
1861
  #
1845
- # @option params [required, String] :contact_arn
1846
- # A unique identifier of a contact in Amazon Connect.
1847
- #
1848
1862
  # @option params [required, String] :domain_id
1849
1863
  # The unique identifier of the Cases domain.
1850
1864
  #
1865
+ # @option params [required, String] :contact_arn
1866
+ # A unique identifier of a contact in Amazon Connect.
1867
+ #
1851
1868
  # @option params [Integer] :max_results
1852
1869
  # The maximum number of results to return per page.
1853
1870
  #
@@ -1866,8 +1883,8 @@ module Aws::ConnectCases
1866
1883
  # @example Request syntax with placeholder values
1867
1884
  #
1868
1885
  # resp = client.list_cases_for_contact({
1869
- # contact_arn: "ContactArn", # required
1870
1886
  # domain_id: "DomainId", # required
1887
+ # contact_arn: "ContactArn", # required
1871
1888
  # max_results: 1,
1872
1889
  # next_token: "NextToken",
1873
1890
  # })
@@ -1916,8 +1933,8 @@ module Aws::ConnectCases
1916
1933
  # @example Response structure
1917
1934
  #
1918
1935
  # resp.domains #=> Array
1919
- # resp.domains[0].domain_arn #=> String
1920
1936
  # resp.domains[0].domain_id #=> String
1937
+ # resp.domains[0].domain_arn #=> String
1921
1938
  # resp.domains[0].name #=> String
1922
1939
  # resp.next_token #=> String
1923
1940
  #
@@ -1951,8 +1968,8 @@ module Aws::ConnectCases
1951
1968
  #
1952
1969
  # @return [Types::ListFieldOptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1953
1970
  #
1954
- # * {Types::ListFieldOptionsResponse#next_token #next_token} => String
1955
1971
  # * {Types::ListFieldOptionsResponse#options #options} => Array&lt;Types::FieldOption&gt;
1972
+ # * {Types::ListFieldOptionsResponse#next_token #next_token} => String
1956
1973
  #
1957
1974
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1958
1975
  #
@@ -1968,11 +1985,11 @@ module Aws::ConnectCases
1968
1985
  #
1969
1986
  # @example Response structure
1970
1987
  #
1971
- # resp.next_token #=> String
1972
1988
  # resp.options #=> Array
1973
- # resp.options[0].active #=> Boolean
1974
1989
  # resp.options[0].name #=> String
1975
1990
  # resp.options[0].value #=> String
1991
+ # resp.options[0].active #=> Boolean
1992
+ # resp.next_token #=> String
1976
1993
  #
1977
1994
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ListFieldOptions AWS API Documentation
1978
1995
  #
@@ -2014,11 +2031,11 @@ module Aws::ConnectCases
2014
2031
  # @example Response structure
2015
2032
  #
2016
2033
  # resp.fields #=> Array
2017
- # resp.fields[0].field_arn #=> String
2018
2034
  # resp.fields[0].field_id #=> String
2035
+ # resp.fields[0].field_arn #=> String
2019
2036
  # resp.fields[0].name #=> String
2020
- # resp.fields[0].namespace #=> String, one of "System", "Custom"
2021
2037
  # resp.fields[0].type #=> String, one of "Text", "Number", "Boolean", "DateTime", "SingleSelect", "Url", "User"
2038
+ # resp.fields[0].namespace #=> String, one of "System", "Custom"
2022
2039
  # resp.next_token #=> String
2023
2040
  #
2024
2041
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ListFields AWS API Documentation
@@ -2062,8 +2079,8 @@ module Aws::ConnectCases
2062
2079
  # @example Response structure
2063
2080
  #
2064
2081
  # resp.layouts #=> Array
2065
- # resp.layouts[0].layout_arn #=> String
2066
2082
  # resp.layouts[0].layout_id #=> String
2083
+ # resp.layouts[0].layout_arn #=> String
2067
2084
  # resp.layouts[0].name #=> String
2068
2085
  # resp.next_token #=> String
2069
2086
  #
@@ -2141,8 +2158,8 @@ module Aws::ConnectCases
2141
2158
  #
2142
2159
  # @return [Types::ListTemplatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2143
2160
  #
2144
- # * {Types::ListTemplatesResponse#next_token #next_token} => String
2145
2161
  # * {Types::ListTemplatesResponse#templates #templates} => Array&lt;Types::TemplateSummary&gt;
2162
+ # * {Types::ListTemplatesResponse#next_token #next_token} => String
2146
2163
  #
2147
2164
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2148
2165
  #
@@ -2157,12 +2174,12 @@ module Aws::ConnectCases
2157
2174
  #
2158
2175
  # @example Response structure
2159
2176
  #
2160
- # resp.next_token #=> String
2161
2177
  # resp.templates #=> Array
2178
+ # resp.templates[0].template_id #=> String
2179
+ # resp.templates[0].template_arn #=> String
2162
2180
  # resp.templates[0].name #=> String
2163
2181
  # resp.templates[0].status #=> String, one of "Active", "Inactive"
2164
- # resp.templates[0].template_arn #=> String
2165
- # resp.templates[0].template_id #=> String
2182
+ # resp.next_token #=> String
2166
2183
  #
2167
2184
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ListTemplates AWS API Documentation
2168
2185
  #
@@ -2220,6 +2237,237 @@ module Aws::ConnectCases
2220
2237
  req.send_request(options)
2221
2238
  end
2222
2239
 
2240
+ # Searches for related items across all cases within a domain. This is a
2241
+ # global search operation that returns related items from multiple
2242
+ # cases, unlike the case-specific [SearchRelatedItems][1] API.
2243
+ #
2244
+ # **Use cases**
2245
+ #
2246
+ # Following are common uses cases for this API:
2247
+ #
2248
+ # * Find cases with similar issues across the domain. For example,
2249
+ # search for all cases containing comments about "product defect" to
2250
+ # identify patterns and existing solutions.
2251
+ #
2252
+ # * Locate all cases associated with specific contacts or orders. For
2253
+ # example, find all cases linked to a contactArn to understand the
2254
+ # complete customer journey.
2255
+ #
2256
+ # * Monitor SLA compliance across cases. For example, search for all
2257
+ # cases with "Active" SLA status to prioritize remediation efforts.
2258
+ #
2259
+ # **Important things to know**
2260
+ #
2261
+ # * This API returns case IDs, not complete case objects. To retrieve
2262
+ # full case details, you must make additional calls to the
2263
+ # [GetCase][2] API for each returned case ID.
2264
+ #
2265
+ # * This API searches across related items content, not case fields. Use
2266
+ # the [SearchCases][3] API to search within case field values.
2267
+ #
2268
+ # **Endpoints**: See [Amazon Connect endpoints and quotas][4].
2269
+ #
2270
+ #
2271
+ #
2272
+ # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_SearchRelatedItems.html
2273
+ # [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetCase.html
2274
+ # [3]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_SearchCases.html
2275
+ # [4]: https://docs.aws.amazon.com/general/latest/gr/connect_region.html
2276
+ #
2277
+ # @option params [required, String] :domain_id
2278
+ # The unique identifier of the Cases domain.
2279
+ #
2280
+ # @option params [Integer] :max_results
2281
+ # The maximum number of results to return per page.
2282
+ #
2283
+ # @option params [String] :next_token
2284
+ # The token for the next set of results. Use the value returned in the
2285
+ # previous response in the next request to retrieve the next set of
2286
+ # results.
2287
+ #
2288
+ # @option params [Array<Types::RelatedItemTypeFilter>] :filters
2289
+ # The list of types of related items and their parameters to use for
2290
+ # filtering. The filters work as an OR condition: caller gets back
2291
+ # related items that match any of the specified filter types.
2292
+ #
2293
+ # @option params [Array<Types::SearchAllRelatedItemsSort>] :sorts
2294
+ # A structured set of sort terms to specify the order in which related
2295
+ # items should be returned. Supports sorting by association time or case
2296
+ # ID. The sorts work in the order specified: first sort term takes
2297
+ # precedence over subsequent terms.
2298
+ #
2299
+ # @return [Types::SearchAllRelatedItemsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2300
+ #
2301
+ # * {Types::SearchAllRelatedItemsResponse#next_token #next_token} => String
2302
+ # * {Types::SearchAllRelatedItemsResponse#related_items #related_items} => Array&lt;Types::SearchAllRelatedItemsResponseItem&gt;
2303
+ #
2304
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2305
+ #
2306
+ # @example Request syntax with placeholder values
2307
+ #
2308
+ # resp = client.search_all_related_items({
2309
+ # domain_id: "DomainId", # required
2310
+ # max_results: 1,
2311
+ # next_token: "NextToken",
2312
+ # filters: [
2313
+ # {
2314
+ # contact: {
2315
+ # channel: ["Channel"],
2316
+ # contact_arn: "ContactArn",
2317
+ # },
2318
+ # comment: {
2319
+ # },
2320
+ # file: {
2321
+ # file_arn: "FileArn",
2322
+ # },
2323
+ # sla: {
2324
+ # name: "SlaName",
2325
+ # status: "Active", # accepts Active, Overdue, Met, NotMet
2326
+ # },
2327
+ # connect_case: {
2328
+ # case_id: "CaseId",
2329
+ # },
2330
+ # custom: {
2331
+ # fields: {
2332
+ # field: {
2333
+ # equal_to: {
2334
+ # id: "FieldId", # required
2335
+ # value: { # required
2336
+ # string_value: "FieldValueUnionStringValueString",
2337
+ # double_value: 1.0,
2338
+ # boolean_value: false,
2339
+ # empty_value: {
2340
+ # },
2341
+ # user_arn_value: "String",
2342
+ # },
2343
+ # },
2344
+ # contains: {
2345
+ # id: "FieldId", # required
2346
+ # value: { # required
2347
+ # string_value: "FieldValueUnionStringValueString",
2348
+ # double_value: 1.0,
2349
+ # boolean_value: false,
2350
+ # empty_value: {
2351
+ # },
2352
+ # user_arn_value: "String",
2353
+ # },
2354
+ # },
2355
+ # greater_than: {
2356
+ # id: "FieldId", # required
2357
+ # value: { # required
2358
+ # string_value: "FieldValueUnionStringValueString",
2359
+ # double_value: 1.0,
2360
+ # boolean_value: false,
2361
+ # empty_value: {
2362
+ # },
2363
+ # user_arn_value: "String",
2364
+ # },
2365
+ # },
2366
+ # greater_than_or_equal_to: {
2367
+ # id: "FieldId", # required
2368
+ # value: { # required
2369
+ # string_value: "FieldValueUnionStringValueString",
2370
+ # double_value: 1.0,
2371
+ # boolean_value: false,
2372
+ # empty_value: {
2373
+ # },
2374
+ # user_arn_value: "String",
2375
+ # },
2376
+ # },
2377
+ # less_than: {
2378
+ # id: "FieldId", # required
2379
+ # value: { # required
2380
+ # string_value: "FieldValueUnionStringValueString",
2381
+ # double_value: 1.0,
2382
+ # boolean_value: false,
2383
+ # empty_value: {
2384
+ # },
2385
+ # user_arn_value: "String",
2386
+ # },
2387
+ # },
2388
+ # less_than_or_equal_to: {
2389
+ # id: "FieldId", # required
2390
+ # value: { # required
2391
+ # string_value: "FieldValueUnionStringValueString",
2392
+ # double_value: 1.0,
2393
+ # boolean_value: false,
2394
+ # empty_value: {
2395
+ # },
2396
+ # user_arn_value: "String",
2397
+ # },
2398
+ # },
2399
+ # },
2400
+ # not: {
2401
+ # # recursive CustomFieldsFilter
2402
+ # },
2403
+ # and_all: [
2404
+ # {
2405
+ # # recursive CustomFieldsFilter
2406
+ # },
2407
+ # ],
2408
+ # or_all: [
2409
+ # {
2410
+ # # recursive CustomFieldsFilter
2411
+ # },
2412
+ # ],
2413
+ # },
2414
+ # },
2415
+ # },
2416
+ # ],
2417
+ # sorts: [
2418
+ # {
2419
+ # sort_property: "AssociationTime", # required, accepts AssociationTime, CaseId
2420
+ # sort_order: "Asc", # required, accepts Asc, Desc
2421
+ # },
2422
+ # ],
2423
+ # })
2424
+ #
2425
+ # @example Response structure
2426
+ #
2427
+ # resp.next_token #=> String
2428
+ # resp.related_items #=> Array
2429
+ # resp.related_items[0].related_item_id #=> String
2430
+ # resp.related_items[0].case_id #=> String
2431
+ # resp.related_items[0].type #=> String, one of "Contact", "Comment", "File", "Sla", "ConnectCase", "Custom"
2432
+ # resp.related_items[0].association_time #=> Time
2433
+ # resp.related_items[0].content.contact.contact_arn #=> String
2434
+ # resp.related_items[0].content.contact.channel #=> String
2435
+ # resp.related_items[0].content.contact.connected_to_system_time #=> Time
2436
+ # resp.related_items[0].content.comment.body #=> String
2437
+ # resp.related_items[0].content.comment.content_type #=> String, one of "Text/Plain"
2438
+ # resp.related_items[0].content.file.file_arn #=> String
2439
+ # resp.related_items[0].content.sla.sla_configuration.name #=> String
2440
+ # resp.related_items[0].content.sla.sla_configuration.type #=> String, one of "CaseField"
2441
+ # resp.related_items[0].content.sla.sla_configuration.status #=> String, one of "Active", "Overdue", "Met", "NotMet"
2442
+ # resp.related_items[0].content.sla.sla_configuration.field_id #=> String
2443
+ # resp.related_items[0].content.sla.sla_configuration.target_field_values #=> Array
2444
+ # resp.related_items[0].content.sla.sla_configuration.target_field_values[0].string_value #=> String
2445
+ # resp.related_items[0].content.sla.sla_configuration.target_field_values[0].double_value #=> Float
2446
+ # resp.related_items[0].content.sla.sla_configuration.target_field_values[0].boolean_value #=> Boolean
2447
+ # resp.related_items[0].content.sla.sla_configuration.target_field_values[0].user_arn_value #=> String
2448
+ # resp.related_items[0].content.sla.sla_configuration.target_time #=> Time
2449
+ # resp.related_items[0].content.sla.sla_configuration.completion_time #=> Time
2450
+ # resp.related_items[0].content.connect_case.case_id #=> String
2451
+ # resp.related_items[0].content.custom.fields #=> Array
2452
+ # resp.related_items[0].content.custom.fields[0].id #=> String
2453
+ # resp.related_items[0].content.custom.fields[0].value.string_value #=> String
2454
+ # resp.related_items[0].content.custom.fields[0].value.double_value #=> Float
2455
+ # resp.related_items[0].content.custom.fields[0].value.boolean_value #=> Boolean
2456
+ # resp.related_items[0].content.custom.fields[0].value.user_arn_value #=> String
2457
+ # resp.related_items[0].performed_by.user_arn #=> String
2458
+ # resp.related_items[0].performed_by.custom_entity #=> String
2459
+ # resp.related_items[0].tags #=> Hash
2460
+ # resp.related_items[0].tags["String"] #=> String
2461
+ #
2462
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/SearchAllRelatedItems AWS API Documentation
2463
+ #
2464
+ # @overload search_all_related_items(params = {})
2465
+ # @param [Hash] params ({})
2466
+ def search_all_related_items(params = {}, options = {})
2467
+ req = build_request(:search_all_related_items, params)
2468
+ req.send_request(options)
2469
+ end
2470
+
2223
2471
  # Searches for cases within their associated Cases domain. Search
2224
2472
  # results are returned as a paginated list of abridged case documents.
2225
2473
  #
@@ -2232,16 +2480,9 @@ module Aws::ConnectCases
2232
2480
  # @option params [required, String] :domain_id
2233
2481
  # The unique identifier of the Cases domain.
2234
2482
  #
2235
- # @option params [Array<Types::FieldIdentifier>] :fields
2236
- # The list of field identifiers to be returned as part of the response.
2237
- #
2238
- # @option params [Types::CaseFilter] :filter
2239
- # A list of filter objects.
2240
- #
2241
2483
  # @option params [Integer] :max_results
2242
- # The maximum number of cases to return. The current maximum supported
2243
- # value is 25. This is also the default value when no other value is
2244
- # provided.
2484
+ # The maximum number of cases to return. When no value is provided, 25
2485
+ # is the default.
2245
2486
  #
2246
2487
  # @option params [String] :next_token
2247
2488
  # The token for the next set of results. Use the value returned in the
@@ -2251,14 +2492,20 @@ module Aws::ConnectCases
2251
2492
  # @option params [String] :search_term
2252
2493
  # A word or phrase used to perform a quick search.
2253
2494
  #
2495
+ # @option params [Types::CaseFilter] :filter
2496
+ # A list of filter objects.
2497
+ #
2254
2498
  # @option params [Array<Types::Sort>] :sorts
2255
2499
  # A list of sorts where each sort specifies a field and their sort order
2256
2500
  # to be applied to the results.
2257
2501
  #
2502
+ # @option params [Array<Types::FieldIdentifier>] :fields
2503
+ # The list of field identifiers to be returned as part of the response.
2504
+ #
2258
2505
  # @return [Types::SearchCasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2259
2506
  #
2260
- # * {Types::SearchCasesResponse#cases #cases} => Array&lt;Types::SearchCasesResponseItem&gt;
2261
2507
  # * {Types::SearchCasesResponse#next_token #next_token} => String
2508
+ # * {Types::SearchCasesResponse#cases #cases} => Array&lt;Types::SearchCasesResponseItem&gt;
2262
2509
  #
2263
2510
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2264
2511
  #
@@ -2266,81 +2513,74 @@ module Aws::ConnectCases
2266
2513
  #
2267
2514
  # resp = client.search_cases({
2268
2515
  # domain_id: "DomainId", # required
2269
- # fields: [
2270
- # {
2271
- # id: "FieldId", # required
2272
- # },
2273
- # ],
2516
+ # max_results: 1,
2517
+ # next_token: "NextToken",
2518
+ # search_term: "SearchCasesRequestSearchTermString",
2274
2519
  # filter: {
2275
- # and_all: [
2276
- # {
2277
- # # recursive CaseFilter
2278
- # },
2279
- # ],
2280
2520
  # field: {
2281
- # contains: {
2521
+ # equal_to: {
2282
2522
  # id: "FieldId", # required
2283
2523
  # value: { # required
2284
- # boolean_value: false,
2524
+ # string_value: "FieldValueUnionStringValueString",
2285
2525
  # double_value: 1.0,
2526
+ # boolean_value: false,
2286
2527
  # empty_value: {
2287
2528
  # },
2288
- # string_value: "FieldValueUnionStringValueString",
2289
2529
  # user_arn_value: "String",
2290
2530
  # },
2291
2531
  # },
2292
- # equal_to: {
2532
+ # contains: {
2293
2533
  # id: "FieldId", # required
2294
2534
  # value: { # required
2295
- # boolean_value: false,
2535
+ # string_value: "FieldValueUnionStringValueString",
2296
2536
  # double_value: 1.0,
2537
+ # boolean_value: false,
2297
2538
  # empty_value: {
2298
2539
  # },
2299
- # string_value: "FieldValueUnionStringValueString",
2300
2540
  # user_arn_value: "String",
2301
2541
  # },
2302
2542
  # },
2303
2543
  # greater_than: {
2304
2544
  # id: "FieldId", # required
2305
2545
  # value: { # required
2306
- # boolean_value: false,
2546
+ # string_value: "FieldValueUnionStringValueString",
2307
2547
  # double_value: 1.0,
2548
+ # boolean_value: false,
2308
2549
  # empty_value: {
2309
2550
  # },
2310
- # string_value: "FieldValueUnionStringValueString",
2311
2551
  # user_arn_value: "String",
2312
2552
  # },
2313
2553
  # },
2314
2554
  # greater_than_or_equal_to: {
2315
2555
  # id: "FieldId", # required
2316
2556
  # value: { # required
2317
- # boolean_value: false,
2557
+ # string_value: "FieldValueUnionStringValueString",
2318
2558
  # double_value: 1.0,
2559
+ # boolean_value: false,
2319
2560
  # empty_value: {
2320
2561
  # },
2321
- # string_value: "FieldValueUnionStringValueString",
2322
2562
  # user_arn_value: "String",
2323
2563
  # },
2324
2564
  # },
2325
2565
  # less_than: {
2326
2566
  # id: "FieldId", # required
2327
2567
  # value: { # required
2328
- # boolean_value: false,
2568
+ # string_value: "FieldValueUnionStringValueString",
2329
2569
  # double_value: 1.0,
2570
+ # boolean_value: false,
2330
2571
  # empty_value: {
2331
2572
  # },
2332
- # string_value: "FieldValueUnionStringValueString",
2333
2573
  # user_arn_value: "String",
2334
2574
  # },
2335
2575
  # },
2336
2576
  # less_than_or_equal_to: {
2337
2577
  # id: "FieldId", # required
2338
2578
  # value: { # required
2339
- # boolean_value: false,
2579
+ # string_value: "FieldValueUnionStringValueString",
2340
2580
  # double_value: 1.0,
2581
+ # boolean_value: false,
2341
2582
  # empty_value: {
2342
2583
  # },
2343
- # string_value: "FieldValueUnionStringValueString",
2344
2584
  # user_arn_value: "String",
2345
2585
  # },
2346
2586
  # },
@@ -2348,37 +2588,44 @@ module Aws::ConnectCases
2348
2588
  # not: {
2349
2589
  # # recursive CaseFilter
2350
2590
  # },
2591
+ # and_all: [
2592
+ # {
2593
+ # # recursive CaseFilter
2594
+ # },
2595
+ # ],
2351
2596
  # or_all: [
2352
2597
  # {
2353
2598
  # # recursive CaseFilter
2354
2599
  # },
2355
2600
  # ],
2356
2601
  # },
2357
- # max_results: 1,
2358
- # next_token: "NextToken",
2359
- # search_term: "SearchCasesRequestSearchTermString",
2360
2602
  # sorts: [
2361
2603
  # {
2362
2604
  # field_id: "FieldId", # required
2363
2605
  # sort_order: "Asc", # required, accepts Asc, Desc
2364
2606
  # },
2365
2607
  # ],
2608
+ # fields: [
2609
+ # {
2610
+ # id: "FieldId", # required
2611
+ # },
2612
+ # ],
2366
2613
  # })
2367
2614
  #
2368
2615
  # @example Response structure
2369
2616
  #
2617
+ # resp.next_token #=> String
2370
2618
  # resp.cases #=> Array
2371
2619
  # resp.cases[0].case_id #=> String
2620
+ # resp.cases[0].template_id #=> String
2372
2621
  # resp.cases[0].fields #=> Array
2373
2622
  # resp.cases[0].fields[0].id #=> String
2374
- # resp.cases[0].fields[0].value.boolean_value #=> Boolean
2375
- # resp.cases[0].fields[0].value.double_value #=> Float
2376
2623
  # resp.cases[0].fields[0].value.string_value #=> String
2624
+ # resp.cases[0].fields[0].value.double_value #=> Float
2625
+ # resp.cases[0].fields[0].value.boolean_value #=> Boolean
2377
2626
  # resp.cases[0].fields[0].value.user_arn_value #=> String
2378
2627
  # resp.cases[0].tags #=> Hash
2379
2628
  # resp.cases[0].tags["String"] #=> String
2380
- # resp.cases[0].template_id #=> String
2381
- # resp.next_token #=> String
2382
2629
  #
2383
2630
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/SearchCases AWS API Documentation
2384
2631
  #
@@ -2396,15 +2643,11 @@ module Aws::ConnectCases
2396
2643
  #
2397
2644
  # </note>
2398
2645
  #
2399
- # @option params [required, String] :case_id
2400
- # A unique identifier of the case.
2401
- #
2402
2646
  # @option params [required, String] :domain_id
2403
2647
  # The unique identifier of the Cases domain.
2404
2648
  #
2405
- # @option params [Array<Types::RelatedItemTypeFilter>] :filters
2406
- # The list of types of related items and their parameters to use for
2407
- # filtering.
2649
+ # @option params [required, String] :case_id
2650
+ # A unique identifier of the case.
2408
2651
  #
2409
2652
  # @option params [Integer] :max_results
2410
2653
  # The maximum number of results to return per page.
@@ -2414,6 +2657,10 @@ module Aws::ConnectCases
2414
2657
  # previous response in the next request to retrieve the next set of
2415
2658
  # results.
2416
2659
  #
2660
+ # @option params [Array<Types::RelatedItemTypeFilter>] :filters
2661
+ # The list of types of related items and their parameters to use for
2662
+ # filtering.
2663
+ #
2417
2664
  # @return [Types::SearchRelatedItemsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2418
2665
  #
2419
2666
  # * {Types::SearchRelatedItemsResponse#next_token #next_token} => String
@@ -2424,16 +2671,18 @@ module Aws::ConnectCases
2424
2671
  # @example Request syntax with placeholder values
2425
2672
  #
2426
2673
  # resp = client.search_related_items({
2427
- # case_id: "CaseId", # required
2428
2674
  # domain_id: "DomainId", # required
2675
+ # case_id: "CaseId", # required
2676
+ # max_results: 1,
2677
+ # next_token: "NextToken",
2429
2678
  # filters: [
2430
2679
  # {
2431
- # comment: {
2432
- # },
2433
2680
  # contact: {
2434
2681
  # channel: ["Channel"],
2435
2682
  # contact_arn: "ContactArn",
2436
2683
  # },
2684
+ # comment: {
2685
+ # },
2437
2686
  # file: {
2438
2687
  # file_arn: "FileArn",
2439
2688
  # },
@@ -2441,40 +2690,133 @@ module Aws::ConnectCases
2441
2690
  # name: "SlaName",
2442
2691
  # status: "Active", # accepts Active, Overdue, Met, NotMet
2443
2692
  # },
2693
+ # connect_case: {
2694
+ # case_id: "CaseId",
2695
+ # },
2696
+ # custom: {
2697
+ # fields: {
2698
+ # field: {
2699
+ # equal_to: {
2700
+ # id: "FieldId", # required
2701
+ # value: { # required
2702
+ # string_value: "FieldValueUnionStringValueString",
2703
+ # double_value: 1.0,
2704
+ # boolean_value: false,
2705
+ # empty_value: {
2706
+ # },
2707
+ # user_arn_value: "String",
2708
+ # },
2709
+ # },
2710
+ # contains: {
2711
+ # id: "FieldId", # required
2712
+ # value: { # required
2713
+ # string_value: "FieldValueUnionStringValueString",
2714
+ # double_value: 1.0,
2715
+ # boolean_value: false,
2716
+ # empty_value: {
2717
+ # },
2718
+ # user_arn_value: "String",
2719
+ # },
2720
+ # },
2721
+ # greater_than: {
2722
+ # id: "FieldId", # required
2723
+ # value: { # required
2724
+ # string_value: "FieldValueUnionStringValueString",
2725
+ # double_value: 1.0,
2726
+ # boolean_value: false,
2727
+ # empty_value: {
2728
+ # },
2729
+ # user_arn_value: "String",
2730
+ # },
2731
+ # },
2732
+ # greater_than_or_equal_to: {
2733
+ # id: "FieldId", # required
2734
+ # value: { # required
2735
+ # string_value: "FieldValueUnionStringValueString",
2736
+ # double_value: 1.0,
2737
+ # boolean_value: false,
2738
+ # empty_value: {
2739
+ # },
2740
+ # user_arn_value: "String",
2741
+ # },
2742
+ # },
2743
+ # less_than: {
2744
+ # id: "FieldId", # required
2745
+ # value: { # required
2746
+ # string_value: "FieldValueUnionStringValueString",
2747
+ # double_value: 1.0,
2748
+ # boolean_value: false,
2749
+ # empty_value: {
2750
+ # },
2751
+ # user_arn_value: "String",
2752
+ # },
2753
+ # },
2754
+ # less_than_or_equal_to: {
2755
+ # id: "FieldId", # required
2756
+ # value: { # required
2757
+ # string_value: "FieldValueUnionStringValueString",
2758
+ # double_value: 1.0,
2759
+ # boolean_value: false,
2760
+ # empty_value: {
2761
+ # },
2762
+ # user_arn_value: "String",
2763
+ # },
2764
+ # },
2765
+ # },
2766
+ # not: {
2767
+ # # recursive CustomFieldsFilter
2768
+ # },
2769
+ # and_all: [
2770
+ # {
2771
+ # # recursive CustomFieldsFilter
2772
+ # },
2773
+ # ],
2774
+ # or_all: [
2775
+ # {
2776
+ # # recursive CustomFieldsFilter
2777
+ # },
2778
+ # ],
2779
+ # },
2780
+ # },
2444
2781
  # },
2445
2782
  # ],
2446
- # max_results: 1,
2447
- # next_token: "NextToken",
2448
2783
  # })
2449
2784
  #
2450
2785
  # @example Response structure
2451
2786
  #
2452
2787
  # resp.next_token #=> String
2453
2788
  # resp.related_items #=> Array
2789
+ # resp.related_items[0].related_item_id #=> String
2790
+ # resp.related_items[0].type #=> String, one of "Contact", "Comment", "File", "Sla", "ConnectCase", "Custom"
2454
2791
  # resp.related_items[0].association_time #=> Time
2455
- # resp.related_items[0].content.comment.body #=> String
2456
- # resp.related_items[0].content.comment.content_type #=> String, one of "Text/Plain"
2792
+ # resp.related_items[0].content.contact.contact_arn #=> String
2457
2793
  # resp.related_items[0].content.contact.channel #=> String
2458
2794
  # resp.related_items[0].content.contact.connected_to_system_time #=> Time
2459
- # resp.related_items[0].content.contact.contact_arn #=> String
2795
+ # resp.related_items[0].content.comment.body #=> String
2796
+ # resp.related_items[0].content.comment.content_type #=> String, one of "Text/Plain"
2460
2797
  # resp.related_items[0].content.file.file_arn #=> String
2461
- # resp.related_items[0].content.sla.sla_configuration.completion_time #=> Time
2462
- # resp.related_items[0].content.sla.sla_configuration.field_id #=> String
2463
2798
  # resp.related_items[0].content.sla.sla_configuration.name #=> String
2799
+ # resp.related_items[0].content.sla.sla_configuration.type #=> String, one of "CaseField"
2464
2800
  # resp.related_items[0].content.sla.sla_configuration.status #=> String, one of "Active", "Overdue", "Met", "NotMet"
2801
+ # resp.related_items[0].content.sla.sla_configuration.field_id #=> String
2465
2802
  # resp.related_items[0].content.sla.sla_configuration.target_field_values #=> Array
2466
- # resp.related_items[0].content.sla.sla_configuration.target_field_values[0].boolean_value #=> Boolean
2467
- # resp.related_items[0].content.sla.sla_configuration.target_field_values[0].double_value #=> Float
2468
2803
  # resp.related_items[0].content.sla.sla_configuration.target_field_values[0].string_value #=> String
2804
+ # resp.related_items[0].content.sla.sla_configuration.target_field_values[0].double_value #=> Float
2805
+ # resp.related_items[0].content.sla.sla_configuration.target_field_values[0].boolean_value #=> Boolean
2469
2806
  # resp.related_items[0].content.sla.sla_configuration.target_field_values[0].user_arn_value #=> String
2470
2807
  # resp.related_items[0].content.sla.sla_configuration.target_time #=> Time
2471
- # resp.related_items[0].content.sla.sla_configuration.type #=> String, one of "CaseField"
2472
- # resp.related_items[0].performed_by.custom_entity #=> String
2473
- # resp.related_items[0].performed_by.user_arn #=> String
2474
- # resp.related_items[0].related_item_id #=> String
2808
+ # resp.related_items[0].content.sla.sla_configuration.completion_time #=> Time
2809
+ # resp.related_items[0].content.connect_case.case_id #=> String
2810
+ # resp.related_items[0].content.custom.fields #=> Array
2811
+ # resp.related_items[0].content.custom.fields[0].id #=> String
2812
+ # resp.related_items[0].content.custom.fields[0].value.string_value #=> String
2813
+ # resp.related_items[0].content.custom.fields[0].value.double_value #=> Float
2814
+ # resp.related_items[0].content.custom.fields[0].value.boolean_value #=> Boolean
2815
+ # resp.related_items[0].content.custom.fields[0].value.user_arn_value #=> String
2475
2816
  # resp.related_items[0].tags #=> Hash
2476
2817
  # resp.related_items[0].tags["String"] #=> String
2477
- # resp.related_items[0].type #=> String, one of "Contact", "Comment", "File", "Sla"
2818
+ # resp.related_items[0].performed_by.user_arn #=> String
2819
+ # resp.related_items[0].performed_by.custom_entity #=> String
2478
2820
  #
2479
2821
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/SearchRelatedItems AWS API Documentation
2480
2822
  #
@@ -2558,12 +2900,12 @@ module Aws::ConnectCases
2558
2900
  #
2559
2901
  # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html
2560
2902
  #
2561
- # @option params [required, String] :case_id
2562
- # A unique identifier of the case.
2563
- #
2564
2903
  # @option params [required, String] :domain_id
2565
2904
  # The unique identifier of the Cases domain.
2566
2905
  #
2906
+ # @option params [required, String] :case_id
2907
+ # A unique identifier of the case.
2908
+ #
2567
2909
  # @option params [required, Array<Types::FieldValue>] :fields
2568
2910
  # An array of objects with `fieldId` (matching ListFields/DescribeField)
2569
2911
  # and value union data, structured identical to `CreateCase`.
@@ -2576,24 +2918,24 @@ module Aws::ConnectCases
2576
2918
  # @example Request syntax with placeholder values
2577
2919
  #
2578
2920
  # resp = client.update_case({
2579
- # case_id: "CaseId", # required
2580
2921
  # domain_id: "DomainId", # required
2922
+ # case_id: "CaseId", # required
2581
2923
  # fields: [ # required
2582
2924
  # {
2583
2925
  # id: "FieldId", # required
2584
2926
  # value: { # required
2585
- # boolean_value: false,
2927
+ # string_value: "FieldValueUnionStringValueString",
2586
2928
  # double_value: 1.0,
2929
+ # boolean_value: false,
2587
2930
  # empty_value: {
2588
2931
  # },
2589
- # string_value: "FieldValueUnionStringValueString",
2590
2932
  # user_arn_value: "String",
2591
2933
  # },
2592
2934
  # },
2593
2935
  # ],
2594
2936
  # performed_by: {
2595
- # custom_entity: "CustomEntity",
2596
2937
  # user_arn: "UserArn",
2938
+ # custom_entity: "CustomEntity",
2597
2939
  # },
2598
2940
  # })
2599
2941
  #
@@ -2615,18 +2957,18 @@ module Aws::ConnectCases
2615
2957
  #
2616
2958
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html
2617
2959
  #
2618
- # @option params [required, String] :case_rule_id
2619
- # Unique identifier of a case rule.
2620
- #
2621
- # @option params [String] :description
2622
- # Description of a case rule.
2623
- #
2624
2960
  # @option params [required, String] :domain_id
2625
2961
  # Unique identifier of a Cases domain.
2626
2962
  #
2963
+ # @option params [required, String] :case_rule_id
2964
+ # Unique identifier of a case rule.
2965
+ #
2627
2966
  # @option params [String] :name
2628
2967
  # Name of the case rule.
2629
2968
  #
2969
+ # @option params [String] :description
2970
+ # Description of a case rule.
2971
+ #
2630
2972
  # @option params [Types::CaseRuleDetails] :rule
2631
2973
  # Represents what rule type should take place, under what conditions.
2632
2974
  #
@@ -2635,12 +2977,13 @@ module Aws::ConnectCases
2635
2977
  # @example Request syntax with placeholder values
2636
2978
  #
2637
2979
  # resp = client.update_case_rule({
2638
- # case_rule_id: "CaseRuleId", # required
2639
- # description: "CaseRuleDescription",
2640
2980
  # domain_id: "DomainId", # required
2981
+ # case_rule_id: "CaseRuleId", # required
2641
2982
  # name: "CaseRuleName",
2983
+ # description: "CaseRuleDescription",
2642
2984
  # rule: {
2643
2985
  # required: {
2986
+ # default_value: false, # required
2644
2987
  # conditions: [ # required
2645
2988
  # {
2646
2989
  # equal_to: {
@@ -2648,11 +2991,11 @@ module Aws::ConnectCases
2648
2991
  # field_id: "FieldId",
2649
2992
  # },
2650
2993
  # operand_two: { # required
2994
+ # string_value: "OperandTwoStringValueString",
2651
2995
  # boolean_value: false,
2652
2996
  # double_value: 1.0,
2653
2997
  # empty_value: {
2654
2998
  # },
2655
- # string_value: "OperandTwoStringValueString",
2656
2999
  # },
2657
3000
  # result: false, # required
2658
3001
  # },
@@ -2661,17 +3004,16 @@ module Aws::ConnectCases
2661
3004
  # field_id: "FieldId",
2662
3005
  # },
2663
3006
  # operand_two: { # required
3007
+ # string_value: "OperandTwoStringValueString",
2664
3008
  # boolean_value: false,
2665
3009
  # double_value: 1.0,
2666
3010
  # empty_value: {
2667
3011
  # },
2668
- # string_value: "OperandTwoStringValueString",
2669
3012
  # },
2670
3013
  # result: false, # required
2671
3014
  # },
2672
3015
  # },
2673
3016
  # ],
2674
- # default_value: false, # required
2675
3017
  # },
2676
3018
  # },
2677
3019
  # })
@@ -2687,9 +3029,6 @@ module Aws::ConnectCases
2687
3029
 
2688
3030
  # Updates the properties of an existing field.
2689
3031
  #
2690
- # @option params [String] :description
2691
- # The description of a field.
2692
- #
2693
3032
  # @option params [required, String] :domain_id
2694
3033
  # The unique identifier of the Cases domain.
2695
3034
  #
@@ -2699,15 +3038,18 @@ module Aws::ConnectCases
2699
3038
  # @option params [String] :name
2700
3039
  # The name of the field.
2701
3040
  #
3041
+ # @option params [String] :description
3042
+ # The description of a field.
3043
+ #
2702
3044
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2703
3045
  #
2704
3046
  # @example Request syntax with placeholder values
2705
3047
  #
2706
3048
  # resp = client.update_field({
2707
- # description: "FieldDescription",
2708
3049
  # domain_id: "DomainId", # required
2709
3050
  # field_id: "FieldId", # required
2710
3051
  # name: "FieldName",
3052
+ # description: "FieldDescription",
2711
3053
  # })
2712
3054
  #
2713
3055
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/UpdateField AWS API Documentation
@@ -2732,10 +3074,6 @@ module Aws::ConnectCases
2732
3074
  #
2733
3075
  # </note>
2734
3076
  #
2735
- # @option params [Types::LayoutContent] :content
2736
- # Information about which fields will be present in the layout, the
2737
- # order of the fields.
2738
- #
2739
3077
  # @option params [required, String] :domain_id
2740
3078
  # The unique identifier of the Cases domain.
2741
3079
  #
@@ -2745,46 +3083,50 @@ module Aws::ConnectCases
2745
3083
  # @option params [String] :name
2746
3084
  # The name of the layout. It must be unique per domain.
2747
3085
  #
3086
+ # @option params [Types::LayoutContent] :content
3087
+ # Information about which fields will be present in the layout, the
3088
+ # order of the fields.
3089
+ #
2748
3090
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2749
3091
  #
2750
3092
  # @example Request syntax with placeholder values
2751
3093
  #
2752
3094
  # resp = client.update_layout({
3095
+ # domain_id: "DomainId", # required
3096
+ # layout_id: "LayoutId", # required
3097
+ # name: "LayoutName",
2753
3098
  # content: {
2754
3099
  # basic: {
2755
- # more_info: {
3100
+ # top_panel: {
2756
3101
  # sections: [
2757
3102
  # {
2758
3103
  # field_group: {
3104
+ # name: "FieldGroupNameString",
2759
3105
  # fields: [ # required
2760
3106
  # {
2761
3107
  # id: "FieldId", # required
2762
3108
  # },
2763
3109
  # ],
2764
- # name: "FieldGroupNameString",
2765
3110
  # },
2766
3111
  # },
2767
3112
  # ],
2768
3113
  # },
2769
- # top_panel: {
3114
+ # more_info: {
2770
3115
  # sections: [
2771
3116
  # {
2772
3117
  # field_group: {
3118
+ # name: "FieldGroupNameString",
2773
3119
  # fields: [ # required
2774
3120
  # {
2775
3121
  # id: "FieldId", # required
2776
3122
  # },
2777
3123
  # ],
2778
- # name: "FieldGroupNameString",
2779
3124
  # },
2780
3125
  # },
2781
3126
  # ],
2782
3127
  # },
2783
3128
  # },
2784
3129
  # },
2785
- # domain_id: "DomainId", # required
2786
- # layout_id: "LayoutId", # required
2787
- # name: "LayoutName",
2788
3130
  # })
2789
3131
  #
2790
3132
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/UpdateLayout AWS API Documentation
@@ -2820,22 +3162,28 @@ module Aws::ConnectCases
2820
3162
  # [3]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetTemplate.html
2821
3163
  # [4]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_ListTemplates.html
2822
3164
  #
2823
- # @option params [String] :description
2824
- # A brief description of the template.
2825
- #
2826
3165
  # @option params [required, String] :domain_id
2827
3166
  # The unique identifier of the Cases domain.
2828
3167
  #
2829
- # @option params [Types::LayoutConfiguration] :layout_configuration
2830
- # Configuration of layouts associated to the template.
3168
+ # @option params [required, String] :template_id
3169
+ # A unique identifier for the template.
2831
3170
  #
2832
3171
  # @option params [String] :name
2833
3172
  # The name of the template. It must be unique per domain.
2834
3173
  #
3174
+ # @option params [String] :description
3175
+ # A brief description of the template.
3176
+ #
3177
+ # @option params [Types::LayoutConfiguration] :layout_configuration
3178
+ # Configuration of layouts associated to the template.
3179
+ #
2835
3180
  # @option params [Array<Types::RequiredField>] :required_fields
2836
3181
  # A list of fields that must contain a value for a case to be
2837
3182
  # successfully created with this template.
2838
3183
  #
3184
+ # @option params [String] :status
3185
+ # The status of the template.
3186
+ #
2839
3187
  # @option params [Array<Types::TemplateRule>] :rules
2840
3188
  # A list of case rules (also known as [case field conditions][1]) on a
2841
3189
  # template.
@@ -2844,36 +3192,30 @@ module Aws::ConnectCases
2844
3192
  #
2845
3193
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html
2846
3194
  #
2847
- # @option params [String] :status
2848
- # The status of the template.
2849
- #
2850
- # @option params [required, String] :template_id
2851
- # A unique identifier for the template.
2852
- #
2853
3195
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2854
3196
  #
2855
3197
  # @example Request syntax with placeholder values
2856
3198
  #
2857
3199
  # resp = client.update_template({
2858
- # description: "TemplateDescription",
2859
3200
  # domain_id: "DomainId", # required
3201
+ # template_id: "TemplateId", # required
3202
+ # name: "TemplateName",
3203
+ # description: "TemplateDescription",
2860
3204
  # layout_configuration: {
2861
3205
  # default_layout: "LayoutId",
2862
3206
  # },
2863
- # name: "TemplateName",
2864
3207
  # required_fields: [
2865
3208
  # {
2866
3209
  # field_id: "FieldId", # required
2867
3210
  # },
2868
3211
  # ],
3212
+ # status: "Active", # accepts Active, Inactive
2869
3213
  # rules: [
2870
3214
  # {
2871
3215
  # case_rule_id: "CaseRuleId", # required
2872
3216
  # field_id: "FieldId", # required
2873
3217
  # },
2874
3218
  # ],
2875
- # status: "Active", # accepts Active, Inactive
2876
- # template_id: "TemplateId", # required
2877
3219
  # })
2878
3220
  #
2879
3221
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/UpdateTemplate AWS API Documentation
@@ -2903,7 +3245,7 @@ module Aws::ConnectCases
2903
3245
  tracer: tracer
2904
3246
  )
2905
3247
  context[:gem_name] = 'aws-sdk-connectcases'
2906
- context[:gem_version] = '1.50.0'
3248
+ context[:gem_version] = '1.52.0'
2907
3249
  Seahorse::Client::Request.new(handlers, context)
2908
3250
  end
2909
3251