aws-sdk-connectcases 1.79.0 → 1.80.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connectcases/client.rb +396 -47
- data/lib/aws-sdk-connectcases/client_api.rb +145 -0
- data/lib/aws-sdk-connectcases/types.rb +499 -66
- data/lib/aws-sdk-connectcases.rb +2 -2
- data/sig/client.rbs +62 -31
- data/sig/params.rbs +38 -0
- data/sig/types.rbs +110 -0
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 98bc66c7e7754b906226288e090125fae0f51f0ea1400f50a941dc67f020439b
|
|
4
|
+
data.tar.gz: 57fec9d4bbd78fa68425473e82ee8667fef3628e1735e3aead1da60b0a954320
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b637637f6378d243c1a3c3b5d18283fcfdeed01e8e463e0df6d258baf6037fafbc0e91fe402b8ee156dc67dee0ae8d3d1e6ac02af37e84510399f8b2e797fc14
|
|
7
|
+
data.tar.gz: f56b6cf7bee3fcbc0c3aa6f67d26e2a4c974fe7ccb622bf924eefb4338aed6b1b154ef45c418226122301c2727bfaef4e1565f6d4cf1a49f1adf15524fa54a5b
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.80.0 (2026-11-06)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - Amazon Connect Cases adds two Bulk Case Actions operations. BatchCreateRelatedItem adds a Comment-type related item to up to 100 cases per request, BatchUpdateCase updates fields (title, status, customer ID, custom) on up to 100 cases. Same domain, per-case success and failure results returned.
|
|
8
|
+
|
|
4
9
|
1.79.0 (2026-11-04)
|
|
5
10
|
------------------
|
|
6
11
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.80.0
|
|
@@ -481,9 +481,178 @@ module Aws::ConnectCases
|
|
|
481
481
|
|
|
482
482
|
# @!group API Operations
|
|
483
483
|
|
|
484
|
-
#
|
|
485
|
-
#
|
|
486
|
-
#
|
|
484
|
+
# Creates a comment and associates it with multiple cases in a single
|
|
485
|
+
# request. All cases must belong to the same domain. This operation
|
|
486
|
+
# supports only the Comment related item type.
|
|
487
|
+
#
|
|
488
|
+
# Each case is processed independently. If some cases fail, the
|
|
489
|
+
# remaining cases still receive the related item. To determine whether
|
|
490
|
+
# individual items failed, inspect the `failedItems` array in the
|
|
491
|
+
# response.
|
|
492
|
+
#
|
|
493
|
+
# The entire request fails, and no related items are created, in the
|
|
494
|
+
# following cases:
|
|
495
|
+
#
|
|
496
|
+
# * The specified domain doesn't exist.
|
|
497
|
+
#
|
|
498
|
+
# * A reference ID doesn't match any case in the domain.
|
|
499
|
+
#
|
|
500
|
+
# * The request contains duplicate case IDs.
|
|
501
|
+
#
|
|
502
|
+
# * The content isn't comment content.
|
|
503
|
+
#
|
|
504
|
+
# <note markdown="1"> This operation uses the same IAM action as [CreateRelatedItem][1]
|
|
505
|
+
# (`cases:CreateRelatedItem`). You can use the `cases:IsBatchAction`
|
|
506
|
+
# condition key in IAM policies to allow or deny batch operations
|
|
507
|
+
# independently from single-case operations.
|
|
508
|
+
#
|
|
509
|
+
# </note>
|
|
510
|
+
#
|
|
511
|
+
# <note markdown="1"> If you provide a value for `performedBy.userArn`, you must also have
|
|
512
|
+
# [DescribeUser][2] permission on the ARN of the user that you provide.
|
|
513
|
+
#
|
|
514
|
+
# </note>
|
|
515
|
+
#
|
|
516
|
+
# **Endpoints**: See [Connect Customer endpoints and quotas][3].
|
|
517
|
+
#
|
|
518
|
+
#
|
|
519
|
+
#
|
|
520
|
+
# [1]: https://docs.aws.amazon.com/cases/latest/APIReference/API_CreateRelatedItem.html
|
|
521
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html
|
|
522
|
+
# [3]: https://docs.aws.amazon.com/general/latest/gr/connect_region.html
|
|
523
|
+
#
|
|
524
|
+
# @option params [required, String] :domain_id
|
|
525
|
+
# The unique identifier of the Cases domain.
|
|
526
|
+
#
|
|
527
|
+
# @option params [required, Types::RelatedItemInputContent] :content
|
|
528
|
+
# The content of the related item to be created. The same content is
|
|
529
|
+
# applied to every case in the request. Only comment content is
|
|
530
|
+
# supported for batch creation.
|
|
531
|
+
#
|
|
532
|
+
# @option params [required, Array<Types::BatchCreateRelatedItemIdentifier>] :cases
|
|
533
|
+
# The list of cases to associate the related item with. All cases must
|
|
534
|
+
# belong to the same domain.
|
|
535
|
+
#
|
|
536
|
+
# @option params [Types::UserUnion] :performed_by
|
|
537
|
+
# The entity that created the related item.
|
|
538
|
+
#
|
|
539
|
+
# @option params [String] :client_token
|
|
540
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
541
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
|
542
|
+
# SDK populates this field. For more information about idempotency, see
|
|
543
|
+
# [Making retries safe with idempotent APIs][1].
|
|
544
|
+
#
|
|
545
|
+
# If you retry a request with the same client token, the service returns
|
|
546
|
+
# the original response instead of processing the request again. If you
|
|
547
|
+
# reuse a client token with different request parameters, the request
|
|
548
|
+
# fails with a `ConflictException`.
|
|
549
|
+
#
|
|
550
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
551
|
+
# not need to pass this option.**
|
|
552
|
+
#
|
|
553
|
+
#
|
|
554
|
+
#
|
|
555
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
556
|
+
#
|
|
557
|
+
# @return [Types::BatchCreateRelatedItemResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
558
|
+
#
|
|
559
|
+
# * {Types::BatchCreateRelatedItemResponse#successful_items #successful_items} => Array<Types::BatchCreateRelatedItemSuccessEntry>
|
|
560
|
+
# * {Types::BatchCreateRelatedItemResponse#failed_items #failed_items} => Array<Types::BatchCreateRelatedItemErrorEntry>
|
|
561
|
+
#
|
|
562
|
+
# @example Request syntax with placeholder values
|
|
563
|
+
#
|
|
564
|
+
# resp = client.batch_create_related_item({
|
|
565
|
+
# domain_id: "DomainId", # required
|
|
566
|
+
# content: { # required
|
|
567
|
+
# contact: {
|
|
568
|
+
# contact_arn: "ContactArn", # required
|
|
569
|
+
# },
|
|
570
|
+
# comment: {
|
|
571
|
+
# body: "CommentBody", # required
|
|
572
|
+
# content_type: "Text/Plain", # required, accepts Text/Plain
|
|
573
|
+
# },
|
|
574
|
+
# file: {
|
|
575
|
+
# file_arn: "FileArn", # required
|
|
576
|
+
# },
|
|
577
|
+
# sla: {
|
|
578
|
+
# sla_input_configuration: {
|
|
579
|
+
# name: "SlaName", # required
|
|
580
|
+
# type: "CaseField", # required, accepts CaseField
|
|
581
|
+
# field_id: "FieldId",
|
|
582
|
+
# target_field_values: [
|
|
583
|
+
# {
|
|
584
|
+
# string_value: "FieldValueUnionStringValueString",
|
|
585
|
+
# double_value: 1.0,
|
|
586
|
+
# boolean_value: false,
|
|
587
|
+
# empty_value: {
|
|
588
|
+
# },
|
|
589
|
+
# user_arn_value: "String",
|
|
590
|
+
# },
|
|
591
|
+
# ],
|
|
592
|
+
# target_sla_minutes: 1, # required
|
|
593
|
+
# },
|
|
594
|
+
# },
|
|
595
|
+
# connect_case: {
|
|
596
|
+
# case_id: "CaseId", # required
|
|
597
|
+
# },
|
|
598
|
+
# custom: {
|
|
599
|
+
# fields: [ # required
|
|
600
|
+
# {
|
|
601
|
+
# id: "FieldId", # required
|
|
602
|
+
# value: { # required
|
|
603
|
+
# string_value: "FieldValueUnionStringValueString",
|
|
604
|
+
# double_value: 1.0,
|
|
605
|
+
# boolean_value: false,
|
|
606
|
+
# empty_value: {
|
|
607
|
+
# },
|
|
608
|
+
# user_arn_value: "String",
|
|
609
|
+
# },
|
|
610
|
+
# },
|
|
611
|
+
# ],
|
|
612
|
+
# },
|
|
613
|
+
# },
|
|
614
|
+
# cases: [ # required
|
|
615
|
+
# {
|
|
616
|
+
# case_identifier: { # required
|
|
617
|
+
# case_id: "CaseId",
|
|
618
|
+
# reference_id: "ReferenceId",
|
|
619
|
+
# },
|
|
620
|
+
# },
|
|
621
|
+
# ],
|
|
622
|
+
# performed_by: {
|
|
623
|
+
# user_arn: "UserArn",
|
|
624
|
+
# custom_entity: "CustomEntity",
|
|
625
|
+
# },
|
|
626
|
+
# client_token: "BatchCreateRelatedItemRequestClientTokenString",
|
|
627
|
+
# })
|
|
628
|
+
#
|
|
629
|
+
# @example Response structure
|
|
630
|
+
#
|
|
631
|
+
# resp.successful_items #=> Array
|
|
632
|
+
# resp.successful_items[0].case_identifier.case_id #=> String
|
|
633
|
+
# resp.successful_items[0].case_identifier.reference_number #=> String
|
|
634
|
+
# resp.successful_items[0].case_identifier.reference_id #=> String
|
|
635
|
+
# resp.successful_items[0].related_item_id #=> String
|
|
636
|
+
# resp.successful_items[0].related_item_arn #=> String
|
|
637
|
+
# resp.failed_items #=> Array
|
|
638
|
+
# resp.failed_items[0].case_identifier.case_id #=> String
|
|
639
|
+
# resp.failed_items[0].case_identifier.reference_number #=> String
|
|
640
|
+
# resp.failed_items[0].case_identifier.reference_id #=> String
|
|
641
|
+
# resp.failed_items[0].error_code #=> String
|
|
642
|
+
# resp.failed_items[0].error_message #=> String
|
|
643
|
+
#
|
|
644
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/BatchCreateRelatedItem AWS API Documentation
|
|
645
|
+
#
|
|
646
|
+
# @overload batch_create_related_item(params = {})
|
|
647
|
+
# @param [Hash] params ({})
|
|
648
|
+
def batch_create_related_item(params = {}, options = {})
|
|
649
|
+
req = build_request(:batch_create_related_item, params)
|
|
650
|
+
req.send_request(options)
|
|
651
|
+
end
|
|
652
|
+
|
|
653
|
+
# Gets a batch of case rules. In the Connect Customer admin website,
|
|
654
|
+
# case rules are known as *case field conditions*. For more information
|
|
655
|
+
# about case field conditions, see [Add case field conditions to a case
|
|
487
656
|
# template][1].
|
|
488
657
|
#
|
|
489
658
|
#
|
|
@@ -675,10 +844,171 @@ module Aws::ConnectCases
|
|
|
675
844
|
req.send_request(options)
|
|
676
845
|
end
|
|
677
846
|
|
|
678
|
-
#
|
|
847
|
+
# Updates fields on multiple cases in a single request. All cases must
|
|
848
|
+
# belong to the same domain. Set the title, status, and customer ID
|
|
849
|
+
# through the top-level `title`, `status`, and `customerId` parameters,
|
|
850
|
+
# and set other fields through the `fields` array.
|
|
851
|
+
#
|
|
852
|
+
# Each case is processed independently. If some cases fail, the
|
|
853
|
+
# remaining cases are still updated. To determine whether individual
|
|
854
|
+
# cases failed, inspect the `failedCases` array in the response.
|
|
855
|
+
#
|
|
856
|
+
# The entire request fails, and no cases are updated, in the following
|
|
857
|
+
# cases:
|
|
858
|
+
#
|
|
859
|
+
# * The specified domain doesn't exist.
|
|
860
|
+
#
|
|
861
|
+
# * A reference ID doesn't match any case in the domain.
|
|
862
|
+
#
|
|
863
|
+
# * The request contains duplicate case IDs.
|
|
864
|
+
#
|
|
865
|
+
# * The request doesn't specify any update. Provide at least one entry
|
|
866
|
+
# in `fields`, or a `title`, `status`, or `customerId`.
|
|
867
|
+
#
|
|
868
|
+
# * A field identifier in `fields` doesn't resolve to a field in the
|
|
869
|
+
# domain, for example, an unknown field name.
|
|
870
|
+
#
|
|
871
|
+
# * A field name contains a pipe (`|`) or comma (`,`) character.
|
|
872
|
+
#
|
|
873
|
+
# * `fields` includes `title`, `status`, or `customerId`.
|
|
874
|
+
#
|
|
875
|
+
# <note markdown="1"> This operation uses the same IAM action as [UpdateCase][1]
|
|
876
|
+
# (`cases:UpdateCase`). You can use the `cases:IsBatchAction` condition
|
|
877
|
+
# key in IAM policies to allow or deny batch operations independently
|
|
878
|
+
# from single-case operations.
|
|
879
|
+
#
|
|
880
|
+
# </note>
|
|
881
|
+
#
|
|
882
|
+
# <note markdown="1"> If you provide a value for `performedBy.userArn`, you must also have
|
|
883
|
+
# [DescribeUser][2] permission on the ARN of the user that you provide.
|
|
884
|
+
#
|
|
885
|
+
# </note>
|
|
886
|
+
#
|
|
887
|
+
# **Endpoints**: See [Connect Customer endpoints and quotas][3].
|
|
888
|
+
#
|
|
889
|
+
#
|
|
890
|
+
#
|
|
891
|
+
# [1]: https://docs.aws.amazon.com/cases/latest/APIReference/API_UpdateCase.html
|
|
892
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html
|
|
893
|
+
# [3]: https://docs.aws.amazon.com/general/latest/gr/connect_region.html
|
|
894
|
+
#
|
|
895
|
+
# @option params [required, String] :domain_id
|
|
896
|
+
# The unique identifier of the Cases domain.
|
|
897
|
+
#
|
|
898
|
+
# @option params [required, Array<Types::BatchUpdateCaseIdentifier>] :cases
|
|
899
|
+
# The list of cases to update. All cases must belong to the same domain.
|
|
900
|
+
#
|
|
901
|
+
# @option params [required, Array<Types::FieldValueInput>] :fields
|
|
902
|
+
# An array of objects, each with a `fieldIdentifier` and a `value`. You
|
|
903
|
+
# can identify each field by its ID or by its name; identifying a field
|
|
904
|
+
# by name is supported only in `BatchUpdateCase`. The same field values
|
|
905
|
+
# are applied to every case in the request. This field must be present,
|
|
906
|
+
# but can be an empty list when you provide the top-level `title`,
|
|
907
|
+
# `status`, or `customerId` parameters. Do not include `title`,
|
|
908
|
+
# `status`, or `customerId` in this list; set those values only through
|
|
909
|
+
# their top-level parameters. Duplicating them in `fields` results in a
|
|
910
|
+
# validation error.
|
|
911
|
+
#
|
|
912
|
+
# @option params [Types::UserUnion] :performed_by
|
|
913
|
+
# The entity that performed the action.
|
|
914
|
+
#
|
|
915
|
+
# @option params [String] :title
|
|
916
|
+
# The title to apply to all cases in the request.
|
|
917
|
+
#
|
|
918
|
+
# @option params [String] :status
|
|
919
|
+
# The status to apply to all cases in the request.
|
|
920
|
+
#
|
|
921
|
+
# @option params [String] :customer_id
|
|
922
|
+
# The ARN of the customer profile to associate with all cases in the
|
|
923
|
+
# request.
|
|
924
|
+
#
|
|
925
|
+
# @option params [String] :client_token
|
|
926
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
927
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
|
928
|
+
# SDK populates this field. For more information about idempotency, see
|
|
929
|
+
# [Making retries safe with idempotent APIs][1].
|
|
930
|
+
#
|
|
931
|
+
# If you retry a request with the same client token, the service returns
|
|
932
|
+
# the original response instead of processing the request again. If you
|
|
933
|
+
# reuse a client token with different request parameters, the request
|
|
934
|
+
# fails with a `ConflictException`.
|
|
935
|
+
#
|
|
936
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
937
|
+
# not need to pass this option.**
|
|
938
|
+
#
|
|
939
|
+
#
|
|
940
|
+
#
|
|
941
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
942
|
+
#
|
|
943
|
+
# @return [Types::BatchUpdateCaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
944
|
+
#
|
|
945
|
+
# * {Types::BatchUpdateCaseResponse#successful_cases #successful_cases} => Array<Types::BatchUpdateCaseSuccessEntry>
|
|
946
|
+
# * {Types::BatchUpdateCaseResponse#failed_cases #failed_cases} => Array<Types::BatchUpdateCaseErrorEntry>
|
|
947
|
+
#
|
|
948
|
+
# @example Request syntax with placeholder values
|
|
949
|
+
#
|
|
950
|
+
# resp = client.batch_update_case({
|
|
951
|
+
# domain_id: "DomainId", # required
|
|
952
|
+
# cases: [ # required
|
|
953
|
+
# {
|
|
954
|
+
# case_identifier: { # required
|
|
955
|
+
# case_id: "CaseId",
|
|
956
|
+
# reference_id: "ReferenceId",
|
|
957
|
+
# },
|
|
958
|
+
# },
|
|
959
|
+
# ],
|
|
960
|
+
# fields: [ # required
|
|
961
|
+
# {
|
|
962
|
+
# field_identifier: { # required
|
|
963
|
+
# id: "FieldId",
|
|
964
|
+
# name: "FieldName",
|
|
965
|
+
# },
|
|
966
|
+
# value: { # required
|
|
967
|
+
# string_value: "FieldValueUnionStringValueString",
|
|
968
|
+
# double_value: 1.0,
|
|
969
|
+
# boolean_value: false,
|
|
970
|
+
# empty_value: {
|
|
971
|
+
# },
|
|
972
|
+
# user_arn_value: "String",
|
|
973
|
+
# },
|
|
974
|
+
# },
|
|
975
|
+
# ],
|
|
976
|
+
# performed_by: {
|
|
977
|
+
# user_arn: "UserArn",
|
|
978
|
+
# custom_entity: "CustomEntity",
|
|
979
|
+
# },
|
|
980
|
+
# title: "CaseTitle",
|
|
981
|
+
# status: "CaseStatus",
|
|
982
|
+
# customer_id: "CustomerProfileArn",
|
|
983
|
+
# client_token: "BatchUpdateCaseRequestClientTokenString",
|
|
984
|
+
# })
|
|
985
|
+
#
|
|
986
|
+
# @example Response structure
|
|
987
|
+
#
|
|
988
|
+
# resp.successful_cases #=> Array
|
|
989
|
+
# resp.successful_cases[0].case_identifier.case_id #=> String
|
|
990
|
+
# resp.successful_cases[0].case_identifier.reference_number #=> String
|
|
991
|
+
# resp.successful_cases[0].case_identifier.reference_id #=> String
|
|
992
|
+
# resp.failed_cases #=> Array
|
|
993
|
+
# resp.failed_cases[0].case_identifier.case_id #=> String
|
|
994
|
+
# resp.failed_cases[0].case_identifier.reference_number #=> String
|
|
995
|
+
# resp.failed_cases[0].case_identifier.reference_id #=> String
|
|
996
|
+
# resp.failed_cases[0].error_code #=> String
|
|
997
|
+
# resp.failed_cases[0].error_message #=> String
|
|
998
|
+
#
|
|
999
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/BatchUpdateCase AWS API Documentation
|
|
1000
|
+
#
|
|
1001
|
+
# @overload batch_update_case(params = {})
|
|
1002
|
+
# @param [Hash] params ({})
|
|
1003
|
+
def batch_update_case(params = {}, options = {})
|
|
1004
|
+
req = build_request(:batch_update_case, params)
|
|
1005
|
+
req.send_request(options)
|
|
1006
|
+
end
|
|
1007
|
+
|
|
1008
|
+
# <note markdown="1"> If you provide a value for `PerformedBy.UserArn`,
|
|
679
1009
|
# you must also have
|
|
680
|
-
# [connect:DescribeUser][1] permission on the
|
|
681
|
-
# provide
|
|
1010
|
+
# the [connect:DescribeUser][1] permission on the user ARN that you
|
|
1011
|
+
# provide.
|
|
682
1012
|
#
|
|
683
1013
|
# </note>
|
|
684
1014
|
#
|
|
@@ -690,13 +1020,24 @@ module Aws::ConnectCases
|
|
|
690
1020
|
# configurations, the specified tags are automatically applied to the
|
|
691
1021
|
# case.
|
|
692
1022
|
#
|
|
693
|
-
# The following
|
|
1023
|
+
# The following field is always required when creating a case:
|
|
1024
|
+
#
|
|
1025
|
+
# * `title`
|
|
694
1026
|
#
|
|
695
|
-
#
|
|
696
|
-
# this format: `arn:aws:profile:your_AWS_Region:your_AWS_account
|
|
697
|
-
# ID:domains/your_profiles_domain_name/profiles/profile_ID`
|
|
1027
|
+
# ^
|
|
698
1028
|
#
|
|
699
|
-
#
|
|
1029
|
+
# The following field may be required depending on the template
|
|
1030
|
+
# configuration:
|
|
1031
|
+
#
|
|
1032
|
+
# * `customer_id` - Required only if the template's `requiredFields`
|
|
1033
|
+
# list includes `customer_id`. When required, provide the full
|
|
1034
|
+
# customer profile ARN in this format:
|
|
1035
|
+
#
|
|
1036
|
+
# `arn:aws:profile:your_AWS_Region:your_AWS_account_ID:domains/your_profiles_domain_name/profiles/profile_ID`.
|
|
1037
|
+
# When not required, the field is optional and can be omitted, added,
|
|
1038
|
+
# changed, or removed after case creation.
|
|
1039
|
+
#
|
|
1040
|
+
# ^
|
|
700
1041
|
#
|
|
701
1042
|
#
|
|
702
1043
|
#
|
|
@@ -729,8 +1070,8 @@ module Aws::ConnectCases
|
|
|
729
1070
|
# Represents the entity that performed the action.
|
|
730
1071
|
#
|
|
731
1072
|
# @option params [Hash<String,String>] :tags
|
|
732
|
-
# A map of
|
|
733
|
-
#
|
|
1073
|
+
# A map of key-value pairs that represent tags on a resource. Tags are
|
|
1074
|
+
# used to organize, track, or control access for this resource.
|
|
734
1075
|
#
|
|
735
1076
|
# @return [Types::CreateCaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
736
1077
|
#
|
|
@@ -779,7 +1120,7 @@ module Aws::ConnectCases
|
|
|
779
1120
|
req.send_request(options)
|
|
780
1121
|
end
|
|
781
1122
|
|
|
782
|
-
# Creates a new case rule. In the
|
|
1123
|
+
# Creates a new case rule. In the Connect Customer admin website, case
|
|
783
1124
|
# rules are known as *case field conditions*. For more information about
|
|
784
1125
|
# case field conditions, see [Add case field conditions to a case
|
|
785
1126
|
# template][1].
|
|
@@ -926,13 +1267,13 @@ module Aws::ConnectCases
|
|
|
926
1267
|
end
|
|
927
1268
|
|
|
928
1269
|
# Creates a domain, which is a container for all case data, such as
|
|
929
|
-
# cases, fields, templates and layouts. Each
|
|
930
|
-
# be associated with only one Cases domain.
|
|
1270
|
+
# cases, fields, templates and layouts. Each Connect Customer instance
|
|
1271
|
+
# can be associated with only one Cases domain.
|
|
931
1272
|
#
|
|
932
1273
|
# This will not associate your connect instance to Cases domain.
|
|
933
|
-
# Instead, use the
|
|
934
|
-
# You need specific IAM permissions to successfully associate the
|
|
935
|
-
# domain. For more information, see [Onboard to Cases][2].
|
|
1274
|
+
# Instead, use the Connect Customer [CreateIntegrationAssociation][1]
|
|
1275
|
+
# API. You need specific IAM permissions to successfully associate the
|
|
1276
|
+
# Cases domain. For more information, see [Onboard to Cases][2].
|
|
936
1277
|
#
|
|
937
1278
|
#
|
|
938
1279
|
#
|
|
@@ -1108,7 +1449,7 @@ module Aws::ConnectCases
|
|
|
1108
1449
|
# it with a case.
|
|
1109
1450
|
#
|
|
1110
1451
|
# There's a quota for the number of fields allowed in a Custom type
|
|
1111
|
-
# related item. See [
|
|
1452
|
+
# related item. See [Connect Customer Cases quotas][1].
|
|
1112
1453
|
#
|
|
1113
1454
|
# **Use cases**
|
|
1114
1455
|
#
|
|
@@ -1121,7 +1462,7 @@ module Aws::ConnectCases
|
|
|
1121
1462
|
#
|
|
1122
1463
|
# * SLAs, to capture target resolution goals
|
|
1123
1464
|
#
|
|
1124
|
-
# * Cases, to capture related
|
|
1465
|
+
# * Cases, to capture related Connect Customer Cases
|
|
1125
1466
|
#
|
|
1126
1467
|
# * Files, such as policy documentation or customer-provided attachments
|
|
1127
1468
|
#
|
|
@@ -1141,13 +1482,11 @@ module Aws::ConnectCases
|
|
|
1141
1482
|
# own internal identifier, the `relatedItemArn`. Examples of related
|
|
1142
1483
|
# items include `comments` and `contacts`.
|
|
1143
1484
|
#
|
|
1144
|
-
# * If you provide a value for `performedBy.userArn
|
|
1485
|
+
# * If you provide a value for `performedBy.userArn`, you must also have
|
|
1145
1486
|
# [DescribeUser][3] permission on the ARN of the user that you
|
|
1146
1487
|
# provide.
|
|
1147
1488
|
#
|
|
1148
|
-
#
|
|
1149
|
-
#
|
|
1150
|
-
# **Endpoints**: See [Amazon Connect endpoints and quotas][4].
|
|
1489
|
+
# **Endpoints**: See [Connect Customer endpoints and quotas][4].
|
|
1151
1490
|
#
|
|
1152
1491
|
#
|
|
1153
1492
|
#
|
|
@@ -1292,6 +1631,11 @@ module Aws::ConnectCases
|
|
|
1292
1631
|
# A list of fields that must contain a value for a case to be
|
|
1293
1632
|
# successfully created with this template.
|
|
1294
1633
|
#
|
|
1634
|
+
# To require a Customer Profile when creating cases, include
|
|
1635
|
+
# `customer_id` in this list. If `customer_id` is omitted, the Customer
|
|
1636
|
+
# Profile field is optional and can be added, changed, or removed after
|
|
1637
|
+
# case creation.
|
|
1638
|
+
#
|
|
1295
1639
|
# @option params [String] :status
|
|
1296
1640
|
# The status of the template.
|
|
1297
1641
|
#
|
|
@@ -1395,7 +1739,7 @@ module Aws::ConnectCases
|
|
|
1395
1739
|
req.send_request(options)
|
|
1396
1740
|
end
|
|
1397
1741
|
|
|
1398
|
-
# Deletes a case rule. In the
|
|
1742
|
+
# Deletes a case rule. In the Connect Customer admin website, case rules
|
|
1399
1743
|
# are known as *case field conditions*. For more information about case
|
|
1400
1744
|
# field conditions, see [Add case field conditions to a case
|
|
1401
1745
|
# template][1].
|
|
@@ -1431,8 +1775,8 @@ module Aws::ConnectCases
|
|
|
1431
1775
|
# Deletes a Cases domain.
|
|
1432
1776
|
#
|
|
1433
1777
|
# <note markdown="1"> After deleting your domain you must disassociate the deleted domain
|
|
1434
|
-
# from your
|
|
1435
|
-
# able to use Cases again with this
|
|
1778
|
+
# from your Connect Customer instance with another API call before being
|
|
1779
|
+
# able to use Cases again with this Connect Customer instance. See
|
|
1436
1780
|
# [DeleteIntegrationAssociation][1].
|
|
1437
1781
|
#
|
|
1438
1782
|
# </note>
|
|
@@ -1461,7 +1805,7 @@ module Aws::ConnectCases
|
|
|
1461
1805
|
req.send_request(options)
|
|
1462
1806
|
end
|
|
1463
1807
|
|
|
1464
|
-
# Deletes a field from a
|
|
1808
|
+
# Deletes a field from a Cases template.
|
|
1465
1809
|
#
|
|
1466
1810
|
# After a field is deleted:
|
|
1467
1811
|
#
|
|
@@ -1525,7 +1869,7 @@ module Aws::ConnectCases
|
|
|
1525
1869
|
req.send_request(options)
|
|
1526
1870
|
end
|
|
1527
1871
|
|
|
1528
|
-
# Deletes a layout from a
|
|
1872
|
+
# Deletes a layout from a Cases template. You can delete up to 100
|
|
1529
1873
|
# layouts per domain.
|
|
1530
1874
|
#
|
|
1531
1875
|
# After a layout is deleted:
|
|
@@ -1600,10 +1944,10 @@ module Aws::ConnectCases
|
|
|
1600
1944
|
req.send_request(options)
|
|
1601
1945
|
end
|
|
1602
1946
|
|
|
1603
|
-
# Deletes a
|
|
1947
|
+
# Deletes a Cases template. You can delete up to 100 templates per
|
|
1604
1948
|
# domain.
|
|
1605
1949
|
#
|
|
1606
|
-
# After a
|
|
1950
|
+
# After a Cases template is deleted:
|
|
1607
1951
|
#
|
|
1608
1952
|
# * You can still retrieve the template by calling `GetTemplate`.
|
|
1609
1953
|
#
|
|
@@ -1964,7 +2308,7 @@ module Aws::ConnectCases
|
|
|
1964
2308
|
req.send_request(options)
|
|
1965
2309
|
end
|
|
1966
2310
|
|
|
1967
|
-
# Lists all case rules in a Cases domain. In the
|
|
2311
|
+
# Lists all case rules in a Cases domain. In the Connect Customer admin
|
|
1968
2312
|
# website, case rules are known as *case field conditions*. For more
|
|
1969
2313
|
# information about case field conditions, see [Add case field
|
|
1970
2314
|
# conditions to a case template][1].
|
|
@@ -2024,7 +2368,7 @@ module Aws::ConnectCases
|
|
|
2024
2368
|
# The unique identifier of the Cases domain.
|
|
2025
2369
|
#
|
|
2026
2370
|
# @option params [required, String] :contact_arn
|
|
2027
|
-
# A unique identifier of a contact in
|
|
2371
|
+
# A unique identifier of a contact in Connect Customer.
|
|
2028
2372
|
#
|
|
2029
2373
|
# @option params [Integer] :max_results
|
|
2030
2374
|
# The maximum number of results to return per page.
|
|
@@ -2358,7 +2702,7 @@ module Aws::ConnectCases
|
|
|
2358
2702
|
|
|
2359
2703
|
# Adds case event publishing configuration. For a complete list of
|
|
2360
2704
|
# fields you can add to the event message, see [Create case fields][1]
|
|
2361
|
-
# in the *
|
|
2705
|
+
# in the *Connect Customer Administrator Guide*.
|
|
2362
2706
|
#
|
|
2363
2707
|
#
|
|
2364
2708
|
#
|
|
@@ -2431,7 +2775,7 @@ module Aws::ConnectCases
|
|
|
2431
2775
|
# * This API searches across related items content, not case fields. Use
|
|
2432
2776
|
# the [SearchCases][3] API to search within case field values.
|
|
2433
2777
|
#
|
|
2434
|
-
# **Endpoints**: See [
|
|
2778
|
+
# **Endpoints**: See [Connect Customer endpoints and quotas][4].
|
|
2435
2779
|
#
|
|
2436
2780
|
#
|
|
2437
2781
|
#
|
|
@@ -3007,8 +3351,8 @@ module Aws::ConnectCases
|
|
|
3007
3351
|
# The Amazon Resource Name (ARN)
|
|
3008
3352
|
#
|
|
3009
3353
|
# @option params [required, Hash<String,String>] :tags
|
|
3010
|
-
# A map of
|
|
3011
|
-
#
|
|
3354
|
+
# A map of key-value pairs that represent tags on a resource. Tags are
|
|
3355
|
+
# used to organize, track, or control access for this resource.
|
|
3012
3356
|
#
|
|
3013
3357
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
3014
3358
|
#
|
|
@@ -3056,16 +3400,16 @@ module Aws::ConnectCases
|
|
|
3056
3400
|
req.send_request(options)
|
|
3057
3401
|
end
|
|
3058
3402
|
|
|
3059
|
-
# <note markdown="1"> If you provide a value for `PerformedBy.UserArn
|
|
3403
|
+
# <note markdown="1"> If you provide a value for `PerformedBy.UserArn`,
|
|
3060
3404
|
# you must also have
|
|
3061
|
-
# [connect:DescribeUser][1] permission on the
|
|
3062
|
-
# provide
|
|
3405
|
+
# the [connect:DescribeUser][1] permission on the user ARN that you
|
|
3406
|
+
# provide.
|
|
3063
3407
|
#
|
|
3064
3408
|
# </note>
|
|
3065
3409
|
#
|
|
3066
3410
|
# Updates the values of fields on a case. Fields to be updated are
|
|
3067
3411
|
# received as an array of id/value pairs identical to the `CreateCase`
|
|
3068
|
-
# input
|
|
3412
|
+
# input.
|
|
3069
3413
|
#
|
|
3070
3414
|
# If the action is successful, the service sends back an HTTP 200
|
|
3071
3415
|
# response with an empty HTTP body.
|
|
@@ -3122,7 +3466,7 @@ module Aws::ConnectCases
|
|
|
3122
3466
|
req.send_request(options)
|
|
3123
3467
|
end
|
|
3124
3468
|
|
|
3125
|
-
# Updates a case rule. In the
|
|
3469
|
+
# Updates a case rule. In the Connect Customer admin website, case rules
|
|
3126
3470
|
# are known as *case field conditions*. For more information about case
|
|
3127
3471
|
# field conditions, see [Add case field conditions to a case
|
|
3128
3472
|
# template][1].
|
|
@@ -3391,7 +3735,7 @@ module Aws::ConnectCases
|
|
|
3391
3735
|
# * **Custom** - Update the fields of a custom related item. You can
|
|
3392
3736
|
# add, modify, and remove fields from a custom related item. There's
|
|
3393
3737
|
# a quota for the number of fields allowed in a Custom type related
|
|
3394
|
-
# item. See [
|
|
3738
|
+
# item. See [Connect Customer Cases quotas][1].
|
|
3395
3739
|
#
|
|
3396
3740
|
# **Important things to know**
|
|
3397
3741
|
#
|
|
@@ -3399,13 +3743,13 @@ module Aws::ConnectCases
|
|
|
3399
3743
|
# and their associated values should be included in the request.
|
|
3400
3744
|
# Fields not included as part of this request will be removed.
|
|
3401
3745
|
#
|
|
3402
|
-
# * If you provide a value for `performedBy.userArn
|
|
3746
|
+
# * If you provide a value for `performedBy.userArn`, you must also have
|
|
3403
3747
|
# [DescribeUser][2] permission on the ARN of the user that you
|
|
3404
3748
|
# provide.
|
|
3405
3749
|
#
|
|
3406
3750
|
# * [System case fields][3] cannot be used in a custom related item.
|
|
3407
3751
|
#
|
|
3408
|
-
# **Endpoints**: See [
|
|
3752
|
+
# **Endpoints**: See [Connect Customer endpoints and quotas][4].
|
|
3409
3753
|
#
|
|
3410
3754
|
#
|
|
3411
3755
|
#
|
|
@@ -3562,6 +3906,11 @@ module Aws::ConnectCases
|
|
|
3562
3906
|
# A list of fields that must contain a value for a case to be
|
|
3563
3907
|
# successfully created with this template.
|
|
3564
3908
|
#
|
|
3909
|
+
# To require a Customer Profile when creating cases, include
|
|
3910
|
+
# `customer_id` in this list. If `customer_id` is omitted, the Customer
|
|
3911
|
+
# Profile field is optional and can be added, changed, or removed after
|
|
3912
|
+
# case creation.
|
|
3913
|
+
#
|
|
3565
3914
|
# @option params [String] :status
|
|
3566
3915
|
# The status of the template.
|
|
3567
3916
|
#
|
|
@@ -3639,7 +3988,7 @@ module Aws::ConnectCases
|
|
|
3639
3988
|
tracer: tracer
|
|
3640
3989
|
)
|
|
3641
3990
|
context[:gem_name] = 'aws-sdk-connectcases'
|
|
3642
|
-
context[:gem_version] = '1.
|
|
3991
|
+
context[:gem_version] = '1.80.0'
|
|
3643
3992
|
Seahorse::Client::Request.new(handlers, context)
|
|
3644
3993
|
end
|
|
3645
3994
|
|