aws-sdk-connectcases 1.51.0 → 1.52.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8af9ad0ec824d77ef860cdbcd3aa5e7b28cecdee683f41cf7ed3600007c50ce9
-  data.tar.gz: 7058cb388b2628277e4c0b4f96349f4461fd5c8e216feec52eb1789bec7c0b1e
+  metadata.gz: c4a715ba9868a3c836516ad1dfe6c3e96f96b420eaa5be115c7b12a126434883
+  data.tar.gz: 0ae645082a4f8f0ba4c92a8804ec223fe6aff8aabc01cdce0cc1811b22402316
 SHA512:
-  metadata.gz: d21b4080ff070dd688feef97e1f098d7af285fef341406963b16878ef491528c46452f303d4aec0b79781a797c72c959e1315417907628f65d492b2029b38cc9
-  data.tar.gz: 89760a274a3f34c950ef3e64c7e582dda9278c19dc1f7840977e34b5e9905938413c4312a2f997e343bc2875c3c42e015077cfa6594a6be92c4e67ebe55b4406
+  metadata.gz: 686dad75f38ff871b5f769ec0ae4759e93fc5dd6074b0e07054349325e436fa21757917abea049bfb32b45a70a286d3764b5aafd27a624c4df5e6d30cf5fb732
+  data.tar.gz: 5ece10acc77f7daeefefd7f8f55cd38eaf61087d602489560e59d225012d0a3dcadff367504f413ef3e4168ba3cf62aed3f4a8b7b8da905aee90b4812dc238fb

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.52.0 (2025-10-02)
+------------------
+
+* Feature - New Search All Related Items API enables searching related items across cases
+
 1.51.0 (2025-09-30)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.51.0
+1.52.0

data/lib/aws-sdk-connectcases/client.rb

@@ -2237,6 +2237,237 @@ module Aws::ConnectCases
       req.send_request(options)
     end
 
+    # Searches for related items across all cases within a domain. This is a
+    # global search operation that returns related items from multiple
+    # cases, unlike the case-specific [SearchRelatedItems][1] API.
+    #
+    # **Use cases**
+    #
+    # Following are common uses cases for this API:
+    #
+    # * Find cases with similar issues across the domain. For example,
+    #   search for all cases containing comments about "product defect" to
+    #   identify patterns and existing solutions.
+    #
+    # * Locate all cases associated with specific contacts or orders. For
+    #   example, find all cases linked to a contactArn to understand the
+    #   complete customer journey.
+    #
+    # * Monitor SLA compliance across cases. For example, search for all
+    #   cases with "Active" SLA status to prioritize remediation efforts.
+    #
+    # **Important things to know**
+    #
+    # * This API returns case IDs, not complete case objects. To retrieve
+    #   full case details, you must make additional calls to the
+    #   [GetCase][2] API for each returned case ID.
+    #
+    # * This API searches across related items content, not case fields. Use
+    #   the [SearchCases][3] API to search within case field values.
+    #
+    # **Endpoints**: See [Amazon Connect endpoints and quotas][4].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_SearchRelatedItems.html
+    # [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetCase.html
+    # [3]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_SearchCases.html
+    # [4]: https://docs.aws.amazon.com/general/latest/gr/connect_region.html
+    #
+    # @option params [required, String] :domain_id
+    #   The unique identifier of the Cases domain.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results to return per page.
+    #
+    # @option params [String] :next_token
+    #   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.
+    #
+    # @option params [Array<Types::RelatedItemTypeFilter>] :filters
+    #   The list of types of related items and their parameters to use for
+    #   filtering. The filters work as an OR condition: caller gets back
+    #   related items that match any of the specified filter types.
+    #
+    # @option params [Array<Types::SearchAllRelatedItemsSort>] :sorts
+    #   A structured set of sort terms to specify the order in which related
+    #   items should be returned. Supports sorting by association time or case
+    #   ID. The sorts work in the order specified: first sort term takes
+    #   precedence over subsequent terms.
+    #
+    # @return [Types::SearchAllRelatedItemsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::SearchAllRelatedItemsResponse#next_token #next_token} => String
+    #   * {Types::SearchAllRelatedItemsResponse#related_items #related_items} => Array&lt;Types::SearchAllRelatedItemsResponseItem&gt;
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.search_all_related_items({
+    #     domain_id: "DomainId", # required
+    #     max_results: 1,
+    #     next_token: "NextToken",
+    #     filters: [
+    #       {
+    #         contact: {
+    #           channel: ["Channel"],
+    #           contact_arn: "ContactArn",
+    #         },
+    #         comment: {
+    #         },
+    #         file: {
+    #           file_arn: "FileArn",
+    #         },
+    #         sla: {
+    #           name: "SlaName",
+    #           status: "Active", # accepts Active, Overdue, Met, NotMet
+    #         },
+    #         connect_case: {
+    #           case_id: "CaseId",
+    #         },
+    #         custom: {
+    #           fields: {
+    #             field: {
+    #               equal_to: {
+    #                 id: "FieldId", # required
+    #                 value: { # required
+    #                   string_value: "FieldValueUnionStringValueString",
+    #                   double_value: 1.0,
+    #                   boolean_value: false,
+    #                   empty_value: {
+    #                   },
+    #                   user_arn_value: "String",
+    #                 },
+    #               },
+    #               contains: {
+    #                 id: "FieldId", # required
+    #                 value: { # required
+    #                   string_value: "FieldValueUnionStringValueString",
+    #                   double_value: 1.0,
+    #                   boolean_value: false,
+    #                   empty_value: {
+    #                   },
+    #                   user_arn_value: "String",
+    #                 },
+    #               },
+    #               greater_than: {
+    #                 id: "FieldId", # required
+    #                 value: { # required
+    #                   string_value: "FieldValueUnionStringValueString",
+    #                   double_value: 1.0,
+    #                   boolean_value: false,
+    #                   empty_value: {
+    #                   },
+    #                   user_arn_value: "String",
+    #                 },
+    #               },
+    #               greater_than_or_equal_to: {
+    #                 id: "FieldId", # required
+    #                 value: { # required
+    #                   string_value: "FieldValueUnionStringValueString",
+    #                   double_value: 1.0,
+    #                   boolean_value: false,
+    #                   empty_value: {
+    #                   },
+    #                   user_arn_value: "String",
+    #                 },
+    #               },
+    #               less_than: {
+    #                 id: "FieldId", # required
+    #                 value: { # required
+    #                   string_value: "FieldValueUnionStringValueString",
+    #                   double_value: 1.0,
+    #                   boolean_value: false,
+    #                   empty_value: {
+    #                   },
+    #                   user_arn_value: "String",
+    #                 },
+    #               },
+    #               less_than_or_equal_to: {
+    #                 id: "FieldId", # required
+    #                 value: { # required
+    #                   string_value: "FieldValueUnionStringValueString",
+    #                   double_value: 1.0,
+    #                   boolean_value: false,
+    #                   empty_value: {
+    #                   },
+    #                   user_arn_value: "String",
+    #                 },
+    #               },
+    #             },
+    #             not: {
+    #               # recursive CustomFieldsFilter
+    #             },
+    #             and_all: [
+    #               {
+    #                 # recursive CustomFieldsFilter
+    #               },
+    #             ],
+    #             or_all: [
+    #               {
+    #                 # recursive CustomFieldsFilter
+    #               },
+    #             ],
+    #           },
+    #         },
+    #       },
+    #     ],
+    #     sorts: [
+    #       {
+    #         sort_property: "AssociationTime", # required, accepts AssociationTime, CaseId
+    #         sort_order: "Asc", # required, accepts Asc, Desc
+    #       },
+    #     ],
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.next_token #=> String
+    #   resp.related_items #=> Array
+    #   resp.related_items[0].related_item_id #=> String
+    #   resp.related_items[0].case_id #=> String
+    #   resp.related_items[0].type #=> String, one of "Contact", "Comment", "File", "Sla", "ConnectCase", "Custom"
+    #   resp.related_items[0].association_time #=> Time
+    #   resp.related_items[0].content.contact.contact_arn #=> String
+    #   resp.related_items[0].content.contact.channel #=> String
+    #   resp.related_items[0].content.contact.connected_to_system_time #=> Time
+    #   resp.related_items[0].content.comment.body #=> String
+    #   resp.related_items[0].content.comment.content_type #=> String, one of "Text/Plain"
+    #   resp.related_items[0].content.file.file_arn #=> String
+    #   resp.related_items[0].content.sla.sla_configuration.name #=> String
+    #   resp.related_items[0].content.sla.sla_configuration.type #=> String, one of "CaseField"
+    #   resp.related_items[0].content.sla.sla_configuration.status #=> String, one of "Active", "Overdue", "Met", "NotMet"
+    #   resp.related_items[0].content.sla.sla_configuration.field_id #=> String
+    #   resp.related_items[0].content.sla.sla_configuration.target_field_values #=> Array
+    #   resp.related_items[0].content.sla.sla_configuration.target_field_values[0].string_value #=> String
+    #   resp.related_items[0].content.sla.sla_configuration.target_field_values[0].double_value #=> Float
+    #   resp.related_items[0].content.sla.sla_configuration.target_field_values[0].boolean_value #=> Boolean
+    #   resp.related_items[0].content.sla.sla_configuration.target_field_values[0].user_arn_value #=> String
+    #   resp.related_items[0].content.sla.sla_configuration.target_time #=> Time
+    #   resp.related_items[0].content.sla.sla_configuration.completion_time #=> Time
+    #   resp.related_items[0].content.connect_case.case_id #=> String
+    #   resp.related_items[0].content.custom.fields #=> Array
+    #   resp.related_items[0].content.custom.fields[0].id #=> String
+    #   resp.related_items[0].content.custom.fields[0].value.string_value #=> String
+    #   resp.related_items[0].content.custom.fields[0].value.double_value #=> Float
+    #   resp.related_items[0].content.custom.fields[0].value.boolean_value #=> Boolean
+    #   resp.related_items[0].content.custom.fields[0].value.user_arn_value #=> String
+    #   resp.related_items[0].performed_by.user_arn #=> String
+    #   resp.related_items[0].performed_by.custom_entity #=> String
+    #   resp.related_items[0].tags #=> Hash
+    #   resp.related_items[0].tags["String"] #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/SearchAllRelatedItems AWS API Documentation
+    #
+    # @overload search_all_related_items(params = {})
+    # @param [Hash] params ({})
+    def search_all_related_items(params = {}, options = {})
+      req = build_request(:search_all_related_items, params)
+      req.send_request(options)
+    end
+
     # Searches for cases within their associated Cases domain. Search
     # results are returned as a paginated list of abridged case documents.
     #
@@ -3014,7 +3245,7 @@ module Aws::ConnectCases
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-connectcases'
-      context[:gem_version] = '1.51.0'
+      context[:gem_version] = '1.52.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-connectcases/client_api.rb

@@ -226,6 +226,15 @@ module Aws::ConnectCases
     RequiredFieldList = Shapes::ListShape.new(name: 'RequiredFieldList')
     ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
     RuleType = Shapes::StringShape.new(name: 'RuleType')
+    SearchAllRelatedItemsRequest = Shapes::StructureShape.new(name: 'SearchAllRelatedItemsRequest')
+    SearchAllRelatedItemsRequestFiltersList = Shapes::ListShape.new(name: 'SearchAllRelatedItemsRequestFiltersList')
+    SearchAllRelatedItemsRequestMaxResultsInteger = Shapes::IntegerShape.new(name: 'SearchAllRelatedItemsRequestMaxResultsInteger')
+    SearchAllRelatedItemsRequestSortsList = Shapes::ListShape.new(name: 'SearchAllRelatedItemsRequestSortsList')
+    SearchAllRelatedItemsResponse = Shapes::StructureShape.new(name: 'SearchAllRelatedItemsResponse')
+    SearchAllRelatedItemsResponseItem = Shapes::StructureShape.new(name: 'SearchAllRelatedItemsResponseItem')
+    SearchAllRelatedItemsResponseRelatedItemsList = Shapes::ListShape.new(name: 'SearchAllRelatedItemsResponseRelatedItemsList')
+    SearchAllRelatedItemsSort = Shapes::StructureShape.new(name: 'SearchAllRelatedItemsSort')
+    SearchAllRelatedItemsSortProperty = Shapes::StringShape.new(name: 'SearchAllRelatedItemsSortProperty')
     SearchCasesRequest = Shapes::StructureShape.new(name: 'SearchCasesRequest')
     SearchCasesRequestFieldsList = Shapes::ListShape.new(name: 'SearchCasesRequestFieldsList')
     SearchCasesRequestMaxResultsInteger = Shapes::IntegerShape.new(name: 'SearchCasesRequestMaxResultsInteger')
@@ -995,6 +1004,36 @@ module Aws::ConnectCases
     ResourceNotFoundException.add_member(:resource_type, Shapes::ShapeRef.new(shape: String, required: true, location_name: "resourceType"))
     ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
 
+    SearchAllRelatedItemsRequest.add_member(:domain_id, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainId"))
+    SearchAllRelatedItemsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: SearchAllRelatedItemsRequestMaxResultsInteger, location_name: "maxResults"))
+    SearchAllRelatedItemsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
+    SearchAllRelatedItemsRequest.add_member(:filters, Shapes::ShapeRef.new(shape: SearchAllRelatedItemsRequestFiltersList, location_name: "filters"))
+    SearchAllRelatedItemsRequest.add_member(:sorts, Shapes::ShapeRef.new(shape: SearchAllRelatedItemsRequestSortsList, location_name: "sorts"))
+    SearchAllRelatedItemsRequest.struct_class = Types::SearchAllRelatedItemsRequest
+
+    SearchAllRelatedItemsRequestFiltersList.member = Shapes::ShapeRef.new(shape: RelatedItemTypeFilter)
+
+    SearchAllRelatedItemsRequestSortsList.member = Shapes::ShapeRef.new(shape: SearchAllRelatedItemsSort)
+
+    SearchAllRelatedItemsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
+    SearchAllRelatedItemsResponse.add_member(:related_items, Shapes::ShapeRef.new(shape: SearchAllRelatedItemsResponseRelatedItemsList, required: true, location_name: "relatedItems"))
+    SearchAllRelatedItemsResponse.struct_class = Types::SearchAllRelatedItemsResponse
+
+    SearchAllRelatedItemsResponseItem.add_member(:related_item_id, Shapes::ShapeRef.new(shape: RelatedItemId, required: true, location_name: "relatedItemId"))
+    SearchAllRelatedItemsResponseItem.add_member(:case_id, Shapes::ShapeRef.new(shape: CaseId, required: true, location_name: "caseId"))
+    SearchAllRelatedItemsResponseItem.add_member(:type, Shapes::ShapeRef.new(shape: RelatedItemType, required: true, location_name: "type"))
+    SearchAllRelatedItemsResponseItem.add_member(:association_time, Shapes::ShapeRef.new(shape: AssociationTime, required: true, location_name: "associationTime"))
+    SearchAllRelatedItemsResponseItem.add_member(:content, Shapes::ShapeRef.new(shape: RelatedItemContent, required: true, location_name: "content"))
+    SearchAllRelatedItemsResponseItem.add_member(:performed_by, Shapes::ShapeRef.new(shape: UserUnion, location_name: "performedBy"))
+    SearchAllRelatedItemsResponseItem.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "tags"))
+    SearchAllRelatedItemsResponseItem.struct_class = Types::SearchAllRelatedItemsResponseItem
+
+    SearchAllRelatedItemsResponseRelatedItemsList.member = Shapes::ShapeRef.new(shape: SearchAllRelatedItemsResponseItem)
+
+    SearchAllRelatedItemsSort.add_member(:sort_property, Shapes::ShapeRef.new(shape: SearchAllRelatedItemsSortProperty, required: true, location_name: "sortProperty"))
+    SearchAllRelatedItemsSort.add_member(:sort_order, Shapes::ShapeRef.new(shape: Order, required: true, location_name: "sortOrder"))
+    SearchAllRelatedItemsSort.struct_class = Types::SearchAllRelatedItemsSort
+
     SearchCasesRequest.add_member(:domain_id, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainId"))
     SearchCasesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: SearchCasesRequestMaxResultsInteger, location_name: "maxResults"))
     SearchCasesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
@@ -1687,6 +1726,25 @@ module Aws::ConnectCases
         o.errors << Shapes::ShapeRef.new(shape: ConflictException)
       end)
 
+      api.add_operation(:search_all_related_items, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "SearchAllRelatedItems"
+        o.http_method = "POST"
+        o.http_request_uri = "/domains/{domainId}/related-items-search"
+        o.input = Shapes::ShapeRef.new(shape: SearchAllRelatedItemsRequest)
+        o.output = Shapes::ShapeRef.new(shape: SearchAllRelatedItemsResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_results",
+          tokens: {
+            "next_token" => "next_token"
+          }
+        )
+      end)
+
       api.add_operation(:search_cases, Seahorse::Model::Operation.new.tap do |o|
         o.name = "SearchCases"
         o.http_method = "POST"

data/lib/aws-sdk-connectcases/types.rb

@@ -578,10 +578,10 @@ module Aws::ConnectCases
       include Aws::Structure
     end
 
-    # Represents the content of a Case related item
+    # Represents the content of a `ConnectCase` type related item.
     #
     # @!attribute [rw] case_id
-    #   The unique identifier of the related case
+    #   A unique identifier of the case.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ConnectCaseContent AWS API Documentation
@@ -592,10 +592,10 @@ module Aws::ConnectCases
       include Aws::Structure
     end
 
-    # A filter for related items of type Case
+    # A filter for related items of type `ConnectCase`.
     #
     # @!attribute [rw] case_id
-    #   The unique identifier of the case to filter by
+    #   A unique identifier of the case.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ConnectCaseFilter AWS API Documentation
@@ -606,10 +606,10 @@ module Aws::ConnectCases
       include Aws::Structure
     end
 
-    # Represents the input content of a Case related item
+    # Represents the content of a `ConnectCase` related item.
     #
     # @!attribute [rw] case_id
-    #   The unique identifier of the case to be related
+    #   A unique identifier of the case.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ConnectCaseInputContent AWS API Documentation
@@ -1017,10 +1017,10 @@ module Aws::ConnectCases
       include Aws::Structure
     end
 
-    # Represents the content of a Custom related item
+    # Represents the content of a `Custom` type related item.
     #
     # @!attribute [rw] fields
-    #   List of field values for the custom related item
+    #   List of field values for the `Custom` related item.
     #   @return [Array<Types::FieldValue>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CustomContent AWS API Documentation
@@ -1031,7 +1031,8 @@ module Aws::ConnectCases
       include Aws::Structure
     end
 
-    # A filter for fields in related items of type Custom
+    # A filter for fields in `Custom` type related items. Only one value can
+    # be provided.
     #
     # @note CustomFieldsFilter is a union - when making an API calls you must set exactly one of the members.
     #
@@ -1040,15 +1041,15 @@ module Aws::ConnectCases
     #   @return [Types::FieldFilter]
     #
     # @!attribute [rw] not
-    #   Excludes items matching the filter
+    #   Excludes items matching the filter.
     #   @return [Types::CustomFieldsFilter]
     #
     # @!attribute [rw] and_all
-    #   Matches items that satisfy all of the specified filter conditions
+    #   Provides "and all" filtering.
     #   @return [Array<Types::CustomFieldsFilter>]
     #
     # @!attribute [rw] or_all
-    #   Matches items that satisfy any of the specified filter conditions
+    #   Provides "or all" filtering.
     #   @return [Array<Types::CustomFieldsFilter>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CustomFieldsFilter AWS API Documentation
@@ -1070,10 +1071,10 @@ module Aws::ConnectCases
       class Unknown < CustomFieldsFilter; end
     end
 
-    # A filter for related items of type Custom
+    # A filter for related items of type `Custom`.
     #
     # @!attribute [rw] fields
-    #   Filter conditions for custom fields
+    #   Filter conditions for custom fields.
     #   @return [Types::CustomFieldsFilter]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CustomFilter AWS API Documentation
@@ -1084,10 +1085,10 @@ module Aws::ConnectCases
       include Aws::Structure
     end
 
-    # Represents the input content of a Custom related item
+    # Represents the content of a `Custom` related item.
     #
     # @!attribute [rw] fields
-    #   List of field values for the custom related item
+    #   List of field values for the `Custom` related item.
     #   @return [Array<Types::FieldValue>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CustomInputContent AWS API Documentation
@@ -2659,11 +2660,11 @@ module Aws::ConnectCases
     #   @return [Types::SlaContent]
     #
     # @!attribute [rw] connect_case
-    #   Content for a related Connect case
+    #   Represents the Amazon Connect case to be created as a related item.
     #   @return [Types::ConnectCaseContent]
     #
     # @!attribute [rw] custom
-    #   Content for a custom related item
+    #   Represents the content of a `Custom` type related item.
     #   @return [Types::CustomContent]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/RelatedItemContent AWS API Documentation
@@ -2727,11 +2728,11 @@ module Aws::ConnectCases
     #   @return [Types::SlaInputContent]
     #
     # @!attribute [rw] connect_case
-    #   Input content for a related Connect case
+    #   Represents the Amazon Connect case to be created as a related item.
     #   @return [Types::ConnectCaseInputContent]
     #
     # @!attribute [rw] custom
-    #   Input content for a custom related item
+    #   Represents the content of a `Custom` type related item.
     #   @return [Types::CustomInputContent]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/RelatedItemInputContent AWS API Documentation
@@ -2779,11 +2780,11 @@ module Aws::ConnectCases
     #   @return [Types::SlaFilter]
     #
     # @!attribute [rw] connect_case
-    #   Filter for related items of type Connect case
+    #   Represents the Amazon Connect case to be created as a related item.
     #   @return [Types::ConnectCaseFilter]
     #
     # @!attribute [rw] custom
-    #   Filter for related items of type Custom
+    #   Represents the content of a `Custom` type related item.
     #   @return [Types::CustomFilter]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/RelatedItemTypeFilter AWS API Documentation
@@ -2876,6 +2877,135 @@ module Aws::ConnectCases
       include Aws::Structure
     end
 
+    # @!attribute [rw] domain_id
+    #   The unique identifier of the Cases domain.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of results to return per page.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] next_token
+    #   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.
+    #   @return [String]
+    #
+    # @!attribute [rw] filters
+    #   The list of types of related items and their parameters to use for
+    #   filtering. The filters work as an OR condition: caller gets back
+    #   related items that match any of the specified filter types.
+    #   @return [Array<Types::RelatedItemTypeFilter>]
+    #
+    # @!attribute [rw] sorts
+    #   A structured set of sort terms to specify the order in which related
+    #   items should be returned. Supports sorting by association time or
+    #   case ID. The sorts work in the order specified: first sort term
+    #   takes precedence over subsequent terms.
+    #   @return [Array<Types::SearchAllRelatedItemsSort>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/SearchAllRelatedItemsRequest AWS API Documentation
+    #
+    class SearchAllRelatedItemsRequest < Struct.new(
+      :domain_id,
+      :max_results,
+      :next_token,
+      :filters,
+      :sorts)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] next_token
+    #   The token for the next set of results. This is null if there are no
+    #   more results to return.
+    #   @return [String]
+    #
+    # @!attribute [rw] related_items
+    #   A list of items related to a case.
+    #   @return [Array<Types::SearchAllRelatedItemsResponseItem>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/SearchAllRelatedItemsResponse AWS API Documentation
+    #
+    class SearchAllRelatedItemsResponse < Struct.new(
+      :next_token,
+      :related_items)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # A list of items that represent RelatedItems. This data type is similar
+    # to [SearchRelatedItemsResponseItem][1] except
+    # Search**All**RelatedItemsResponseItem has a caseId field.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_SearchRelatedItemsResponseItem.html
+    #
+    # @!attribute [rw] related_item_id
+    #   Unique identifier of a related item.
+    #   @return [String]
+    #
+    # @!attribute [rw] case_id
+    #   A unique identifier of the case.
+    #   @return [String]
+    #
+    # @!attribute [rw] type
+    #   Type of a related item.
+    #   @return [String]
+    #
+    # @!attribute [rw] association_time
+    #   Time at which a related item was associated with a case.
+    #   @return [Time]
+    #
+    # @!attribute [rw] content
+    #   Represents the content of a particular type of related item.
+    #   @return [Types::RelatedItemContent]
+    #
+    # @!attribute [rw] performed_by
+    #   Represents the entity that performed the action.
+    #   @return [Types::UserUnion]
+    #
+    # @!attribute [rw] 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.
+    #   @return [Hash<String,String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/SearchAllRelatedItemsResponseItem AWS API Documentation
+    #
+    class SearchAllRelatedItemsResponseItem < Struct.new(
+      :related_item_id,
+      :case_id,
+      :type,
+      :association_time,
+      :content,
+      :performed_by,
+      :tags)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The order in which all returned related items should be sorted.
+    #
+    # @!attribute [rw] sort_property
+    #   Whether related items should be sorted in ascending or descending
+    #   order.
+    #   @return [String]
+    #
+    # @!attribute [rw] sort_order
+    #   Whether related items should be sorted by association time or case
+    #   ID.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/SearchAllRelatedItemsSort AWS API Documentation
+    #
+    class SearchAllRelatedItemsSort < Struct.new(
+      :sort_property,
+      :sort_order)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] domain_id
     #   The unique identifier of the Cases domain.
     #   @return [String]

data/lib/aws-sdk-connectcases.rb

@@ -55,7 +55,7 @@ module Aws::ConnectCases
   autoload :EndpointProvider, 'aws-sdk-connectcases/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-connectcases/endpoints'
 
-  GEM_VERSION = '1.51.0'
+  GEM_VERSION = '1.52.0'
 
 end
 

data/sig/client.rbs

@@ -666,6 +666,124 @@ module Aws
                                         ) -> _PutCaseEventConfigurationResponseSuccess
                                       | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutCaseEventConfigurationResponseSuccess
 
+      interface _SearchAllRelatedItemsResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::SearchAllRelatedItemsResponse]
+        def next_token: () -> ::String
+        def related_items: () -> ::Array[Types::SearchAllRelatedItemsResponseItem]
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#search_all_related_items-instance_method
+      def search_all_related_items: (
+                                      domain_id: ::String,
+                                      ?max_results: ::Integer,
+                                      ?next_token: ::String,
+                                      ?filters: Array[
+                                        {
+                                          contact: {
+                                            channel: Array[::String]?,
+                                            contact_arn: ::String?
+                                          }?,
+                                          comment: {
+                                          }?,
+                                          file: {
+                                            file_arn: ::String?
+                                          }?,
+                                          sla: {
+                                            name: ::String?,
+                                            status: ("Active" | "Overdue" | "Met" | "NotMet")?
+                                          }?,
+                                          connect_case: {
+                                            case_id: ::String?
+                                          }?,
+                                          custom: {
+                                            fields: {
+                                              field: {
+                                                equal_to: {
+                                                  id: ::String,
+                                                  value: {
+                                                    string_value: ::String?,
+                                                    double_value: ::Float?,
+                                                    boolean_value: bool?,
+                                                    empty_value: {
+                                                    }?,
+                                                    user_arn_value: ::String?
+                                                  }
+                                                }?,
+                                                contains: {
+                                                  id: ::String,
+                                                  value: {
+                                                    string_value: ::String?,
+                                                    double_value: ::Float?,
+                                                    boolean_value: bool?,
+                                                    empty_value: {
+                                                    }?,
+                                                    user_arn_value: ::String?
+                                                  }
+                                                }?,
+                                                greater_than: {
+                                                  id: ::String,
+                                                  value: {
+                                                    string_value: ::String?,
+                                                    double_value: ::Float?,
+                                                    boolean_value: bool?,
+                                                    empty_value: {
+                                                    }?,
+                                                    user_arn_value: ::String?
+                                                  }
+                                                }?,
+                                                greater_than_or_equal_to: {
+                                                  id: ::String,
+                                                  value: {
+                                                    string_value: ::String?,
+                                                    double_value: ::Float?,
+                                                    boolean_value: bool?,
+                                                    empty_value: {
+                                                    }?,
+                                                    user_arn_value: ::String?
+                                                  }
+                                                }?,
+                                                less_than: {
+                                                  id: ::String,
+                                                  value: {
+                                                    string_value: ::String?,
+                                                    double_value: ::Float?,
+                                                    boolean_value: bool?,
+                                                    empty_value: {
+                                                    }?,
+                                                    user_arn_value: ::String?
+                                                  }
+                                                }?,
+                                                less_than_or_equal_to: {
+                                                  id: ::String,
+                                                  value: {
+                                                    string_value: ::String?,
+                                                    double_value: ::Float?,
+                                                    boolean_value: bool?,
+                                                    empty_value: {
+                                                    }?,
+                                                    user_arn_value: ::String?
+                                                  }
+                                                }?
+                                              }?,
+                                              not: untyped?,
+                                              and_all: Array[
+                                                untyped,
+                                              ]?,
+                                              or_all: Array[
+                                                untyped,
+                                              ]?
+                                            }?
+                                          }?
+                                        },
+                                      ],
+                                      ?sorts: Array[
+                                        {
+                                          sort_property: ("AssociationTime" | "CaseId"),
+                                          sort_order: ("Asc" | "Desc")
+                                        },
+                                      ]
+                                    ) -> _SearchAllRelatedItemsResponseSuccess
+                                  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SearchAllRelatedItemsResponseSuccess
+
       interface _SearchCasesResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::SearchCasesResponse]
         def next_token: () -> ::String

data/sig/types.rbs

@@ -967,6 +967,38 @@ module Aws::ConnectCases
       SENSITIVE: []
     end
 
+    class SearchAllRelatedItemsRequest
+      attr_accessor domain_id: ::String
+      attr_accessor max_results: ::Integer
+      attr_accessor next_token: ::String
+      attr_accessor filters: ::Array[Types::RelatedItemTypeFilter]
+      attr_accessor sorts: ::Array[Types::SearchAllRelatedItemsSort]
+      SENSITIVE: []
+    end
+
+    class SearchAllRelatedItemsResponse
+      attr_accessor next_token: ::String
+      attr_accessor related_items: ::Array[Types::SearchAllRelatedItemsResponseItem]
+      SENSITIVE: []
+    end
+
+    class SearchAllRelatedItemsResponseItem
+      attr_accessor related_item_id: ::String
+      attr_accessor case_id: ::String
+      attr_accessor type: ("Contact" | "Comment" | "File" | "Sla" | "ConnectCase" | "Custom")
+      attr_accessor association_time: ::Time
+      attr_accessor content: Types::RelatedItemContent
+      attr_accessor performed_by: Types::UserUnion
+      attr_accessor tags: ::Hash[::String, ::String]
+      SENSITIVE: []
+    end
+
+    class SearchAllRelatedItemsSort
+      attr_accessor sort_property: ("AssociationTime" | "CaseId")
+      attr_accessor sort_order: ("Asc" | "Desc")
+      SENSITIVE: []
+    end
+
     class SearchCasesRequest
       attr_accessor domain_id: ::String
       attr_accessor max_results: ::Integer

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-connectcases
 version: !ruby/object:Gem::Version
-  version: 1.51.0
+  version: 1.52.0
 platform: ruby
 authors:
 - Amazon Web Services