aws-sdk-connectcases 1.18.0 → 1.20.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.
@@ -23,6 +23,144 @@ module Aws::ConnectCases
23
23
  include Aws::Structure
24
24
  end
25
25
 
26
+ # Represents the content of a particular audit event.
27
+ #
28
+ # @!attribute [rw] event_id
29
+ # Unique identifier of a case audit history event.
30
+ # @return [String]
31
+ #
32
+ # @!attribute [rw] fields
33
+ # A list of Case Audit History event fields.
34
+ # @return [Array<Types::AuditEventField>]
35
+ #
36
+ # @!attribute [rw] performed_by
37
+ # Information of the user which performed the audit.
38
+ # @return [Types::AuditEventPerformedBy]
39
+ #
40
+ # @!attribute [rw] performed_time
41
+ # Time at which an Audit History event took place.
42
+ # @return [Time]
43
+ #
44
+ # @!attribute [rw] related_item_type
45
+ # The Type of the related item.
46
+ # @return [String]
47
+ #
48
+ # @!attribute [rw] type
49
+ # The Type of an audit history event.
50
+ # @return [String]
51
+ #
52
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/AuditEvent AWS API Documentation
53
+ #
54
+ class AuditEvent < Struct.new(
55
+ :event_id,
56
+ :fields,
57
+ :performed_by,
58
+ :performed_time,
59
+ :related_item_type,
60
+ :type)
61
+ SENSITIVE = []
62
+ include Aws::Structure
63
+ end
64
+
65
+ # Fields for audit event.
66
+ #
67
+ # @!attribute [rw] event_field_id
68
+ # Unique identifier of field in an Audit History entry.
69
+ # @return [String]
70
+ #
71
+ # @!attribute [rw] new_value
72
+ # Union of potential field value types.
73
+ # @return [Types::AuditEventFieldValueUnion]
74
+ #
75
+ # @!attribute [rw] old_value
76
+ # Union of potential field value types.
77
+ # @return [Types::AuditEventFieldValueUnion]
78
+ #
79
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/AuditEventField AWS API Documentation
80
+ #
81
+ class AuditEventField < Struct.new(
82
+ :event_field_id,
83
+ :new_value,
84
+ :old_value)
85
+ SENSITIVE = []
86
+ include Aws::Structure
87
+ end
88
+
89
+ # Object to store union of Field values.
90
+ #
91
+ # This data type is a UNION, so only one of the following members can be
92
+ # specified when used or returned.
93
+ #
94
+ # @note AuditEventFieldValueUnion is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of AuditEventFieldValueUnion corresponding to the set member.
95
+ #
96
+ # @!attribute [rw] boolean_value
97
+ # Can be either null, or have a Boolean value type. Only one value can
98
+ # be provided.
99
+ # @return [Boolean]
100
+ #
101
+ # @!attribute [rw] double_value
102
+ # Can be either null, or have a Double value type. Only one value can
103
+ # be provided.
104
+ # @return [Float]
105
+ #
106
+ # @!attribute [rw] empty_value
107
+ # An empty value. You cannot set `EmptyFieldValue` on a field that is
108
+ # required on a case template.
109
+ #
110
+ # This structure will never have any data members. It signifies an
111
+ # empty value on a case field.
112
+ # @return [Types::EmptyFieldValue]
113
+ #
114
+ # @!attribute [rw] string_value
115
+ # Can be either null, or have a String value type. Only one value can
116
+ # be provided.
117
+ # @return [String]
118
+ #
119
+ # @!attribute [rw] user_arn_value
120
+ # Can be either null, or have a String value type formatted as an ARN.
121
+ # Only one value can be provided.
122
+ # @return [String]
123
+ #
124
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/AuditEventFieldValueUnion AWS API Documentation
125
+ #
126
+ class AuditEventFieldValueUnion < Struct.new(
127
+ :boolean_value,
128
+ :double_value,
129
+ :empty_value,
130
+ :string_value,
131
+ :user_arn_value,
132
+ :unknown)
133
+ SENSITIVE = []
134
+ include Aws::Structure
135
+ include Aws::Structure::Union
136
+
137
+ class BooleanValue < AuditEventFieldValueUnion; end
138
+ class DoubleValue < AuditEventFieldValueUnion; end
139
+ class EmptyValue < AuditEventFieldValueUnion; end
140
+ class StringValue < AuditEventFieldValueUnion; end
141
+ class UserArnValue < AuditEventFieldValueUnion; end
142
+ class Unknown < AuditEventFieldValueUnion; end
143
+ end
144
+
145
+ # Information of the user which performed the audit.
146
+ #
147
+ # @!attribute [rw] iam_principal_arn
148
+ # Unique identifier of an IAM role.
149
+ # @return [String]
150
+ #
151
+ # @!attribute [rw] user
152
+ # Represents the identity of the person who performed the action.
153
+ # @return [Types::UserUnion]
154
+ #
155
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/AuditEventPerformedBy AWS API Documentation
156
+ #
157
+ class AuditEventPerformedBy < Struct.new(
158
+ :iam_principal_arn,
159
+ :user)
160
+ SENSITIVE = []
161
+ include Aws::Structure
162
+ end
163
+
26
164
  # Content specific to `BasicLayout` type. It configures fields in the
27
165
  # top panel and More Info tab of agent application.
28
166
  #
@@ -308,6 +446,10 @@ module Aws::ConnectCases
308
446
  # ListFields/DescribeField) and value union data.
309
447
  # @return [Array<Types::FieldValue>]
310
448
  #
449
+ # @!attribute [rw] performed_by
450
+ # Represents the identity of the person who performed the action.
451
+ # @return [Types::UserUnion]
452
+ #
311
453
  # @!attribute [rw] template_id
312
454
  # A unique identifier of a template.
313
455
  # @return [String]
@@ -318,6 +460,7 @@ module Aws::ConnectCases
318
460
  :client_token,
319
461
  :domain_id,
320
462
  :fields,
463
+ :performed_by,
321
464
  :template_id)
322
465
  SENSITIVE = []
323
466
  include Aws::Structure
@@ -886,6 +1029,11 @@ module Aws::ConnectCases
886
1029
 
887
1030
  # Object to store union of Field values.
888
1031
  #
1032
+ # <note markdown="1"> The `Summary` system field accepts 1500 characters while all other
1033
+ # fields accept 500 characters.
1034
+ #
1035
+ # </note>
1036
+ #
889
1037
  # @note FieldValueUnion is a union - when making an API calls you must set exactly one of the members.
890
1038
  #
891
1039
  # @note FieldValueUnion is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of FieldValueUnion corresponding to the set member.
@@ -908,6 +1056,10 @@ module Aws::ConnectCases
908
1056
  # String value type.
909
1057
  # @return [String]
910
1058
  #
1059
+ # @!attribute [rw] user_arn_value
1060
+ # Represents the user that performed the audit.
1061
+ # @return [String]
1062
+ #
911
1063
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/FieldValueUnion AWS API Documentation
912
1064
  #
913
1065
  class FieldValueUnion < Struct.new(
@@ -915,6 +1067,7 @@ module Aws::ConnectCases
915
1067
  :double_value,
916
1068
  :empty_value,
917
1069
  :string_value,
1070
+ :user_arn_value,
918
1071
  :unknown)
919
1072
  SENSITIVE = []
920
1073
  include Aws::Structure
@@ -924,9 +1077,60 @@ module Aws::ConnectCases
924
1077
  class DoubleValue < FieldValueUnion; end
925
1078
  class EmptyValue < FieldValueUnion; end
926
1079
  class StringValue < FieldValueUnion; end
1080
+ class UserArnValue < FieldValueUnion; end
927
1081
  class Unknown < FieldValueUnion; end
928
1082
  end
929
1083
 
1084
+ # @!attribute [rw] case_id
1085
+ # A unique identifier of the case.
1086
+ # @return [String]
1087
+ #
1088
+ # @!attribute [rw] domain_id
1089
+ # The unique identifier of the Cases domain.
1090
+ # @return [String]
1091
+ #
1092
+ # @!attribute [rw] max_results
1093
+ # The maximum number of audit events to return. The current maximum
1094
+ # supported value is 25. This is also the default when no other value
1095
+ # is provided.
1096
+ # @return [Integer]
1097
+ #
1098
+ # @!attribute [rw] next_token
1099
+ # The token for the next set of results. Use the value returned in the
1100
+ # previous response in the next request to retrieve the next set of
1101
+ # results.
1102
+ # @return [String]
1103
+ #
1104
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/GetCaseAuditEventsRequest AWS API Documentation
1105
+ #
1106
+ class GetCaseAuditEventsRequest < Struct.new(
1107
+ :case_id,
1108
+ :domain_id,
1109
+ :max_results,
1110
+ :next_token)
1111
+ SENSITIVE = []
1112
+ include Aws::Structure
1113
+ end
1114
+
1115
+ # @!attribute [rw] audit_events
1116
+ # A list of case audits where each represents a particular edit of the
1117
+ # case.
1118
+ # @return [Array<Types::AuditEvent>]
1119
+ #
1120
+ # @!attribute [rw] next_token
1121
+ # The token for the next set of results. This is null if there are no
1122
+ # more results to return.
1123
+ # @return [String]
1124
+ #
1125
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/GetCaseAuditEventsResponse AWS API Documentation
1126
+ #
1127
+ class GetCaseAuditEventsResponse < Struct.new(
1128
+ :audit_events,
1129
+ :next_token)
1130
+ SENSITIVE = []
1131
+ include Aws::Structure
1132
+ end
1133
+
930
1134
  # @!attribute [rw] domain_id
931
1135
  # The unique identifier of the Cases domain.
932
1136
  # @return [String]
@@ -2114,12 +2318,17 @@ module Aws::ConnectCases
2114
2318
  # to `CreateCase`.
2115
2319
  # @return [Array<Types::FieldValue>]
2116
2320
  #
2321
+ # @!attribute [rw] performed_by
2322
+ # Represents the identity of the person who performed the action.
2323
+ # @return [Types::UserUnion]
2324
+ #
2117
2325
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/UpdateCaseRequest AWS API Documentation
2118
2326
  #
2119
2327
  class UpdateCaseRequest < Struct.new(
2120
2328
  :case_id,
2121
2329
  :domain_id,
2122
- :fields)
2330
+ :fields,
2331
+ :performed_by)
2123
2332
  SENSITIVE = []
2124
2333
  include Aws::Structure
2125
2334
  end
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-connectcases/customizations'
52
52
  # @!group service
53
53
  module Aws::ConnectCases
54
54
 
55
- GEM_VERSION = '1.18.0'
55
+ GEM_VERSION = '1.20.0'
56
56
 
57
57
  end