aws-sdk-customerprofiles 1.82.0 → 1.83.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9850ddf8b3128455298e2cbf8e4a4ac53d060798216b7e0cc85584d5e4af5548
-  data.tar.gz: bb2b622b123ab8137b38f3f03f7dda3dab9495d2fe092893b6096ff2be3f5625
+  metadata.gz: '098ee60b649bbecf6ccd20738d91dc32d4e847fc396e48d785994b47a196108b'
+  data.tar.gz: 4ff1a09307e275a40ed7f6a954db82ccafcda349f4625dce16a1d342178bedce
 SHA512:
-  metadata.gz: 10e2eb088a8db4a2207b48db69fadc50bf359a79ace25a1552cee3f650c9acb5a645d6c0c3eca585e95a261f7e0a815bab581fb032a911184fbcfdfff29f3e92
-  data.tar.gz: 6004cccfcba7acb9452193e756cb79b0c125597accbe6291323734de1a44e0436201066335cf1f496280a95e6b8fbf4d5ffc7c35699cc75a102285e53a388257
+  metadata.gz: 0d0b4024a098428ae397529af1a57c7bb99644946edfb87dc58e9743c2ca405a317186d4828102fe9ff8383384ee1cbf4c03d71218f5efb6639d8d3bf1447535
+  data.tar.gz: '09ae9e681e41d68c47d045b61cfea40361765789e5785e9b7ae7791a1550271e9a8487be4a625b49e56a906dda9a3e63342176a3810127cbd0d16e86af83ed58'

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.83.0 (2026-04-13)
+------------------
+
+* Feature - This release introduces changes to SegmentDefinition APIs to support sorting by attributes.
+
 1.82.0 (2026-03-18)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.82.0
+1.83.0

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

@@ -1807,6 +1807,9 @@ module Aws::CustomerProfiles
     # @option params [String] :segment_sql_query
     #   The segment SQL query.
     #
+    # @option params [Types::SegmentSort] :segment_sort
+    #   The segment sort.
+    #
     # @option params [Hash<String,String>] :tags
     #   The tags used to organize, track, or control access for this resource.
     #
@@ -2001,7 +2004,7 @@ module Aws::CustomerProfiles
     #                   },
     #                 },
     #                 attributes: {
-    #                   "typeName" => {
+    #                   "string1To255" => {
     #                     dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH, BEFORE, AFTER, BETWEEN, NOT_BETWEEN, ON, GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, EQUAL
     #                     values: ["string1To255"], # required
     #                   },
@@ -2038,6 +2041,16 @@ module Aws::CustomerProfiles
     #       include: "ALL", # accepts ALL, ANY, NONE
     #     },
     #     segment_sql_query: "sensitiveString1To50000",
+    #     segment_sort: {
+    #       attributes: [ # required
+    #         {
+    #           name: "fieldName", # required
+    #           data_type: "STRING", # accepts STRING, NUMBER, DATE
+    #           order: "ASC", # required, accepts ASC, DESC
+    #           type: "PROFILE", # accepts PROFILE, CALCULATED
+    #         },
+    #       ],
+    #     },
     #     tags: {
     #       "TagKey" => "TagValue",
     #     },
@@ -2258,7 +2271,7 @@ module Aws::CustomerProfiles
     #                   },
     #                 },
     #                 attributes: {
-    #                   "typeName" => {
+    #                   "string1To255" => {
     #                     dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH, BEFORE, AFTER, BETWEEN, NOT_BETWEEN, ON, GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, EQUAL
     #                     values: ["string1To255"], # required
     #                   },
@@ -4129,6 +4142,7 @@ module Aws::CustomerProfiles
     #   * {Types::GetSegmentDefinitionResponse#display_name #display_name} => String
     #   * {Types::GetSegmentDefinitionResponse#description #description} => String
     #   * {Types::GetSegmentDefinitionResponse#segment_groups #segment_groups} => Types::SegmentGroup
+    #   * {Types::GetSegmentDefinitionResponse#segment_sort #segment_sort} => Types::SegmentSort
     #   * {Types::GetSegmentDefinitionResponse#segment_definition_arn #segment_definition_arn} => String
     #   * {Types::GetSegmentDefinitionResponse#created_at #created_at} => Time
     #   * {Types::GetSegmentDefinitionResponse#tags #tags} => Hash&lt;String,String&gt;
@@ -4270,9 +4284,9 @@ module Aws::CustomerProfiles
     #   resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.state.values #=> Array
     #   resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.state.values[0] #=> String
     #   resp.segment_groups.groups[0].dimensions[0].profile_attributes.attributes #=> Hash
-    #   resp.segment_groups.groups[0].dimensions[0].profile_attributes.attributes["typeName"].dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH", "BEFORE", "AFTER", "BETWEEN", "NOT_BETWEEN", "ON", "GREATER_THAN", "LESS_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN_OR_EQUAL", "EQUAL"
-    #   resp.segment_groups.groups[0].dimensions[0].profile_attributes.attributes["typeName"].values #=> Array
-    #   resp.segment_groups.groups[0].dimensions[0].profile_attributes.attributes["typeName"].values[0] #=> String
+    #   resp.segment_groups.groups[0].dimensions[0].profile_attributes.attributes["string1To255"].dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH", "BEFORE", "AFTER", "BETWEEN", "NOT_BETWEEN", "ON", "GREATER_THAN", "LESS_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN_OR_EQUAL", "EQUAL"
+    #   resp.segment_groups.groups[0].dimensions[0].profile_attributes.attributes["string1To255"].values #=> Array
+    #   resp.segment_groups.groups[0].dimensions[0].profile_attributes.attributes["string1To255"].values[0] #=> String
     #   resp.segment_groups.groups[0].dimensions[0].profile_attributes.profile_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
     #   resp.segment_groups.groups[0].dimensions[0].profile_attributes.profile_type.values #=> Array
     #   resp.segment_groups.groups[0].dimensions[0].profile_attributes.profile_type.values[0] #=> String, one of "ACCOUNT_PROFILE", "PROFILE"
@@ -4288,6 +4302,11 @@ module Aws::CustomerProfiles
     #   resp.segment_groups.groups[0].source_type #=> String, one of "ALL", "ANY", "NONE"
     #   resp.segment_groups.groups[0].type #=> String, one of "ALL", "ANY", "NONE"
     #   resp.segment_groups.include #=> String, one of "ALL", "ANY", "NONE"
+    #   resp.segment_sort.attributes #=> Array
+    #   resp.segment_sort.attributes[0].name #=> String
+    #   resp.segment_sort.attributes[0].data_type #=> String, one of "STRING", "NUMBER", "DATE"
+    #   resp.segment_sort.attributes[0].order #=> String, one of "ASC", "DESC"
+    #   resp.segment_sort.attributes[0].type #=> String, one of "PROFILE", "CALCULATED"
     #   resp.segment_definition_arn #=> String
     #   resp.created_at #=> Time
     #   resp.tags #=> Hash
@@ -7702,7 +7721,7 @@ module Aws::CustomerProfiles
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-customerprofiles'
-      context[:gem_version] = '1.82.0'
+      context[:gem_version] = '1.83.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -475,9 +475,15 @@ module Aws::CustomerProfiles
     SegmentGroupList = Shapes::ListShape.new(name: 'SegmentGroupList')
     SegmentGroupStructure = Shapes::StructureShape.new(name: 'SegmentGroupStructure')
     SegmentSnapshotStatus = Shapes::StringShape.new(name: 'SegmentSnapshotStatus')
+    SegmentSort = Shapes::StructureShape.new(name: 'SegmentSort')
+    SegmentSortDataType = Shapes::StringShape.new(name: 'SegmentSortDataType')
+    SegmentSortOrder = Shapes::StringShape.new(name: 'SegmentSortOrder')
     SegmentType = Shapes::StringShape.new(name: 'SegmentType')
     ServiceNowConnectorOperator = Shapes::StringShape.new(name: 'ServiceNowConnectorOperator')
     ServiceNowSourceProperties = Shapes::StructureShape.new(name: 'ServiceNowSourceProperties')
+    SortAttribute = Shapes::StructureShape.new(name: 'SortAttribute')
+    SortAttributeList = Shapes::ListShape.new(name: 'SortAttributeList')
+    SortAttributeType = Shapes::StringShape.new(name: 'SortAttributeType')
     SourceConnectorProperties = Shapes::StructureShape.new(name: 'SourceConnectorProperties')
     SourceConnectorType = Shapes::StringShape.new(name: 'SourceConnectorType')
     SourceFields = Shapes::ListShape.new(name: 'SourceFields')
@@ -992,6 +998,7 @@ module Aws::CustomerProfiles
     CreateSegmentDefinitionRequest.add_member(:description, Shapes::ShapeRef.new(shape: sensitiveString1To4000, location_name: "Description"))
     CreateSegmentDefinitionRequest.add_member(:segment_groups, Shapes::ShapeRef.new(shape: SegmentGroup, location_name: "SegmentGroups"))
     CreateSegmentDefinitionRequest.add_member(:segment_sql_query, Shapes::ShapeRef.new(shape: sensitiveString1To50000, location_name: "SegmentSqlQuery"))
+    CreateSegmentDefinitionRequest.add_member(:segment_sort, Shapes::ShapeRef.new(shape: SegmentSort, location_name: "SegmentSort"))
     CreateSegmentDefinitionRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
     CreateSegmentDefinitionRequest.struct_class = Types::CreateSegmentDefinitionRequest
 
@@ -1034,7 +1041,7 @@ module Aws::CustomerProfiles
     CreateUploadJobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: uuid, required: true, location_name: "JobId"))
     CreateUploadJobResponse.struct_class = Types::CreateUploadJobResponse
 
-    CustomAttributes.key = Shapes::ShapeRef.new(shape: typeName)
+    CustomAttributes.key = Shapes::ShapeRef.new(shape: string1To255)
     CustomAttributes.value = Shapes::ShapeRef.new(shape: AttributeDimension)
 
     DataStoreRequest.add_member(:enabled, Shapes::ShapeRef.new(shape: optionalBoolean, location_name: "Enabled"))
@@ -1631,6 +1638,7 @@ module Aws::CustomerProfiles
     GetSegmentDefinitionResponse.add_member(:display_name, Shapes::ShapeRef.new(shape: string1To255, location_name: "DisplayName"))
     GetSegmentDefinitionResponse.add_member(:description, Shapes::ShapeRef.new(shape: sensitiveString1To4000, location_name: "Description"))
     GetSegmentDefinitionResponse.add_member(:segment_groups, Shapes::ShapeRef.new(shape: SegmentGroup, location_name: "SegmentGroups"))
+    GetSegmentDefinitionResponse.add_member(:segment_sort, Shapes::ShapeRef.new(shape: SegmentSort, location_name: "SegmentSort"))
     GetSegmentDefinitionResponse.add_member(:segment_definition_arn, Shapes::ShapeRef.new(shape: SegmentDefinitionArn, required: true, location_name: "SegmentDefinitionArn"))
     GetSegmentDefinitionResponse.add_member(:created_at, Shapes::ShapeRef.new(shape: timestamp, location_name: "CreatedAt"))
     GetSegmentDefinitionResponse.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
@@ -2560,9 +2568,20 @@ module Aws::CustomerProfiles
     SegmentGroupStructure.add_member(:include, Shapes::ShapeRef.new(shape: IncludeOptions, location_name: "Include"))
     SegmentGroupStructure.struct_class = Types::SegmentGroupStructure
 
+    SegmentSort.add_member(:attributes, Shapes::ShapeRef.new(shape: SortAttributeList, required: true, location_name: "Attributes"))
+    SegmentSort.struct_class = Types::SegmentSort
+
     ServiceNowSourceProperties.add_member(:object, Shapes::ShapeRef.new(shape: Object, required: true, location_name: "Object"))
     ServiceNowSourceProperties.struct_class = Types::ServiceNowSourceProperties
 
+    SortAttribute.add_member(:name, Shapes::ShapeRef.new(shape: fieldName, required: true, location_name: "Name"))
+    SortAttribute.add_member(:data_type, Shapes::ShapeRef.new(shape: SegmentSortDataType, location_name: "DataType"))
+    SortAttribute.add_member(:order, Shapes::ShapeRef.new(shape: SegmentSortOrder, required: true, location_name: "Order"))
+    SortAttribute.add_member(:type, Shapes::ShapeRef.new(shape: SortAttributeType, location_name: "Type"))
+    SortAttribute.struct_class = Types::SortAttribute
+
+    SortAttributeList.member = Shapes::ShapeRef.new(shape: SortAttribute)
+
     SourceConnectorProperties.add_member(:marketo, Shapes::ShapeRef.new(shape: MarketoSourceProperties, location_name: "Marketo"))
     SourceConnectorProperties.add_member(:s3, Shapes::ShapeRef.new(shape: S3SourceProperties, location_name: "S3"))
     SourceConnectorProperties.add_member(:salesforce, Shapes::ShapeRef.new(shape: SalesforceSourceProperties, location_name: "Salesforce"))

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

@@ -1909,6 +1909,10 @@ module Aws::CustomerProfiles
     #   The segment SQL query.
     #   @return [String]
     #
+    # @!attribute [rw] segment_sort
+    #   The segment sort.
+    #   @return [Types::SegmentSort]
+    #
     # @!attribute [rw] tags
     #   The tags used to organize, track, or control access for this
     #   resource.
@@ -1923,8 +1927,9 @@ module Aws::CustomerProfiles
       :description,
       :segment_groups,
       :segment_sql_query,
+      :segment_sort,
       :tags)
-      SENSITIVE = [:description, :segment_groups, :segment_sql_query]
+      SENSITIVE = [:description, :segment_groups, :segment_sql_query, :segment_sort]
       include Aws::Structure
     end
 
@@ -4815,6 +4820,10 @@ module Aws::CustomerProfiles
     #   The segment criteria associated with this definition.
     #   @return [Types::SegmentGroup]
     #
+    # @!attribute [rw] segment_sort
+    #   The segment sort.
+    #   @return [Types::SegmentSort]
+    #
     # @!attribute [rw] segment_definition_arn
     #   The arn of the segment definition.
     #   @return [String]
@@ -4847,12 +4856,13 @@ module Aws::CustomerProfiles
       :display_name,
       :description,
       :segment_groups,
+      :segment_sort,
       :segment_definition_arn,
       :created_at,
       :tags,
       :segment_sql_query,
       :segment_type)
-      SENSITIVE = [:description, :segment_groups, :segment_sql_query]
+      SENSITIVE = [:description, :segment_groups, :segment_sort, :segment_sql_query]
       include Aws::Structure
     end
 
@@ -9246,6 +9256,21 @@ module Aws::CustomerProfiles
       include Aws::Structure
     end
 
+    # Defines how segments should be sorted and ordered in the results.
+    #
+    # @!attribute [rw] attributes
+    #   A list of attributes used to sort the segments and their ordering
+    #   preferences.
+    #   @return [Array<Types::SortAttribute>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/SegmentSort AWS API Documentation
+    #
+    class SegmentSort < Struct.new(
+      :attributes)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The properties that are applied when ServiceNow is being used as a
     # source.
     #
@@ -9261,6 +9286,36 @@ module Aws::CustomerProfiles
       include Aws::Structure
     end
 
+    # Defines the characteristics and rules for sorting by a specific
+    # attribute.
+    #
+    # @!attribute [rw] name
+    #   The name of the attribute to sort by.
+    #   @return [String]
+    #
+    # @!attribute [rw] data_type
+    #   The data type of the sort attribute (e.g., string, number, date).
+    #   @return [String]
+    #
+    # @!attribute [rw] order
+    #   The sort order for the attribute (ascending or descending).
+    #   @return [String]
+    #
+    # @!attribute [rw] type
+    #   The type of attribute (e.g., profile, calculated).
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/SortAttribute AWS API Documentation
+    #
+    class SortAttribute < Struct.new(
+      :name,
+      :data_type,
+      :order,
+      :type)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Specifies the information that is required to query a particular
     # Amazon AppFlow connector. Customer Profiles supports Salesforce,
     # Zendesk, Marketo, ServiceNow and Amazon S3.

data/lib/aws-sdk-customerprofiles.rb

@@ -54,7 +54,7 @@ module Aws::CustomerProfiles
   autoload :EndpointProvider, 'aws-sdk-customerprofiles/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-customerprofiles/endpoints'
 
-  GEM_VERSION = '1.82.0'
+  GEM_VERSION = '1.83.0'
 
 end
 

data/sig/client.rbs

@@ -813,6 +813,16 @@ module Aws
                                          include: ("ALL" | "ANY" | "NONE")?
                                        },
                                        ?segment_sql_query: ::String,
+                                       ?segment_sort: {
+                                         attributes: Array[
+                                           {
+                                             name: ::String,
+                                             data_type: ("STRING" | "NUMBER" | "DATE")?,
+                                             order: ("ASC" | "DESC"),
+                                             type: ("PROFILE" | "CALCULATED")?
+                                           },
+                                         ]
+                                       },
                                        ?tags: Hash[::String, ::String]
                                      ) -> _CreateSegmentDefinitionResponseSuccess
                                    | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateSegmentDefinitionResponseSuccess
@@ -1607,6 +1617,7 @@ module Aws
         def display_name: () -> ::String
         def description: () -> ::String
         def segment_groups: () -> Types::SegmentGroup
+        def segment_sort: () -> Types::SegmentSort
         def segment_definition_arn: () -> ::String
         def created_at: () -> ::Time
         def tags: () -> ::Hash[::String, ::String]

data/sig/types.rbs

@@ -464,8 +464,9 @@ module Aws::CustomerProfiles
       attr_accessor description: ::String
       attr_accessor segment_groups: Types::SegmentGroup
       attr_accessor segment_sql_query: ::String
+      attr_accessor segment_sort: Types::SegmentSort
       attr_accessor tags: ::Hash[::String, ::String]
-      SENSITIVE: [:description, :segment_groups, :segment_sql_query]
+      SENSITIVE: [:description, :segment_groups, :segment_sql_query, :segment_sort]
     end
 
     class CreateSegmentDefinitionResponse
@@ -1271,12 +1272,13 @@ module Aws::CustomerProfiles
       attr_accessor display_name: ::String
       attr_accessor description: ::String
       attr_accessor segment_groups: Types::SegmentGroup
+      attr_accessor segment_sort: Types::SegmentSort
       attr_accessor segment_definition_arn: ::String
       attr_accessor created_at: ::Time
       attr_accessor tags: ::Hash[::String, ::String]
       attr_accessor segment_sql_query: ::String
       attr_accessor segment_type: ("CLASSIC" | "ENHANCED")
-      SENSITIVE: [:description, :segment_groups, :segment_sql_query]
+      SENSITIVE: [:description, :segment_groups, :segment_sort, :segment_sql_query]
     end
 
     class GetSegmentEstimateRequest
@@ -2388,11 +2390,24 @@ module Aws::CustomerProfiles
       SENSITIVE: []
     end
 
+    class SegmentSort
+      attr_accessor attributes: ::Array[Types::SortAttribute]
+      SENSITIVE: []
+    end
+
     class ServiceNowSourceProperties
       attr_accessor object: ::String
       SENSITIVE: []
     end
 
+    class SortAttribute
+      attr_accessor name: ::String
+      attr_accessor data_type: ("STRING" | "NUMBER" | "DATE")
+      attr_accessor order: ("ASC" | "DESC")
+      attr_accessor type: ("PROFILE" | "CALCULATED")
+      SENSITIVE: []
+    end
+
     class SourceConnectorProperties
       attr_accessor marketo: Types::MarketoSourceProperties
       attr_accessor s3: Types::S3SourceProperties

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-customerprofiles
 version: !ruby/object:Gem::Version
-  version: 1.82.0
+  version: 1.83.0
 platform: ruby
 authors:
 - Amazon Web Services