/
connectcases.jl
1207 lines (1088 loc) · 36.8 KB
/
connectcases.jl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: connectcases
using AWS.Compat
using AWS.UUIDs
"""
batch_get_field(domain_id, fields)
batch_get_field(domain_id, fields, params::Dict{String,<:Any})
Returns the description for the list of fields in the request parameters.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
- `fields`: A list of unique field identifiers.
"""
function batch_get_field(
domainId, fields; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"POST",
"/domains/$(domainId)/fields-batch",
Dict{String,Any}("fields" => fields);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_field(
domainId,
fields,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/fields-batch",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("fields" => fields), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_put_field_options(domain_id, field_id, options)
batch_put_field_options(domain_id, field_id, options, params::Dict{String,<:Any})
Creates and updates a set of field options for a single select field in a Cases domain.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
- `field_id`: The unique identifier of a field.
- `options`: A list of FieldOption objects.
"""
function batch_put_field_options(
domainId, fieldId, options; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"PUT",
"/domains/$(domainId)/fields/$(fieldId)/options",
Dict{String,Any}("options" => options);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_put_field_options(
domainId,
fieldId,
options,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"PUT",
"/domains/$(domainId)/fields/$(fieldId)/options",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("options" => options), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_case(domain_id, fields, template_id)
create_case(domain_id, fields, template_id, params::Dict{String,<:Any})
Creates a case in the specified Cases domain. Case system and custom fields are taken as an
array id/value pairs with a declared data types. The following fields are required when
creating a case: <ul> <li> <p> <code>customer_id</code> -
You must provide the full customer profile ARN in this format:
<code>arn:aws:profile:your AWS Region:your AWS account ID:domains/profiles domain
name/profiles/profile ID</code> </p> </li> <li> <p>
<code>title</code> </p> </li> </ul> </note>
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
- `fields`: An array of objects with field ID (matching ListFields/DescribeField) and value
union data.
- `template_id`: A unique identifier of a template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent APIs.
"""
function create_case(
domainId, fields, templateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"POST",
"/domains/$(domainId)/cases",
Dict{String,Any}(
"fields" => fields, "templateId" => templateId, "clientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_case(
domainId,
fields,
templateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/cases",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"fields" => fields,
"templateId" => templateId,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_domain(name)
create_domain(name, params::Dict{String,<:Any})
Creates a domain, which is a container for all case data, such as cases, fields, templates
and layouts. Each Amazon Connect instance can be associated with only one Cases domain.
This will not associate your connect instance to Cases domain. Instead, use the Amazon
Connect CreateIntegrationAssociation API. You need specific IAM permissions to successfully
associate the Cases domain. For more information, see Onboard to Cases.
# Arguments
- `name`: The name for your Cases domain. It must be unique for your Amazon Web Services
account.
"""
function create_domain(name; aws_config::AbstractAWSConfig=global_aws_config())
return connectcases(
"POST",
"/domains",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_domain(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"POST",
"/domains",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_field(domain_id, name, type)
create_field(domain_id, name, type, params::Dict{String,<:Any})
Creates a field in the Cases domain. This field is used to define the case object model
(that is, defines what data can be captured on cases) in a Cases domain.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
- `name`: The name of the field.
- `type`: Defines the data type, some system constraints, and default display of the field.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the field.
"""
function create_field(
domainId, name, type; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"POST",
"/domains/$(domainId)/fields",
Dict{String,Any}("name" => name, "type" => type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_field(
domainId,
name,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/fields",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("name" => name, "type" => type), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_layout(content, domain_id, name)
create_layout(content, domain_id, name, params::Dict{String,<:Any})
Creates a layout in the Cases domain. Layouts define the following configuration in the top
section and More Info tab of the Cases user interface: Fields to display to the users
Field ordering Title and Status fields cannot be part of layouts since they are not
configurable.
# Arguments
- `content`: Information about which fields will be present in the layout, and information
about the order of the fields.
- `domain_id`: The unique identifier of the Cases domain.
- `name`: The name of the layout. It must be unique for the Cases domain.
"""
function create_layout(
content, domainId, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"POST",
"/domains/$(domainId)/layouts",
Dict{String,Any}("content" => content, "name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_layout(
content,
domainId,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/layouts",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("content" => content, "name" => name), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_related_item(case_id, content, domain_id, type)
create_related_item(case_id, content, domain_id, type, params::Dict{String,<:Any})
Creates a related item (comments, tasks, and contacts) and associates it with a case. A
Related Item is a resource that is associated with a case. It may or may not have an
external identifier linking it to an external resource (for example, a contactArn). All
Related Items have their own internal identifier, the relatedItemArn. Examples of related
items include comments and contacts.
# Arguments
- `case_id`: A unique identifier of the case.
- `content`: The content of a related item to be created.
- `domain_id`: The unique identifier of the Cases domain.
- `type`: The type of a related item.
"""
function create_related_item(
caseId, content, domainId, type; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"POST",
"/domains/$(domainId)/cases/$(caseId)/related-items/",
Dict{String,Any}("content" => content, "type" => type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_related_item(
caseId,
content,
domainId,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/cases/$(caseId)/related-items/",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("content" => content, "type" => type), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_template(domain_id, name)
create_template(domain_id, name, params::Dict{String,<:Any})
Creates a template in the Cases domain. This template is used to define the case object
model (that is, to define what data can be captured on cases) in a Cases domain. A template
must have a unique name within a domain, and it must reference existing field IDs and
layout IDs. Additionally, multiple fields with same IDs are not allowed within the same
Template. A template can be either Active or Inactive, as indicated by its status. Inactive
templates cannot be used to create cases.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
- `name`: A name for the template. It must be unique per domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A brief description of the template.
- `"layoutConfiguration"`: Configuration of layouts associated to the template.
- `"requiredFields"`: A list of fields that must contain a value for a case to be
successfully created with this template.
- `"status"`: The status of the template.
"""
function create_template(domainId, name; aws_config::AbstractAWSConfig=global_aws_config())
return connectcases(
"POST",
"/domains/$(domainId)/templates",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_template(
domainId,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/templates",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_domain(domain_id)
delete_domain(domain_id, params::Dict{String,<:Any})
Deletes a domain.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
"""
function delete_domain(domainId; aws_config::AbstractAWSConfig=global_aws_config())
return connectcases(
"DELETE",
"/domains/$(domainId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_domain(
domainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"DELETE",
"/domains/$(domainId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_case(case_id, domain_id, fields)
get_case(case_id, domain_id, fields, params::Dict{String,<:Any})
Returns information about a specific case if it exists.
# Arguments
- `case_id`: A unique identifier of the case.
- `domain_id`: The unique identifier of the Cases domain.
- `fields`: A list of unique field identifiers.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function get_case(
caseId, domainId, fields; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"POST",
"/domains/$(domainId)/cases/$(caseId)",
Dict{String,Any}("fields" => fields);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_case(
caseId,
domainId,
fields,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/cases/$(caseId)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("fields" => fields), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_case_event_configuration(domain_id)
get_case_event_configuration(domain_id, params::Dict{String,<:Any})
Returns the case event publishing configuration.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
"""
function get_case_event_configuration(
domainId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"POST",
"/domains/$(domainId)/case-event-configuration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_case_event_configuration(
domainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/case-event-configuration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_domain(domain_id)
get_domain(domain_id, params::Dict{String,<:Any})
Returns information about a specific domain if it exists.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
"""
function get_domain(domainId; aws_config::AbstractAWSConfig=global_aws_config())
return connectcases(
"POST",
"/domains/$(domainId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_domain(
domainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_layout(domain_id, layout_id)
get_layout(domain_id, layout_id, params::Dict{String,<:Any})
Returns the details for the requested layout.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
- `layout_id`: The unique identifier of the layout.
"""
function get_layout(domainId, layoutId; aws_config::AbstractAWSConfig=global_aws_config())
return connectcases(
"POST",
"/domains/$(domainId)/layouts/$(layoutId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_layout(
domainId,
layoutId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/layouts/$(layoutId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_template(domain_id, template_id)
get_template(domain_id, template_id, params::Dict{String,<:Any})
Returns the details for the requested template.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
- `template_id`: A unique identifier of a template.
"""
function get_template(
domainId, templateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"POST",
"/domains/$(domainId)/templates/$(templateId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_template(
domainId,
templateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/templates/$(templateId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_cases_for_contact(contact_arn, domain_id)
list_cases_for_contact(contact_arn, domain_id, params::Dict{String,<:Any})
Lists cases for a given contact.
# Arguments
- `contact_arn`: A unique identifier of a contact in Amazon Connect.
- `domain_id`: The unique identifier of the Cases domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return per page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_cases_for_contact(
contactArn, domainId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"POST",
"/domains/$(domainId)/list-cases-for-contact",
Dict{String,Any}("contactArn" => contactArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_cases_for_contact(
contactArn,
domainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/list-cases-for-contact",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("contactArn" => contactArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_domains()
list_domains(params::Dict{String,<:Any})
Lists all cases domains in the Amazon Web Services account. Each list item is a condensed
summary object of the domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return per page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_domains(; aws_config::AbstractAWSConfig=global_aws_config())
return connectcases(
"POST", "/domains-list"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_domains(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"POST",
"/domains-list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_field_options(domain_id, field_id)
list_field_options(domain_id, field_id, params::Dict{String,<:Any})
Lists all of the field options for a field identifier in the domain.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
- `field_id`: The unique identifier of a field.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return per page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
- `"values"`: A list of FieldOption values to filter on for ListFieldOptions.
"""
function list_field_options(
domainId, fieldId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"POST",
"/domains/$(domainId)/fields/$(fieldId)/options-list";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_field_options(
domainId,
fieldId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/fields/$(fieldId)/options-list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_fields(domain_id)
list_fields(domain_id, params::Dict{String,<:Any})
Lists all fields in a Cases domain.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return per page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_fields(domainId; aws_config::AbstractAWSConfig=global_aws_config())
return connectcases(
"POST",
"/domains/$(domainId)/fields-list";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_fields(
domainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/fields-list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_layouts(domain_id)
list_layouts(domain_id, params::Dict{String,<:Any})
Lists all layouts in the given cases domain. Each list item is a condensed summary object
of the layout.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return per page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_layouts(domainId; aws_config::AbstractAWSConfig=global_aws_config())
return connectcases(
"POST",
"/domains/$(domainId)/layouts-list";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_layouts(
domainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/layouts-list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(arn)
list_tags_for_resource(arn, params::Dict{String,<:Any})
Lists tags for a resource.
# Arguments
- `arn`: The Amazon Resource Name (ARN)
"""
function list_tags_for_resource(arn; aws_config::AbstractAWSConfig=global_aws_config())
return connectcases(
"GET", "/tags/$(arn)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_tags_for_resource(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"GET",
"/tags/$(arn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_templates(domain_id)
list_templates(domain_id, params::Dict{String,<:Any})
Lists all of the templates in a Cases domain. Each list item is a condensed summary object
of the template.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return per page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
- `"status"`: A list of status values to filter on.
"""
function list_templates(domainId; aws_config::AbstractAWSConfig=global_aws_config())
return connectcases(
"POST",
"/domains/$(domainId)/templates-list";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_templates(
domainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/templates-list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_case_event_configuration(domain_id, event_bridge)
put_case_event_configuration(domain_id, event_bridge, params::Dict{String,<:Any})
API for adding case event publishing configuration
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
- `event_bridge`: Configuration to enable EventBridge case event delivery and determine
what data is delivered.
"""
function put_case_event_configuration(
domainId, eventBridge; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"PUT",
"/domains/$(domainId)/case-event-configuration",
Dict{String,Any}("eventBridge" => eventBridge);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_case_event_configuration(
domainId,
eventBridge,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"PUT",
"/domains/$(domainId)/case-event-configuration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("eventBridge" => eventBridge), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_cases(domain_id)
search_cases(domain_id, params::Dict{String,<:Any})
Searches for cases within their associated Cases domain. Search results are returned as a
paginated list of abridged case documents. For customer_id you must provide the full
customer profile ARN in this format: arn:aws:profile:your AWS Region:your AWS account
ID:domains/profiles domain name/profiles/profile ID.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"fields"`: The list of field identifiers to be returned as part of the response.
- `"filter"`: A list of filter objects.
- `"maxResults"`: The maximum number of cases to return. The current maximum supported
value is 25. This is also the default value when no other value is provided.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
- `"searchTerm"`: A word or phrase used to perform a quick search.
- `"sorts"`: A list of sorts where each sort specifies a field and their sort order to be
applied to the results.
"""
function search_cases(domainId; aws_config::AbstractAWSConfig=global_aws_config())
return connectcases(
"POST",
"/domains/$(domainId)/cases-search";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_cases(
domainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/cases-search",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_related_items(case_id, domain_id)
search_related_items(case_id, domain_id, params::Dict{String,<:Any})
Searches for related items that are associated with a case. If no filters are provided,
this returns all related items associated with a case.
# Arguments
- `case_id`: A unique identifier of the case.
- `domain_id`: The unique identifier of the Cases domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: The list of types of related items and their parameters to use for filtering.
- `"maxResults"`: The maximum number of results to return per page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function search_related_items(
caseId, domainId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"POST",
"/domains/$(domainId)/cases/$(caseId)/related-items-search";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_related_items(
caseId,
domainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/cases/$(caseId)/related-items-search",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(arn, tags)
tag_resource(arn, tags, params::Dict{String,<:Any})
Adds tags to a resource.
# Arguments
- `arn`: The Amazon Resource Name (ARN)
- `tags`: A map of of key-value pairs that represent tags on a resource. Tags are used to
organize, track, or control access for this resource.
"""
function tag_resource(arn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return connectcases(
"POST",
"/tags/$(arn)",
Dict{String,Any}("tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
arn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/tags/$(arn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)