aws-sdk-connectcases 1.51.0 → 1.52.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8af9ad0ec824d77ef860cdbcd3aa5e7b28cecdee683f41cf7ed3600007c50ce9
4
- data.tar.gz: 7058cb388b2628277e4c0b4f96349f4461fd5c8e216feec52eb1789bec7c0b1e
3
+ metadata.gz: c4a715ba9868a3c836516ad1dfe6c3e96f96b420eaa5be115c7b12a126434883
4
+ data.tar.gz: 0ae645082a4f8f0ba4c92a8804ec223fe6aff8aabc01cdce0cc1811b22402316
5
5
  SHA512:
6
- metadata.gz: d21b4080ff070dd688feef97e1f098d7af285fef341406963b16878ef491528c46452f303d4aec0b79781a797c72c959e1315417907628f65d492b2029b38cc9
7
- data.tar.gz: 89760a274a3f34c950ef3e64c7e582dda9278c19dc1f7840977e34b5e9905938413c4312a2f997e343bc2875c3c42e015077cfa6594a6be92c4e67ebe55b4406
6
+ metadata.gz: 686dad75f38ff871b5f769ec0ae4759e93fc5dd6074b0e07054349325e436fa21757917abea049bfb32b45a70a286d3764b5aafd27a624c4df5e6d30cf5fb732
7
+ data.tar.gz: 5ece10acc77f7daeefefd7f8f55cd38eaf61087d602489560e59d225012d0a3dcadff367504f413ef3e4168ba3cf62aed3f4a8b7b8da905aee90b4812dc238fb
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.52.0 (2025-10-02)
5
+ ------------------
6
+
7
+ * Feature - New Search All Related Items API enables searching related items across cases
8
+
4
9
  1.51.0 (2025-09-30)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.51.0
1
+ 1.52.0
@@ -2237,6 +2237,237 @@ module Aws::ConnectCases
2237
2237
  req.send_request(options)
2238
2238
  end
2239
2239
 
2240
+ # Searches for related items across all cases within a domain. This is a
2241
+ # global search operation that returns related items from multiple
2242
+ # cases, unlike the case-specific [SearchRelatedItems][1] API.
2243
+ #
2244
+ # **Use cases**
2245
+ #
2246
+ # Following are common uses cases for this API:
2247
+ #
2248
+ # * Find cases with similar issues across the domain. For example,
2249
+ # search for all cases containing comments about "product defect" to
2250
+ # identify patterns and existing solutions.
2251
+ #
2252
+ # * Locate all cases associated with specific contacts or orders. For
2253
+ # example, find all cases linked to a contactArn to understand the
2254
+ # complete customer journey.
2255
+ #
2256
+ # * Monitor SLA compliance across cases. For example, search for all
2257
+ # cases with "Active" SLA status to prioritize remediation efforts.
2258
+ #
2259
+ # **Important things to know**
2260
+ #
2261
+ # * This API returns case IDs, not complete case objects. To retrieve
2262
+ # full case details, you must make additional calls to the
2263
+ # [GetCase][2] API for each returned case ID.
2264
+ #
2265
+ # * This API searches across related items content, not case fields. Use
2266
+ # the [SearchCases][3] API to search within case field values.
2267
+ #
2268
+ # **Endpoints**: See [Amazon Connect endpoints and quotas][4].
2269
+ #
2270
+ #
2271
+ #
2272
+ # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_SearchRelatedItems.html
2273
+ # [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetCase.html
2274
+ # [3]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_SearchCases.html
2275
+ # [4]: https://docs.aws.amazon.com/general/latest/gr/connect_region.html
2276
+ #
2277
+ # @option params [required, String] :domain_id
2278
+ # The unique identifier of the Cases domain.
2279
+ #
2280
+ # @option params [Integer] :max_results
2281
+ # The maximum number of results to return per page.
2282
+ #
2283
+ # @option params [String] :next_token
2284
+ # The token for the next set of results. Use the value returned in the
2285
+ # previous response in the next request to retrieve the next set of
2286
+ # results.
2287
+ #
2288
+ # @option params [Array<Types::RelatedItemTypeFilter>] :filters
2289
+ # The list of types of related items and their parameters to use for
2290
+ # filtering. The filters work as an OR condition: caller gets back
2291
+ # related items that match any of the specified filter types.
2292
+ #
2293
+ # @option params [Array<Types::SearchAllRelatedItemsSort>] :sorts
2294
+ # A structured set of sort terms to specify the order in which related
2295
+ # items should be returned. Supports sorting by association time or case
2296
+ # ID. The sorts work in the order specified: first sort term takes
2297
+ # precedence over subsequent terms.
2298
+ #
2299
+ # @return [Types::SearchAllRelatedItemsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2300
+ #
2301
+ # * {Types::SearchAllRelatedItemsResponse#next_token #next_token} => String
2302
+ # * {Types::SearchAllRelatedItemsResponse#related_items #related_items} => Array&lt;Types::SearchAllRelatedItemsResponseItem&gt;
2303
+ #
2304
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2305
+ #
2306
+ # @example Request syntax with placeholder values
2307
+ #
2308
+ # resp = client.search_all_related_items({
2309
+ # domain_id: "DomainId", # required
2310
+ # max_results: 1,
2311
+ # next_token: "NextToken",
2312
+ # filters: [
2313
+ # {
2314
+ # contact: {
2315
+ # channel: ["Channel"],
2316
+ # contact_arn: "ContactArn",
2317
+ # },
2318
+ # comment: {
2319
+ # },
2320
+ # file: {
2321
+ # file_arn: "FileArn",
2322
+ # },
2323
+ # sla: {
2324
+ # name: "SlaName",
2325
+ # status: "Active", # accepts Active, Overdue, Met, NotMet
2326
+ # },
2327
+ # connect_case: {
2328
+ # case_id: "CaseId",
2329
+ # },
2330
+ # custom: {
2331
+ # fields: {
2332
+ # field: {
2333
+ # equal_to: {
2334
+ # id: "FieldId", # required
2335
+ # value: { # required
2336
+ # string_value: "FieldValueUnionStringValueString",
2337
+ # double_value: 1.0,
2338
+ # boolean_value: false,
2339
+ # empty_value: {
2340
+ # },
2341
+ # user_arn_value: "String",
2342
+ # },
2343
+ # },
2344
+ # contains: {
2345
+ # id: "FieldId", # required
2346
+ # value: { # required
2347
+ # string_value: "FieldValueUnionStringValueString",
2348
+ # double_value: 1.0,
2349
+ # boolean_value: false,
2350
+ # empty_value: {
2351
+ # },
2352
+ # user_arn_value: "String",
2353
+ # },
2354
+ # },
2355
+ # greater_than: {
2356
+ # id: "FieldId", # required
2357
+ # value: { # required
2358
+ # string_value: "FieldValueUnionStringValueString",
2359
+ # double_value: 1.0,
2360
+ # boolean_value: false,
2361
+ # empty_value: {
2362
+ # },
2363
+ # user_arn_value: "String",
2364
+ # },
2365
+ # },
2366
+ # greater_than_or_equal_to: {
2367
+ # id: "FieldId", # required
2368
+ # value: { # required
2369
+ # string_value: "FieldValueUnionStringValueString",
2370
+ # double_value: 1.0,
2371
+ # boolean_value: false,
2372
+ # empty_value: {
2373
+ # },
2374
+ # user_arn_value: "String",
2375
+ # },
2376
+ # },
2377
+ # less_than: {
2378
+ # id: "FieldId", # required
2379
+ # value: { # required
2380
+ # string_value: "FieldValueUnionStringValueString",
2381
+ # double_value: 1.0,
2382
+ # boolean_value: false,
2383
+ # empty_value: {
2384
+ # },
2385
+ # user_arn_value: "String",
2386
+ # },
2387
+ # },
2388
+ # less_than_or_equal_to: {
2389
+ # id: "FieldId", # required
2390
+ # value: { # required
2391
+ # string_value: "FieldValueUnionStringValueString",
2392
+ # double_value: 1.0,
2393
+ # boolean_value: false,
2394
+ # empty_value: {
2395
+ # },
2396
+ # user_arn_value: "String",
2397
+ # },
2398
+ # },
2399
+ # },
2400
+ # not: {
2401
+ # # recursive CustomFieldsFilter
2402
+ # },
2403
+ # and_all: [
2404
+ # {
2405
+ # # recursive CustomFieldsFilter
2406
+ # },
2407
+ # ],
2408
+ # or_all: [
2409
+ # {
2410
+ # # recursive CustomFieldsFilter
2411
+ # },
2412
+ # ],
2413
+ # },
2414
+ # },
2415
+ # },
2416
+ # ],
2417
+ # sorts: [
2418
+ # {
2419
+ # sort_property: "AssociationTime", # required, accepts AssociationTime, CaseId
2420
+ # sort_order: "Asc", # required, accepts Asc, Desc
2421
+ # },
2422
+ # ],
2423
+ # })
2424
+ #
2425
+ # @example Response structure
2426
+ #
2427
+ # resp.next_token #=> String
2428
+ # resp.related_items #=> Array
2429
+ # resp.related_items[0].related_item_id #=> String
2430
+ # resp.related_items[0].case_id #=> String
2431
+ # resp.related_items[0].type #=> String, one of "Contact", "Comment", "File", "Sla", "ConnectCase", "Custom"
2432
+ # resp.related_items[0].association_time #=> Time
2433
+ # resp.related_items[0].content.contact.contact_arn #=> String
2434
+ # resp.related_items[0].content.contact.channel #=> String
2435
+ # resp.related_items[0].content.contact.connected_to_system_time #=> Time
2436
+ # resp.related_items[0].content.comment.body #=> String
2437
+ # resp.related_items[0].content.comment.content_type #=> String, one of "Text/Plain"
2438
+ # resp.related_items[0].content.file.file_arn #=> String
2439
+ # resp.related_items[0].content.sla.sla_configuration.name #=> String
2440
+ # resp.related_items[0].content.sla.sla_configuration.type #=> String, one of "CaseField"
2441
+ # resp.related_items[0].content.sla.sla_configuration.status #=> String, one of "Active", "Overdue", "Met", "NotMet"
2442
+ # resp.related_items[0].content.sla.sla_configuration.field_id #=> String
2443
+ # resp.related_items[0].content.sla.sla_configuration.target_field_values #=> Array
2444
+ # resp.related_items[0].content.sla.sla_configuration.target_field_values[0].string_value #=> String
2445
+ # resp.related_items[0].content.sla.sla_configuration.target_field_values[0].double_value #=> Float
2446
+ # resp.related_items[0].content.sla.sla_configuration.target_field_values[0].boolean_value #=> Boolean
2447
+ # resp.related_items[0].content.sla.sla_configuration.target_field_values[0].user_arn_value #=> String
2448
+ # resp.related_items[0].content.sla.sla_configuration.target_time #=> Time
2449
+ # resp.related_items[0].content.sla.sla_configuration.completion_time #=> Time
2450
+ # resp.related_items[0].content.connect_case.case_id #=> String
2451
+ # resp.related_items[0].content.custom.fields #=> Array
2452
+ # resp.related_items[0].content.custom.fields[0].id #=> String
2453
+ # resp.related_items[0].content.custom.fields[0].value.string_value #=> String
2454
+ # resp.related_items[0].content.custom.fields[0].value.double_value #=> Float
2455
+ # resp.related_items[0].content.custom.fields[0].value.boolean_value #=> Boolean
2456
+ # resp.related_items[0].content.custom.fields[0].value.user_arn_value #=> String
2457
+ # resp.related_items[0].performed_by.user_arn #=> String
2458
+ # resp.related_items[0].performed_by.custom_entity #=> String
2459
+ # resp.related_items[0].tags #=> Hash
2460
+ # resp.related_items[0].tags["String"] #=> String
2461
+ #
2462
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/SearchAllRelatedItems AWS API Documentation
2463
+ #
2464
+ # @overload search_all_related_items(params = {})
2465
+ # @param [Hash] params ({})
2466
+ def search_all_related_items(params = {}, options = {})
2467
+ req = build_request(:search_all_related_items, params)
2468
+ req.send_request(options)
2469
+ end
2470
+
2240
2471
  # Searches for cases within their associated Cases domain. Search
2241
2472
  # results are returned as a paginated list of abridged case documents.
2242
2473
  #
@@ -3014,7 +3245,7 @@ module Aws::ConnectCases
3014
3245
  tracer: tracer
3015
3246
  )
3016
3247
  context[:gem_name] = 'aws-sdk-connectcases'
3017
- context[:gem_version] = '1.51.0'
3248
+ context[:gem_version] = '1.52.0'
3018
3249
  Seahorse::Client::Request.new(handlers, context)
3019
3250
  end
3020
3251
 
@@ -226,6 +226,15 @@ module Aws::ConnectCases
226
226
  RequiredFieldList = Shapes::ListShape.new(name: 'RequiredFieldList')
227
227
  ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
228
228
  RuleType = Shapes::StringShape.new(name: 'RuleType')
229
+ SearchAllRelatedItemsRequest = Shapes::StructureShape.new(name: 'SearchAllRelatedItemsRequest')
230
+ SearchAllRelatedItemsRequestFiltersList = Shapes::ListShape.new(name: 'SearchAllRelatedItemsRequestFiltersList')
231
+ SearchAllRelatedItemsRequestMaxResultsInteger = Shapes::IntegerShape.new(name: 'SearchAllRelatedItemsRequestMaxResultsInteger')
232
+ SearchAllRelatedItemsRequestSortsList = Shapes::ListShape.new(name: 'SearchAllRelatedItemsRequestSortsList')
233
+ SearchAllRelatedItemsResponse = Shapes::StructureShape.new(name: 'SearchAllRelatedItemsResponse')
234
+ SearchAllRelatedItemsResponseItem = Shapes::StructureShape.new(name: 'SearchAllRelatedItemsResponseItem')
235
+ SearchAllRelatedItemsResponseRelatedItemsList = Shapes::ListShape.new(name: 'SearchAllRelatedItemsResponseRelatedItemsList')
236
+ SearchAllRelatedItemsSort = Shapes::StructureShape.new(name: 'SearchAllRelatedItemsSort')
237
+ SearchAllRelatedItemsSortProperty = Shapes::StringShape.new(name: 'SearchAllRelatedItemsSortProperty')
229
238
  SearchCasesRequest = Shapes::StructureShape.new(name: 'SearchCasesRequest')
230
239
  SearchCasesRequestFieldsList = Shapes::ListShape.new(name: 'SearchCasesRequestFieldsList')
231
240
  SearchCasesRequestMaxResultsInteger = Shapes::IntegerShape.new(name: 'SearchCasesRequestMaxResultsInteger')
@@ -995,6 +1004,36 @@ module Aws::ConnectCases
995
1004
  ResourceNotFoundException.add_member(:resource_type, Shapes::ShapeRef.new(shape: String, required: true, location_name: "resourceType"))
996
1005
  ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
997
1006
 
1007
+ SearchAllRelatedItemsRequest.add_member(:domain_id, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainId"))
1008
+ SearchAllRelatedItemsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: SearchAllRelatedItemsRequestMaxResultsInteger, location_name: "maxResults"))
1009
+ SearchAllRelatedItemsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
1010
+ SearchAllRelatedItemsRequest.add_member(:filters, Shapes::ShapeRef.new(shape: SearchAllRelatedItemsRequestFiltersList, location_name: "filters"))
1011
+ SearchAllRelatedItemsRequest.add_member(:sorts, Shapes::ShapeRef.new(shape: SearchAllRelatedItemsRequestSortsList, location_name: "sorts"))
1012
+ SearchAllRelatedItemsRequest.struct_class = Types::SearchAllRelatedItemsRequest
1013
+
1014
+ SearchAllRelatedItemsRequestFiltersList.member = Shapes::ShapeRef.new(shape: RelatedItemTypeFilter)
1015
+
1016
+ SearchAllRelatedItemsRequestSortsList.member = Shapes::ShapeRef.new(shape: SearchAllRelatedItemsSort)
1017
+
1018
+ SearchAllRelatedItemsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
1019
+ SearchAllRelatedItemsResponse.add_member(:related_items, Shapes::ShapeRef.new(shape: SearchAllRelatedItemsResponseRelatedItemsList, required: true, location_name: "relatedItems"))
1020
+ SearchAllRelatedItemsResponse.struct_class = Types::SearchAllRelatedItemsResponse
1021
+
1022
+ SearchAllRelatedItemsResponseItem.add_member(:related_item_id, Shapes::ShapeRef.new(shape: RelatedItemId, required: true, location_name: "relatedItemId"))
1023
+ SearchAllRelatedItemsResponseItem.add_member(:case_id, Shapes::ShapeRef.new(shape: CaseId, required: true, location_name: "caseId"))
1024
+ SearchAllRelatedItemsResponseItem.add_member(:type, Shapes::ShapeRef.new(shape: RelatedItemType, required: true, location_name: "type"))
1025
+ SearchAllRelatedItemsResponseItem.add_member(:association_time, Shapes::ShapeRef.new(shape: AssociationTime, required: true, location_name: "associationTime"))
1026
+ SearchAllRelatedItemsResponseItem.add_member(:content, Shapes::ShapeRef.new(shape: RelatedItemContent, required: true, location_name: "content"))
1027
+ SearchAllRelatedItemsResponseItem.add_member(:performed_by, Shapes::ShapeRef.new(shape: UserUnion, location_name: "performedBy"))
1028
+ SearchAllRelatedItemsResponseItem.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "tags"))
1029
+ SearchAllRelatedItemsResponseItem.struct_class = Types::SearchAllRelatedItemsResponseItem
1030
+
1031
+ SearchAllRelatedItemsResponseRelatedItemsList.member = Shapes::ShapeRef.new(shape: SearchAllRelatedItemsResponseItem)
1032
+
1033
+ SearchAllRelatedItemsSort.add_member(:sort_property, Shapes::ShapeRef.new(shape: SearchAllRelatedItemsSortProperty, required: true, location_name: "sortProperty"))
1034
+ SearchAllRelatedItemsSort.add_member(:sort_order, Shapes::ShapeRef.new(shape: Order, required: true, location_name: "sortOrder"))
1035
+ SearchAllRelatedItemsSort.struct_class = Types::SearchAllRelatedItemsSort
1036
+
998
1037
  SearchCasesRequest.add_member(:domain_id, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainId"))
999
1038
  SearchCasesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: SearchCasesRequestMaxResultsInteger, location_name: "maxResults"))
1000
1039
  SearchCasesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
@@ -1687,6 +1726,25 @@ module Aws::ConnectCases
1687
1726
  o.errors << Shapes::ShapeRef.new(shape: ConflictException)
1688
1727
  end)
1689
1728
 
1729
+ api.add_operation(:search_all_related_items, Seahorse::Model::Operation.new.tap do |o|
1730
+ o.name = "SearchAllRelatedItems"
1731
+ o.http_method = "POST"
1732
+ o.http_request_uri = "/domains/{domainId}/related-items-search"
1733
+ o.input = Shapes::ShapeRef.new(shape: SearchAllRelatedItemsRequest)
1734
+ o.output = Shapes::ShapeRef.new(shape: SearchAllRelatedItemsResponse)
1735
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
1736
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1737
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
1738
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
1739
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
1740
+ o[:pager] = Aws::Pager.new(
1741
+ limit_key: "max_results",
1742
+ tokens: {
1743
+ "next_token" => "next_token"
1744
+ }
1745
+ )
1746
+ end)
1747
+
1690
1748
  api.add_operation(:search_cases, Seahorse::Model::Operation.new.tap do |o|
1691
1749
  o.name = "SearchCases"
1692
1750
  o.http_method = "POST"
@@ -578,10 +578,10 @@ module Aws::ConnectCases
578
578
  include Aws::Structure
579
579
  end
580
580
 
581
- # Represents the content of a Case related item
581
+ # Represents the content of a `ConnectCase` type related item.
582
582
  #
583
583
  # @!attribute [rw] case_id
584
- # The unique identifier of the related case
584
+ # A unique identifier of the case.
585
585
  # @return [String]
586
586
  #
587
587
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ConnectCaseContent AWS API Documentation
@@ -592,10 +592,10 @@ module Aws::ConnectCases
592
592
  include Aws::Structure
593
593
  end
594
594
 
595
- # A filter for related items of type Case
595
+ # A filter for related items of type `ConnectCase`.
596
596
  #
597
597
  # @!attribute [rw] case_id
598
- # The unique identifier of the case to filter by
598
+ # A unique identifier of the case.
599
599
  # @return [String]
600
600
  #
601
601
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ConnectCaseFilter AWS API Documentation
@@ -606,10 +606,10 @@ module Aws::ConnectCases
606
606
  include Aws::Structure
607
607
  end
608
608
 
609
- # Represents the input content of a Case related item
609
+ # Represents the content of a `ConnectCase` related item.
610
610
  #
611
611
  # @!attribute [rw] case_id
612
- # The unique identifier of the case to be related
612
+ # A unique identifier of the case.
613
613
  # @return [String]
614
614
  #
615
615
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ConnectCaseInputContent AWS API Documentation
@@ -1017,10 +1017,10 @@ module Aws::ConnectCases
1017
1017
  include Aws::Structure
1018
1018
  end
1019
1019
 
1020
- # Represents the content of a Custom related item
1020
+ # Represents the content of a `Custom` type related item.
1021
1021
  #
1022
1022
  # @!attribute [rw] fields
1023
- # List of field values for the custom related item
1023
+ # List of field values for the `Custom` related item.
1024
1024
  # @return [Array<Types::FieldValue>]
1025
1025
  #
1026
1026
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CustomContent AWS API Documentation
@@ -1031,7 +1031,8 @@ module Aws::ConnectCases
1031
1031
  include Aws::Structure
1032
1032
  end
1033
1033
 
1034
- # A filter for fields in related items of type Custom
1034
+ # A filter for fields in `Custom` type related items. Only one value can
1035
+ # be provided.
1035
1036
  #
1036
1037
  # @note CustomFieldsFilter is a union - when making an API calls you must set exactly one of the members.
1037
1038
  #
@@ -1040,15 +1041,15 @@ module Aws::ConnectCases
1040
1041
  # @return [Types::FieldFilter]
1041
1042
  #
1042
1043
  # @!attribute [rw] not
1043
- # Excludes items matching the filter
1044
+ # Excludes items matching the filter.
1044
1045
  # @return [Types::CustomFieldsFilter]
1045
1046
  #
1046
1047
  # @!attribute [rw] and_all
1047
- # Matches items that satisfy all of the specified filter conditions
1048
+ # Provides "and all" filtering.
1048
1049
  # @return [Array<Types::CustomFieldsFilter>]
1049
1050
  #
1050
1051
  # @!attribute [rw] or_all
1051
- # Matches items that satisfy any of the specified filter conditions
1052
+ # Provides "or all" filtering.
1052
1053
  # @return [Array<Types::CustomFieldsFilter>]
1053
1054
  #
1054
1055
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CustomFieldsFilter AWS API Documentation
@@ -1070,10 +1071,10 @@ module Aws::ConnectCases
1070
1071
  class Unknown < CustomFieldsFilter; end
1071
1072
  end
1072
1073
 
1073
- # A filter for related items of type Custom
1074
+ # A filter for related items of type `Custom`.
1074
1075
  #
1075
1076
  # @!attribute [rw] fields
1076
- # Filter conditions for custom fields
1077
+ # Filter conditions for custom fields.
1077
1078
  # @return [Types::CustomFieldsFilter]
1078
1079
  #
1079
1080
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CustomFilter AWS API Documentation
@@ -1084,10 +1085,10 @@ module Aws::ConnectCases
1084
1085
  include Aws::Structure
1085
1086
  end
1086
1087
 
1087
- # Represents the input content of a Custom related item
1088
+ # Represents the content of a `Custom` related item.
1088
1089
  #
1089
1090
  # @!attribute [rw] fields
1090
- # List of field values for the custom related item
1091
+ # List of field values for the `Custom` related item.
1091
1092
  # @return [Array<Types::FieldValue>]
1092
1093
  #
1093
1094
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CustomInputContent AWS API Documentation
@@ -2659,11 +2660,11 @@ module Aws::ConnectCases
2659
2660
  # @return [Types::SlaContent]
2660
2661
  #
2661
2662
  # @!attribute [rw] connect_case
2662
- # Content for a related Connect case
2663
+ # Represents the Amazon Connect case to be created as a related item.
2663
2664
  # @return [Types::ConnectCaseContent]
2664
2665
  #
2665
2666
  # @!attribute [rw] custom
2666
- # Content for a custom related item
2667
+ # Represents the content of a `Custom` type related item.
2667
2668
  # @return [Types::CustomContent]
2668
2669
  #
2669
2670
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/RelatedItemContent AWS API Documentation
@@ -2727,11 +2728,11 @@ module Aws::ConnectCases
2727
2728
  # @return [Types::SlaInputContent]
2728
2729
  #
2729
2730
  # @!attribute [rw] connect_case
2730
- # Input content for a related Connect case
2731
+ # Represents the Amazon Connect case to be created as a related item.
2731
2732
  # @return [Types::ConnectCaseInputContent]
2732
2733
  #
2733
2734
  # @!attribute [rw] custom
2734
- # Input content for a custom related item
2735
+ # Represents the content of a `Custom` type related item.
2735
2736
  # @return [Types::CustomInputContent]
2736
2737
  #
2737
2738
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/RelatedItemInputContent AWS API Documentation
@@ -2779,11 +2780,11 @@ module Aws::ConnectCases
2779
2780
  # @return [Types::SlaFilter]
2780
2781
  #
2781
2782
  # @!attribute [rw] connect_case
2782
- # Filter for related items of type Connect case
2783
+ # Represents the Amazon Connect case to be created as a related item.
2783
2784
  # @return [Types::ConnectCaseFilter]
2784
2785
  #
2785
2786
  # @!attribute [rw] custom
2786
- # Filter for related items of type Custom
2787
+ # Represents the content of a `Custom` type related item.
2787
2788
  # @return [Types::CustomFilter]
2788
2789
  #
2789
2790
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/RelatedItemTypeFilter AWS API Documentation
@@ -2876,6 +2877,135 @@ module Aws::ConnectCases
2876
2877
  include Aws::Structure
2877
2878
  end
2878
2879
 
2880
+ # @!attribute [rw] domain_id
2881
+ # The unique identifier of the Cases domain.
2882
+ # @return [String]
2883
+ #
2884
+ # @!attribute [rw] max_results
2885
+ # The maximum number of results to return per page.
2886
+ # @return [Integer]
2887
+ #
2888
+ # @!attribute [rw] next_token
2889
+ # The token for the next set of results. Use the value returned in the
2890
+ # previous response in the next request to retrieve the next set of
2891
+ # results.
2892
+ # @return [String]
2893
+ #
2894
+ # @!attribute [rw] filters
2895
+ # The list of types of related items and their parameters to use for
2896
+ # filtering. The filters work as an OR condition: caller gets back
2897
+ # related items that match any of the specified filter types.
2898
+ # @return [Array<Types::RelatedItemTypeFilter>]
2899
+ #
2900
+ # @!attribute [rw] sorts
2901
+ # A structured set of sort terms to specify the order in which related
2902
+ # items should be returned. Supports sorting by association time or
2903
+ # case ID. The sorts work in the order specified: first sort term
2904
+ # takes precedence over subsequent terms.
2905
+ # @return [Array<Types::SearchAllRelatedItemsSort>]
2906
+ #
2907
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/SearchAllRelatedItemsRequest AWS API Documentation
2908
+ #
2909
+ class SearchAllRelatedItemsRequest < Struct.new(
2910
+ :domain_id,
2911
+ :max_results,
2912
+ :next_token,
2913
+ :filters,
2914
+ :sorts)
2915
+ SENSITIVE = []
2916
+ include Aws::Structure
2917
+ end
2918
+
2919
+ # @!attribute [rw] next_token
2920
+ # The token for the next set of results. This is null if there are no
2921
+ # more results to return.
2922
+ # @return [String]
2923
+ #
2924
+ # @!attribute [rw] related_items
2925
+ # A list of items related to a case.
2926
+ # @return [Array<Types::SearchAllRelatedItemsResponseItem>]
2927
+ #
2928
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/SearchAllRelatedItemsResponse AWS API Documentation
2929
+ #
2930
+ class SearchAllRelatedItemsResponse < Struct.new(
2931
+ :next_token,
2932
+ :related_items)
2933
+ SENSITIVE = []
2934
+ include Aws::Structure
2935
+ end
2936
+
2937
+ # A list of items that represent RelatedItems. This data type is similar
2938
+ # to [SearchRelatedItemsResponseItem][1] except
2939
+ # Search**All**RelatedItemsResponseItem has a caseId field.
2940
+ #
2941
+ #
2942
+ #
2943
+ # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_SearchRelatedItemsResponseItem.html
2944
+ #
2945
+ # @!attribute [rw] related_item_id
2946
+ # Unique identifier of a related item.
2947
+ # @return [String]
2948
+ #
2949
+ # @!attribute [rw] case_id
2950
+ # A unique identifier of the case.
2951
+ # @return [String]
2952
+ #
2953
+ # @!attribute [rw] type
2954
+ # Type of a related item.
2955
+ # @return [String]
2956
+ #
2957
+ # @!attribute [rw] association_time
2958
+ # Time at which a related item was associated with a case.
2959
+ # @return [Time]
2960
+ #
2961
+ # @!attribute [rw] content
2962
+ # Represents the content of a particular type of related item.
2963
+ # @return [Types::RelatedItemContent]
2964
+ #
2965
+ # @!attribute [rw] performed_by
2966
+ # Represents the entity that performed the action.
2967
+ # @return [Types::UserUnion]
2968
+ #
2969
+ # @!attribute [rw] tags
2970
+ # A map of of key-value pairs that represent tags on a resource. Tags
2971
+ # are used to organize, track, or control access for this resource.
2972
+ # @return [Hash<String,String>]
2973
+ #
2974
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/SearchAllRelatedItemsResponseItem AWS API Documentation
2975
+ #
2976
+ class SearchAllRelatedItemsResponseItem < Struct.new(
2977
+ :related_item_id,
2978
+ :case_id,
2979
+ :type,
2980
+ :association_time,
2981
+ :content,
2982
+ :performed_by,
2983
+ :tags)
2984
+ SENSITIVE = []
2985
+ include Aws::Structure
2986
+ end
2987
+
2988
+ # The order in which all returned related items should be sorted.
2989
+ #
2990
+ # @!attribute [rw] sort_property
2991
+ # Whether related items should be sorted in ascending or descending
2992
+ # order.
2993
+ # @return [String]
2994
+ #
2995
+ # @!attribute [rw] sort_order
2996
+ # Whether related items should be sorted by association time or case
2997
+ # ID.
2998
+ # @return [String]
2999
+ #
3000
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/SearchAllRelatedItemsSort AWS API Documentation
3001
+ #
3002
+ class SearchAllRelatedItemsSort < Struct.new(
3003
+ :sort_property,
3004
+ :sort_order)
3005
+ SENSITIVE = []
3006
+ include Aws::Structure
3007
+ end
3008
+
2879
3009
  # @!attribute [rw] domain_id
2880
3010
  # The unique identifier of the Cases domain.
2881
3011
  # @return [String]
@@ -55,7 +55,7 @@ module Aws::ConnectCases
55
55
  autoload :EndpointProvider, 'aws-sdk-connectcases/endpoint_provider'
56
56
  autoload :Endpoints, 'aws-sdk-connectcases/endpoints'
57
57
 
58
- GEM_VERSION = '1.51.0'
58
+ GEM_VERSION = '1.52.0'
59
59
 
60
60
  end
61
61
 
data/sig/client.rbs CHANGED
@@ -666,6 +666,124 @@ module Aws
666
666
  ) -> _PutCaseEventConfigurationResponseSuccess
667
667
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutCaseEventConfigurationResponseSuccess
668
668
 
669
+ interface _SearchAllRelatedItemsResponseSuccess
670
+ include ::Seahorse::Client::_ResponseSuccess[Types::SearchAllRelatedItemsResponse]
671
+ def next_token: () -> ::String
672
+ def related_items: () -> ::Array[Types::SearchAllRelatedItemsResponseItem]
673
+ end
674
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#search_all_related_items-instance_method
675
+ def search_all_related_items: (
676
+ domain_id: ::String,
677
+ ?max_results: ::Integer,
678
+ ?next_token: ::String,
679
+ ?filters: Array[
680
+ {
681
+ contact: {
682
+ channel: Array[::String]?,
683
+ contact_arn: ::String?
684
+ }?,
685
+ comment: {
686
+ }?,
687
+ file: {
688
+ file_arn: ::String?
689
+ }?,
690
+ sla: {
691
+ name: ::String?,
692
+ status: ("Active" | "Overdue" | "Met" | "NotMet")?
693
+ }?,
694
+ connect_case: {
695
+ case_id: ::String?
696
+ }?,
697
+ custom: {
698
+ fields: {
699
+ field: {
700
+ equal_to: {
701
+ id: ::String,
702
+ value: {
703
+ string_value: ::String?,
704
+ double_value: ::Float?,
705
+ boolean_value: bool?,
706
+ empty_value: {
707
+ }?,
708
+ user_arn_value: ::String?
709
+ }
710
+ }?,
711
+ contains: {
712
+ id: ::String,
713
+ value: {
714
+ string_value: ::String?,
715
+ double_value: ::Float?,
716
+ boolean_value: bool?,
717
+ empty_value: {
718
+ }?,
719
+ user_arn_value: ::String?
720
+ }
721
+ }?,
722
+ greater_than: {
723
+ id: ::String,
724
+ value: {
725
+ string_value: ::String?,
726
+ double_value: ::Float?,
727
+ boolean_value: bool?,
728
+ empty_value: {
729
+ }?,
730
+ user_arn_value: ::String?
731
+ }
732
+ }?,
733
+ greater_than_or_equal_to: {
734
+ id: ::String,
735
+ value: {
736
+ string_value: ::String?,
737
+ double_value: ::Float?,
738
+ boolean_value: bool?,
739
+ empty_value: {
740
+ }?,
741
+ user_arn_value: ::String?
742
+ }
743
+ }?,
744
+ less_than: {
745
+ id: ::String,
746
+ value: {
747
+ string_value: ::String?,
748
+ double_value: ::Float?,
749
+ boolean_value: bool?,
750
+ empty_value: {
751
+ }?,
752
+ user_arn_value: ::String?
753
+ }
754
+ }?,
755
+ less_than_or_equal_to: {
756
+ id: ::String,
757
+ value: {
758
+ string_value: ::String?,
759
+ double_value: ::Float?,
760
+ boolean_value: bool?,
761
+ empty_value: {
762
+ }?,
763
+ user_arn_value: ::String?
764
+ }
765
+ }?
766
+ }?,
767
+ not: untyped?,
768
+ and_all: Array[
769
+ untyped,
770
+ ]?,
771
+ or_all: Array[
772
+ untyped,
773
+ ]?
774
+ }?
775
+ }?
776
+ },
777
+ ],
778
+ ?sorts: Array[
779
+ {
780
+ sort_property: ("AssociationTime" | "CaseId"),
781
+ sort_order: ("Asc" | "Desc")
782
+ },
783
+ ]
784
+ ) -> _SearchAllRelatedItemsResponseSuccess
785
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SearchAllRelatedItemsResponseSuccess
786
+
669
787
  interface _SearchCasesResponseSuccess
670
788
  include ::Seahorse::Client::_ResponseSuccess[Types::SearchCasesResponse]
671
789
  def next_token: () -> ::String
data/sig/types.rbs CHANGED
@@ -967,6 +967,38 @@ module Aws::ConnectCases
967
967
  SENSITIVE: []
968
968
  end
969
969
 
970
+ class SearchAllRelatedItemsRequest
971
+ attr_accessor domain_id: ::String
972
+ attr_accessor max_results: ::Integer
973
+ attr_accessor next_token: ::String
974
+ attr_accessor filters: ::Array[Types::RelatedItemTypeFilter]
975
+ attr_accessor sorts: ::Array[Types::SearchAllRelatedItemsSort]
976
+ SENSITIVE: []
977
+ end
978
+
979
+ class SearchAllRelatedItemsResponse
980
+ attr_accessor next_token: ::String
981
+ attr_accessor related_items: ::Array[Types::SearchAllRelatedItemsResponseItem]
982
+ SENSITIVE: []
983
+ end
984
+
985
+ class SearchAllRelatedItemsResponseItem
986
+ attr_accessor related_item_id: ::String
987
+ attr_accessor case_id: ::String
988
+ attr_accessor type: ("Contact" | "Comment" | "File" | "Sla" | "ConnectCase" | "Custom")
989
+ attr_accessor association_time: ::Time
990
+ attr_accessor content: Types::RelatedItemContent
991
+ attr_accessor performed_by: Types::UserUnion
992
+ attr_accessor tags: ::Hash[::String, ::String]
993
+ SENSITIVE: []
994
+ end
995
+
996
+ class SearchAllRelatedItemsSort
997
+ attr_accessor sort_property: ("AssociationTime" | "CaseId")
998
+ attr_accessor sort_order: ("Asc" | "Desc")
999
+ SENSITIVE: []
1000
+ end
1001
+
970
1002
  class SearchCasesRequest
971
1003
  attr_accessor domain_id: ::String
972
1004
  attr_accessor max_results: ::Integer
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-connectcases
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.51.0
4
+ version: 1.52.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services