aws-sdk-connectcases 1.49.0 → 1.51.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
  #
@@ -2232,16 +2249,9 @@ module Aws::ConnectCases
2232
2249
  # @option params [required, String] :domain_id
2233
2250
  # The unique identifier of the Cases domain.
2234
2251
  #
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
2252
  # @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.
2253
+ # The maximum number of cases to return. When no value is provided, 25
2254
+ # is the default.
2245
2255
  #
2246
2256
  # @option params [String] :next_token
2247
2257
  # The token for the next set of results. Use the value returned in the
@@ -2251,14 +2261,20 @@ module Aws::ConnectCases
2251
2261
  # @option params [String] :search_term
2252
2262
  # A word or phrase used to perform a quick search.
2253
2263
  #
2264
+ # @option params [Types::CaseFilter] :filter
2265
+ # A list of filter objects.
2266
+ #
2254
2267
  # @option params [Array<Types::Sort>] :sorts
2255
2268
  # A list of sorts where each sort specifies a field and their sort order
2256
2269
  # to be applied to the results.
2257
2270
  #
2271
+ # @option params [Array<Types::FieldIdentifier>] :fields
2272
+ # The list of field identifiers to be returned as part of the response.
2273
+ #
2258
2274
  # @return [Types::SearchCasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2259
2275
  #
2260
- # * {Types::SearchCasesResponse#cases #cases} => Array&lt;Types::SearchCasesResponseItem&gt;
2261
2276
  # * {Types::SearchCasesResponse#next_token #next_token} => String
2277
+ # * {Types::SearchCasesResponse#cases #cases} => Array&lt;Types::SearchCasesResponseItem&gt;
2262
2278
  #
2263
2279
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2264
2280
  #
@@ -2266,81 +2282,74 @@ module Aws::ConnectCases
2266
2282
  #
2267
2283
  # resp = client.search_cases({
2268
2284
  # domain_id: "DomainId", # required
2269
- # fields: [
2270
- # {
2271
- # id: "FieldId", # required
2272
- # },
2273
- # ],
2285
+ # max_results: 1,
2286
+ # next_token: "NextToken",
2287
+ # search_term: "SearchCasesRequestSearchTermString",
2274
2288
  # filter: {
2275
- # and_all: [
2276
- # {
2277
- # # recursive CaseFilter
2278
- # },
2279
- # ],
2280
2289
  # field: {
2281
- # contains: {
2290
+ # equal_to: {
2282
2291
  # id: "FieldId", # required
2283
2292
  # value: { # required
2284
- # boolean_value: false,
2293
+ # string_value: "FieldValueUnionStringValueString",
2285
2294
  # double_value: 1.0,
2295
+ # boolean_value: false,
2286
2296
  # empty_value: {
2287
2297
  # },
2288
- # string_value: "FieldValueUnionStringValueString",
2289
2298
  # user_arn_value: "String",
2290
2299
  # },
2291
2300
  # },
2292
- # equal_to: {
2301
+ # contains: {
2293
2302
  # id: "FieldId", # required
2294
2303
  # value: { # required
2295
- # boolean_value: false,
2304
+ # string_value: "FieldValueUnionStringValueString",
2296
2305
  # double_value: 1.0,
2306
+ # boolean_value: false,
2297
2307
  # empty_value: {
2298
2308
  # },
2299
- # string_value: "FieldValueUnionStringValueString",
2300
2309
  # user_arn_value: "String",
2301
2310
  # },
2302
2311
  # },
2303
2312
  # greater_than: {
2304
2313
  # id: "FieldId", # required
2305
2314
  # value: { # required
2306
- # boolean_value: false,
2315
+ # string_value: "FieldValueUnionStringValueString",
2307
2316
  # double_value: 1.0,
2317
+ # boolean_value: false,
2308
2318
  # empty_value: {
2309
2319
  # },
2310
- # string_value: "FieldValueUnionStringValueString",
2311
2320
  # user_arn_value: "String",
2312
2321
  # },
2313
2322
  # },
2314
2323
  # greater_than_or_equal_to: {
2315
2324
  # id: "FieldId", # required
2316
2325
  # value: { # required
2317
- # boolean_value: false,
2326
+ # string_value: "FieldValueUnionStringValueString",
2318
2327
  # double_value: 1.0,
2328
+ # boolean_value: false,
2319
2329
  # empty_value: {
2320
2330
  # },
2321
- # string_value: "FieldValueUnionStringValueString",
2322
2331
  # user_arn_value: "String",
2323
2332
  # },
2324
2333
  # },
2325
2334
  # less_than: {
2326
2335
  # id: "FieldId", # required
2327
2336
  # value: { # required
2328
- # boolean_value: false,
2337
+ # string_value: "FieldValueUnionStringValueString",
2329
2338
  # double_value: 1.0,
2339
+ # boolean_value: false,
2330
2340
  # empty_value: {
2331
2341
  # },
2332
- # string_value: "FieldValueUnionStringValueString",
2333
2342
  # user_arn_value: "String",
2334
2343
  # },
2335
2344
  # },
2336
2345
  # less_than_or_equal_to: {
2337
2346
  # id: "FieldId", # required
2338
2347
  # value: { # required
2339
- # boolean_value: false,
2348
+ # string_value: "FieldValueUnionStringValueString",
2340
2349
  # double_value: 1.0,
2350
+ # boolean_value: false,
2341
2351
  # empty_value: {
2342
2352
  # },
2343
- # string_value: "FieldValueUnionStringValueString",
2344
2353
  # user_arn_value: "String",
2345
2354
  # },
2346
2355
  # },
@@ -2348,37 +2357,44 @@ module Aws::ConnectCases
2348
2357
  # not: {
2349
2358
  # # recursive CaseFilter
2350
2359
  # },
2360
+ # and_all: [
2361
+ # {
2362
+ # # recursive CaseFilter
2363
+ # },
2364
+ # ],
2351
2365
  # or_all: [
2352
2366
  # {
2353
2367
  # # recursive CaseFilter
2354
2368
  # },
2355
2369
  # ],
2356
2370
  # },
2357
- # max_results: 1,
2358
- # next_token: "NextToken",
2359
- # search_term: "SearchCasesRequestSearchTermString",
2360
2371
  # sorts: [
2361
2372
  # {
2362
2373
  # field_id: "FieldId", # required
2363
2374
  # sort_order: "Asc", # required, accepts Asc, Desc
2364
2375
  # },
2365
2376
  # ],
2377
+ # fields: [
2378
+ # {
2379
+ # id: "FieldId", # required
2380
+ # },
2381
+ # ],
2366
2382
  # })
2367
2383
  #
2368
2384
  # @example Response structure
2369
2385
  #
2386
+ # resp.next_token #=> String
2370
2387
  # resp.cases #=> Array
2371
2388
  # resp.cases[0].case_id #=> String
2389
+ # resp.cases[0].template_id #=> String
2372
2390
  # resp.cases[0].fields #=> Array
2373
2391
  # 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
2392
  # resp.cases[0].fields[0].value.string_value #=> String
2393
+ # resp.cases[0].fields[0].value.double_value #=> Float
2394
+ # resp.cases[0].fields[0].value.boolean_value #=> Boolean
2377
2395
  # resp.cases[0].fields[0].value.user_arn_value #=> String
2378
2396
  # resp.cases[0].tags #=> Hash
2379
2397
  # resp.cases[0].tags["String"] #=> String
2380
- # resp.cases[0].template_id #=> String
2381
- # resp.next_token #=> String
2382
2398
  #
2383
2399
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/SearchCases AWS API Documentation
2384
2400
  #
@@ -2396,15 +2412,11 @@ module Aws::ConnectCases
2396
2412
  #
2397
2413
  # </note>
2398
2414
  #
2399
- # @option params [required, String] :case_id
2400
- # A unique identifier of the case.
2401
- #
2402
2415
  # @option params [required, String] :domain_id
2403
2416
  # The unique identifier of the Cases domain.
2404
2417
  #
2405
- # @option params [Array<Types::RelatedItemTypeFilter>] :filters
2406
- # The list of types of related items and their parameters to use for
2407
- # filtering.
2418
+ # @option params [required, String] :case_id
2419
+ # A unique identifier of the case.
2408
2420
  #
2409
2421
  # @option params [Integer] :max_results
2410
2422
  # The maximum number of results to return per page.
@@ -2414,6 +2426,10 @@ module Aws::ConnectCases
2414
2426
  # previous response in the next request to retrieve the next set of
2415
2427
  # results.
2416
2428
  #
2429
+ # @option params [Array<Types::RelatedItemTypeFilter>] :filters
2430
+ # The list of types of related items and their parameters to use for
2431
+ # filtering.
2432
+ #
2417
2433
  # @return [Types::SearchRelatedItemsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2418
2434
  #
2419
2435
  # * {Types::SearchRelatedItemsResponse#next_token #next_token} => String
@@ -2424,16 +2440,18 @@ module Aws::ConnectCases
2424
2440
  # @example Request syntax with placeholder values
2425
2441
  #
2426
2442
  # resp = client.search_related_items({
2427
- # case_id: "CaseId", # required
2428
2443
  # domain_id: "DomainId", # required
2444
+ # case_id: "CaseId", # required
2445
+ # max_results: 1,
2446
+ # next_token: "NextToken",
2429
2447
  # filters: [
2430
2448
  # {
2431
- # comment: {
2432
- # },
2433
2449
  # contact: {
2434
2450
  # channel: ["Channel"],
2435
2451
  # contact_arn: "ContactArn",
2436
2452
  # },
2453
+ # comment: {
2454
+ # },
2437
2455
  # file: {
2438
2456
  # file_arn: "FileArn",
2439
2457
  # },
@@ -2441,40 +2459,133 @@ module Aws::ConnectCases
2441
2459
  # name: "SlaName",
2442
2460
  # status: "Active", # accepts Active, Overdue, Met, NotMet
2443
2461
  # },
2462
+ # connect_case: {
2463
+ # case_id: "CaseId",
2464
+ # },
2465
+ # custom: {
2466
+ # fields: {
2467
+ # field: {
2468
+ # equal_to: {
2469
+ # id: "FieldId", # required
2470
+ # value: { # required
2471
+ # string_value: "FieldValueUnionStringValueString",
2472
+ # double_value: 1.0,
2473
+ # boolean_value: false,
2474
+ # empty_value: {
2475
+ # },
2476
+ # user_arn_value: "String",
2477
+ # },
2478
+ # },
2479
+ # contains: {
2480
+ # id: "FieldId", # required
2481
+ # value: { # required
2482
+ # string_value: "FieldValueUnionStringValueString",
2483
+ # double_value: 1.0,
2484
+ # boolean_value: false,
2485
+ # empty_value: {
2486
+ # },
2487
+ # user_arn_value: "String",
2488
+ # },
2489
+ # },
2490
+ # greater_than: {
2491
+ # id: "FieldId", # required
2492
+ # value: { # required
2493
+ # string_value: "FieldValueUnionStringValueString",
2494
+ # double_value: 1.0,
2495
+ # boolean_value: false,
2496
+ # empty_value: {
2497
+ # },
2498
+ # user_arn_value: "String",
2499
+ # },
2500
+ # },
2501
+ # greater_than_or_equal_to: {
2502
+ # id: "FieldId", # required
2503
+ # value: { # required
2504
+ # string_value: "FieldValueUnionStringValueString",
2505
+ # double_value: 1.0,
2506
+ # boolean_value: false,
2507
+ # empty_value: {
2508
+ # },
2509
+ # user_arn_value: "String",
2510
+ # },
2511
+ # },
2512
+ # less_than: {
2513
+ # id: "FieldId", # required
2514
+ # value: { # required
2515
+ # string_value: "FieldValueUnionStringValueString",
2516
+ # double_value: 1.0,
2517
+ # boolean_value: false,
2518
+ # empty_value: {
2519
+ # },
2520
+ # user_arn_value: "String",
2521
+ # },
2522
+ # },
2523
+ # less_than_or_equal_to: {
2524
+ # id: "FieldId", # required
2525
+ # value: { # required
2526
+ # string_value: "FieldValueUnionStringValueString",
2527
+ # double_value: 1.0,
2528
+ # boolean_value: false,
2529
+ # empty_value: {
2530
+ # },
2531
+ # user_arn_value: "String",
2532
+ # },
2533
+ # },
2534
+ # },
2535
+ # not: {
2536
+ # # recursive CustomFieldsFilter
2537
+ # },
2538
+ # and_all: [
2539
+ # {
2540
+ # # recursive CustomFieldsFilter
2541
+ # },
2542
+ # ],
2543
+ # or_all: [
2544
+ # {
2545
+ # # recursive CustomFieldsFilter
2546
+ # },
2547
+ # ],
2548
+ # },
2549
+ # },
2444
2550
  # },
2445
2551
  # ],
2446
- # max_results: 1,
2447
- # next_token: "NextToken",
2448
2552
  # })
2449
2553
  #
2450
2554
  # @example Response structure
2451
2555
  #
2452
2556
  # resp.next_token #=> String
2453
2557
  # resp.related_items #=> Array
2558
+ # resp.related_items[0].related_item_id #=> String
2559
+ # resp.related_items[0].type #=> String, one of "Contact", "Comment", "File", "Sla", "ConnectCase", "Custom"
2454
2560
  # 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"
2561
+ # resp.related_items[0].content.contact.contact_arn #=> String
2457
2562
  # resp.related_items[0].content.contact.channel #=> String
2458
2563
  # resp.related_items[0].content.contact.connected_to_system_time #=> Time
2459
- # resp.related_items[0].content.contact.contact_arn #=> String
2564
+ # resp.related_items[0].content.comment.body #=> String
2565
+ # resp.related_items[0].content.comment.content_type #=> String, one of "Text/Plain"
2460
2566
  # 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
2567
  # resp.related_items[0].content.sla.sla_configuration.name #=> String
2568
+ # resp.related_items[0].content.sla.sla_configuration.type #=> String, one of "CaseField"
2464
2569
  # resp.related_items[0].content.sla.sla_configuration.status #=> String, one of "Active", "Overdue", "Met", "NotMet"
2570
+ # resp.related_items[0].content.sla.sla_configuration.field_id #=> String
2465
2571
  # 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
2572
  # resp.related_items[0].content.sla.sla_configuration.target_field_values[0].string_value #=> String
2573
+ # resp.related_items[0].content.sla.sla_configuration.target_field_values[0].double_value #=> Float
2574
+ # resp.related_items[0].content.sla.sla_configuration.target_field_values[0].boolean_value #=> Boolean
2469
2575
  # resp.related_items[0].content.sla.sla_configuration.target_field_values[0].user_arn_value #=> String
2470
2576
  # 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
2577
+ # resp.related_items[0].content.sla.sla_configuration.completion_time #=> Time
2578
+ # resp.related_items[0].content.connect_case.case_id #=> String
2579
+ # resp.related_items[0].content.custom.fields #=> Array
2580
+ # resp.related_items[0].content.custom.fields[0].id #=> String
2581
+ # resp.related_items[0].content.custom.fields[0].value.string_value #=> String
2582
+ # resp.related_items[0].content.custom.fields[0].value.double_value #=> Float
2583
+ # resp.related_items[0].content.custom.fields[0].value.boolean_value #=> Boolean
2584
+ # resp.related_items[0].content.custom.fields[0].value.user_arn_value #=> String
2475
2585
  # resp.related_items[0].tags #=> Hash
2476
2586
  # resp.related_items[0].tags["String"] #=> String
2477
- # resp.related_items[0].type #=> String, one of "Contact", "Comment", "File", "Sla"
2587
+ # resp.related_items[0].performed_by.user_arn #=> String
2588
+ # resp.related_items[0].performed_by.custom_entity #=> String
2478
2589
  #
2479
2590
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/SearchRelatedItems AWS API Documentation
2480
2591
  #
@@ -2558,12 +2669,12 @@ module Aws::ConnectCases
2558
2669
  #
2559
2670
  # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html
2560
2671
  #
2561
- # @option params [required, String] :case_id
2562
- # A unique identifier of the case.
2563
- #
2564
2672
  # @option params [required, String] :domain_id
2565
2673
  # The unique identifier of the Cases domain.
2566
2674
  #
2675
+ # @option params [required, String] :case_id
2676
+ # A unique identifier of the case.
2677
+ #
2567
2678
  # @option params [required, Array<Types::FieldValue>] :fields
2568
2679
  # An array of objects with `fieldId` (matching ListFields/DescribeField)
2569
2680
  # and value union data, structured identical to `CreateCase`.
@@ -2576,24 +2687,24 @@ module Aws::ConnectCases
2576
2687
  # @example Request syntax with placeholder values
2577
2688
  #
2578
2689
  # resp = client.update_case({
2579
- # case_id: "CaseId", # required
2580
2690
  # domain_id: "DomainId", # required
2691
+ # case_id: "CaseId", # required
2581
2692
  # fields: [ # required
2582
2693
  # {
2583
2694
  # id: "FieldId", # required
2584
2695
  # value: { # required
2585
- # boolean_value: false,
2696
+ # string_value: "FieldValueUnionStringValueString",
2586
2697
  # double_value: 1.0,
2698
+ # boolean_value: false,
2587
2699
  # empty_value: {
2588
2700
  # },
2589
- # string_value: "FieldValueUnionStringValueString",
2590
2701
  # user_arn_value: "String",
2591
2702
  # },
2592
2703
  # },
2593
2704
  # ],
2594
2705
  # performed_by: {
2595
- # custom_entity: "CustomEntity",
2596
2706
  # user_arn: "UserArn",
2707
+ # custom_entity: "CustomEntity",
2597
2708
  # },
2598
2709
  # })
2599
2710
  #
@@ -2615,18 +2726,18 @@ module Aws::ConnectCases
2615
2726
  #
2616
2727
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html
2617
2728
  #
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
2729
  # @option params [required, String] :domain_id
2625
2730
  # Unique identifier of a Cases domain.
2626
2731
  #
2732
+ # @option params [required, String] :case_rule_id
2733
+ # Unique identifier of a case rule.
2734
+ #
2627
2735
  # @option params [String] :name
2628
2736
  # Name of the case rule.
2629
2737
  #
2738
+ # @option params [String] :description
2739
+ # Description of a case rule.
2740
+ #
2630
2741
  # @option params [Types::CaseRuleDetails] :rule
2631
2742
  # Represents what rule type should take place, under what conditions.
2632
2743
  #
@@ -2635,12 +2746,13 @@ module Aws::ConnectCases
2635
2746
  # @example Request syntax with placeholder values
2636
2747
  #
2637
2748
  # resp = client.update_case_rule({
2638
- # case_rule_id: "CaseRuleId", # required
2639
- # description: "CaseRuleDescription",
2640
2749
  # domain_id: "DomainId", # required
2750
+ # case_rule_id: "CaseRuleId", # required
2641
2751
  # name: "CaseRuleName",
2752
+ # description: "CaseRuleDescription",
2642
2753
  # rule: {
2643
2754
  # required: {
2755
+ # default_value: false, # required
2644
2756
  # conditions: [ # required
2645
2757
  # {
2646
2758
  # equal_to: {
@@ -2648,11 +2760,11 @@ module Aws::ConnectCases
2648
2760
  # field_id: "FieldId",
2649
2761
  # },
2650
2762
  # operand_two: { # required
2763
+ # string_value: "OperandTwoStringValueString",
2651
2764
  # boolean_value: false,
2652
2765
  # double_value: 1.0,
2653
2766
  # empty_value: {
2654
2767
  # },
2655
- # string_value: "OperandTwoStringValueString",
2656
2768
  # },
2657
2769
  # result: false, # required
2658
2770
  # },
@@ -2661,17 +2773,16 @@ module Aws::ConnectCases
2661
2773
  # field_id: "FieldId",
2662
2774
  # },
2663
2775
  # operand_two: { # required
2776
+ # string_value: "OperandTwoStringValueString",
2664
2777
  # boolean_value: false,
2665
2778
  # double_value: 1.0,
2666
2779
  # empty_value: {
2667
2780
  # },
2668
- # string_value: "OperandTwoStringValueString",
2669
2781
  # },
2670
2782
  # result: false, # required
2671
2783
  # },
2672
2784
  # },
2673
2785
  # ],
2674
- # default_value: false, # required
2675
2786
  # },
2676
2787
  # },
2677
2788
  # })
@@ -2687,9 +2798,6 @@ module Aws::ConnectCases
2687
2798
 
2688
2799
  # Updates the properties of an existing field.
2689
2800
  #
2690
- # @option params [String] :description
2691
- # The description of a field.
2692
- #
2693
2801
  # @option params [required, String] :domain_id
2694
2802
  # The unique identifier of the Cases domain.
2695
2803
  #
@@ -2699,15 +2807,18 @@ module Aws::ConnectCases
2699
2807
  # @option params [String] :name
2700
2808
  # The name of the field.
2701
2809
  #
2810
+ # @option params [String] :description
2811
+ # The description of a field.
2812
+ #
2702
2813
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2703
2814
  #
2704
2815
  # @example Request syntax with placeholder values
2705
2816
  #
2706
2817
  # resp = client.update_field({
2707
- # description: "FieldDescription",
2708
2818
  # domain_id: "DomainId", # required
2709
2819
  # field_id: "FieldId", # required
2710
2820
  # name: "FieldName",
2821
+ # description: "FieldDescription",
2711
2822
  # })
2712
2823
  #
2713
2824
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/UpdateField AWS API Documentation
@@ -2732,10 +2843,6 @@ module Aws::ConnectCases
2732
2843
  #
2733
2844
  # </note>
2734
2845
  #
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
2846
  # @option params [required, String] :domain_id
2740
2847
  # The unique identifier of the Cases domain.
2741
2848
  #
@@ -2745,46 +2852,50 @@ module Aws::ConnectCases
2745
2852
  # @option params [String] :name
2746
2853
  # The name of the layout. It must be unique per domain.
2747
2854
  #
2855
+ # @option params [Types::LayoutContent] :content
2856
+ # Information about which fields will be present in the layout, the
2857
+ # order of the fields.
2858
+ #
2748
2859
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2749
2860
  #
2750
2861
  # @example Request syntax with placeholder values
2751
2862
  #
2752
2863
  # resp = client.update_layout({
2864
+ # domain_id: "DomainId", # required
2865
+ # layout_id: "LayoutId", # required
2866
+ # name: "LayoutName",
2753
2867
  # content: {
2754
2868
  # basic: {
2755
- # more_info: {
2869
+ # top_panel: {
2756
2870
  # sections: [
2757
2871
  # {
2758
2872
  # field_group: {
2873
+ # name: "FieldGroupNameString",
2759
2874
  # fields: [ # required
2760
2875
  # {
2761
2876
  # id: "FieldId", # required
2762
2877
  # },
2763
2878
  # ],
2764
- # name: "FieldGroupNameString",
2765
2879
  # },
2766
2880
  # },
2767
2881
  # ],
2768
2882
  # },
2769
- # top_panel: {
2883
+ # more_info: {
2770
2884
  # sections: [
2771
2885
  # {
2772
2886
  # field_group: {
2887
+ # name: "FieldGroupNameString",
2773
2888
  # fields: [ # required
2774
2889
  # {
2775
2890
  # id: "FieldId", # required
2776
2891
  # },
2777
2892
  # ],
2778
- # name: "FieldGroupNameString",
2779
2893
  # },
2780
2894
  # },
2781
2895
  # ],
2782
2896
  # },
2783
2897
  # },
2784
2898
  # },
2785
- # domain_id: "DomainId", # required
2786
- # layout_id: "LayoutId", # required
2787
- # name: "LayoutName",
2788
2899
  # })
2789
2900
  #
2790
2901
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/UpdateLayout AWS API Documentation
@@ -2820,22 +2931,28 @@ module Aws::ConnectCases
2820
2931
  # [3]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetTemplate.html
2821
2932
  # [4]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_ListTemplates.html
2822
2933
  #
2823
- # @option params [String] :description
2824
- # A brief description of the template.
2825
- #
2826
2934
  # @option params [required, String] :domain_id
2827
2935
  # The unique identifier of the Cases domain.
2828
2936
  #
2829
- # @option params [Types::LayoutConfiguration] :layout_configuration
2830
- # Configuration of layouts associated to the template.
2937
+ # @option params [required, String] :template_id
2938
+ # A unique identifier for the template.
2831
2939
  #
2832
2940
  # @option params [String] :name
2833
2941
  # The name of the template. It must be unique per domain.
2834
2942
  #
2943
+ # @option params [String] :description
2944
+ # A brief description of the template.
2945
+ #
2946
+ # @option params [Types::LayoutConfiguration] :layout_configuration
2947
+ # Configuration of layouts associated to the template.
2948
+ #
2835
2949
  # @option params [Array<Types::RequiredField>] :required_fields
2836
2950
  # A list of fields that must contain a value for a case to be
2837
2951
  # successfully created with this template.
2838
2952
  #
2953
+ # @option params [String] :status
2954
+ # The status of the template.
2955
+ #
2839
2956
  # @option params [Array<Types::TemplateRule>] :rules
2840
2957
  # A list of case rules (also known as [case field conditions][1]) on a
2841
2958
  # template.
@@ -2844,36 +2961,30 @@ module Aws::ConnectCases
2844
2961
  #
2845
2962
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html
2846
2963
  #
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
2964
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2854
2965
  #
2855
2966
  # @example Request syntax with placeholder values
2856
2967
  #
2857
2968
  # resp = client.update_template({
2858
- # description: "TemplateDescription",
2859
2969
  # domain_id: "DomainId", # required
2970
+ # template_id: "TemplateId", # required
2971
+ # name: "TemplateName",
2972
+ # description: "TemplateDescription",
2860
2973
  # layout_configuration: {
2861
2974
  # default_layout: "LayoutId",
2862
2975
  # },
2863
- # name: "TemplateName",
2864
2976
  # required_fields: [
2865
2977
  # {
2866
2978
  # field_id: "FieldId", # required
2867
2979
  # },
2868
2980
  # ],
2981
+ # status: "Active", # accepts Active, Inactive
2869
2982
  # rules: [
2870
2983
  # {
2871
2984
  # case_rule_id: "CaseRuleId", # required
2872
2985
  # field_id: "FieldId", # required
2873
2986
  # },
2874
2987
  # ],
2875
- # status: "Active", # accepts Active, Inactive
2876
- # template_id: "TemplateId", # required
2877
2988
  # })
2878
2989
  #
2879
2990
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/UpdateTemplate AWS API Documentation
@@ -2903,7 +3014,7 @@ module Aws::ConnectCases
2903
3014
  tracer: tracer
2904
3015
  )
2905
3016
  context[:gem_name] = 'aws-sdk-connectcases'
2906
- context[:gem_version] = '1.49.0'
3017
+ context[:gem_version] = '1.51.0'
2907
3018
  Seahorse::Client::Request.new(handlers, context)
2908
3019
  end
2909
3020