aws-sdk-customerprofiles 1.65.0 → 1.67.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57983d301343c1108fb02a4e1e4e39bbb81805f0cd5866e4196a9792c6ea40bf
-  data.tar.gz: 8056541db005d9a976e66a76797995cb40ee0ffd49d4e38199d7c75d4068f4af
+  metadata.gz: 948438e5243d77c73b8a46a0365347fc498d941db0faa566c5dc3a07cfb19cd4
+  data.tar.gz: 1872d9503f1a56d8a5d713c51ba00941600b810a72edf0b524e2712acd9f4d78
 SHA512:
-  metadata.gz: 6fa4d419f6e97d3d29af73d6b795e5c083f724786b635f596e0554443ba057ebf8e4280585e120820cec43b4c9a8f17d1431a1ba6e498be5a57ba15baf97f766
-  data.tar.gz: fa876cafce75ca8971102f2bd34f9b95cd49ddc58a86fc0c804f93bd7aa3d5741bbf0df2e20d160a007011249f05f25d2dd9b185b8572ea01d07cdf4d51d7f75
+  metadata.gz: 87ba17b54438276aa15a3f9e3ffe2328cf414fcae5d40d6c22cc8a9536c5c1cd9ed70ab3e659400f64026c268db5994735744ffffae8fb765fa8c04851ce8a14
+  data.tar.gz: 7cc86e757e763a6a1463c391a884555a5b148ca7766eb7665f2c0e6f6a7b6547abb1324b22951aed15b55dbf58cc79b780bba6c0172bcb5e5810f3a1c2ec1218

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.67.0 (2025-07-21)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.66.0 (2025-07-03)
+------------------
+
+* Feature - This release introduces capability of create Segments via importing a CSV file directly. This consumes the CSV file and creates/updates corresponding profiles for the particular domain.
+
 1.65.0 (2025-06-09)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.65.0
+1.67.0

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

@@ -95,7 +95,7 @@ module Aws::CustomerProfiles
     #     class name or an instance of a plugin class.
     #
     #   @option options [required, Aws::CredentialProvider] :credentials
-    #     Your AWS credentials. This can be an instance of any one of the
+    #     Your AWS credentials used for authentication. This can be an instance of any one of the
     #     following classes:
     #
     #     * `Aws::Credentials` - Used for configuring static, non-refreshing
@@ -128,18 +128,23 @@ module Aws::CustomerProfiles
     #     locations will be searched for credentials:
     #
     #     * `Aws.config[:credentials]`
+    #
     #     * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
     #       `:account_id` options.
-    #     * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'],
-    #       ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
+    #
+    #     * `ENV['AWS_ACCESS_KEY_ID']`, `ENV['AWS_SECRET_ACCESS_KEY']`,
+    #       `ENV['AWS_SESSION_TOKEN']`, and `ENV['AWS_ACCOUNT_ID']`.
+    #
     #     * `~/.aws/credentials`
+    #
     #     * `~/.aws/config`
+    #
     #     * EC2/ECS IMDS instance profile - When used by default, the timeouts
     #       are very aggressive. Construct and pass an instance of
     #       `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
     #       enable retries and extended timeouts. Instance profile credential
-    #       fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
-    #       to true.
+    #       fetching can be disabled by setting `ENV['AWS_EC2_METADATA_DISABLED']`
+    #       to `true`.
     #
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
@@ -167,6 +172,11 @@ module Aws::CustomerProfiles
     #     When false, the request will raise a `RetryCapacityNotAvailableError` and will
     #     not retry instead of sleeping.
     #
+    #   @option options [Array<String>] :auth_scheme_preference
+    #     A list of preferred authentication schemes to use when making a request. Supported values are:
+    #     `sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV['AWS_AUTH_SCHEME_PREFERENCE']` or in
+    #     shared config as `auth_scheme_preference`, the value should be a comma-separated list.
+    #
     #   @option options [Boolean] :client_side_monitoring (false)
     #     When `true`, client-side metrics will be collected for all API requests from
     #     this client.
@@ -253,8 +263,8 @@ module Aws::CustomerProfiles
     #     4 times. Used in `standard` and `adaptive` retry modes.
     #
     #   @option options [String] :profile ("default")
-    #     Used when loading credentials from the shared credentials file
-    #     at HOME/.aws/credentials.  When not specified, 'default' is used.
+    #     Used when loading credentials from the shared credentials file at `HOME/.aws/credentials`.
+    #     When not specified, 'default' is used.
     #
     #   @option options [String] :request_checksum_calculation ("when_supported")
     #     Determines when a checksum will be calculated for request payloads. Values are:
@@ -367,7 +377,7 @@ module Aws::CustomerProfiles
     #     `Aws::Telemetry::OTelProvider` for telemetry provider.
     #
     #   @option options [Aws::TokenProvider] :token_provider
-    #     A Bearer Token Provider. This can be an instance of any one of the
+    #     Your Bearer token used for authentication. This can be an instance of any one of the
     #     following classes:
     #
     #     * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
@@ -2177,6 +2187,62 @@ module Aws::CustomerProfiles
       req.send_request(options)
     end
 
+    # Creates an Upload job to ingest data for segment imports. The metadata
+    # is created for the job with the provided field mapping and unique key.
+    #
+    # @option params [required, String] :domain_name
+    #   The unique name of the domain. Domain should be exists for the upload
+    #   job to be created.
+    #
+    # @option params [required, String] :display_name
+    #   The unique name of the upload job. Could be a file name to identify
+    #   the upload job.
+    #
+    # @option params [required, Hash<String,Types::ObjectTypeField>] :fields
+    #   The mapping between CSV Columns and Profile Object attributes. A map
+    #   of the name and ObjectType field.
+    #
+    # @option params [required, String] :unique_key
+    #   The unique key columns for de-duping the profiles used to map data to
+    #   the profile.
+    #
+    # @option params [Integer] :data_expiry
+    #   The expiry duration for the profiles ingested with the job. If not
+    #   provided, the system default of 2 weeks is used.
+    #
+    # @return [Types::CreateUploadJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CreateUploadJobResponse#job_id #job_id} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_upload_job({
+    #     domain_name: "name", # required
+    #     display_name: "string1To255", # required
+    #     fields: { # required
+    #       "fieldName" => {
+    #         source: "text",
+    #         target: "text",
+    #         content_type: "STRING", # accepts STRING, NUMBER, PHONE_NUMBER, EMAIL_ADDRESS, NAME
+    #       },
+    #     },
+    #     unique_key: "text", # required
+    #     data_expiry: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.job_id #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateUploadJob AWS API Documentation
+    #
+    # @overload create_upload_job(params = {})
+    # @param [Hash] params ({})
+    def create_upload_job(params = {}, options = {})
+      req = build_request(:create_upload_job, params)
+      req.send_request(options)
+    end
+
     # Deletes an existing calculated attribute definition. Note that
     # deleting a default calculated attribute is possible, however once
     # deleted, you will be unable to undo that action and will need to
@@ -2598,9 +2664,9 @@ module Aws::CustomerProfiles
     #   resp.detected_profile_object_types #=> Array
     #   resp.detected_profile_object_types[0].source_last_updated_timestamp_format #=> String
     #   resp.detected_profile_object_types[0].fields #=> Hash
-    #   resp.detected_profile_object_types[0].fields["name"].source #=> String
-    #   resp.detected_profile_object_types[0].fields["name"].target #=> String
-    #   resp.detected_profile_object_types[0].fields["name"].content_type #=> String, one of "STRING", "NUMBER", "PHONE_NUMBER", "EMAIL_ADDRESS", "NAME"
+    #   resp.detected_profile_object_types[0].fields["fieldName"].source #=> String
+    #   resp.detected_profile_object_types[0].fields["fieldName"].target #=> String
+    #   resp.detected_profile_object_types[0].fields["fieldName"].content_type #=> String, one of "STRING", "NUMBER", "PHONE_NUMBER", "EMAIL_ADDRESS", "NAME"
     #   resp.detected_profile_object_types[0].keys #=> Hash
     #   resp.detected_profile_object_types[0].keys["name"] #=> Array
     #   resp.detected_profile_object_types[0].keys["name"][0].standard_identifiers #=> Array
@@ -3312,9 +3378,9 @@ module Aws::CustomerProfiles
     #   resp.max_available_profile_object_count #=> Integer
     #   resp.max_profile_object_count #=> Integer
     #   resp.fields #=> Hash
-    #   resp.fields["name"].source #=> String
-    #   resp.fields["name"].target #=> String
-    #   resp.fields["name"].content_type #=> String, one of "STRING", "NUMBER", "PHONE_NUMBER", "EMAIL_ADDRESS", "NAME"
+    #   resp.fields["fieldName"].source #=> String
+    #   resp.fields["fieldName"].target #=> String
+    #   resp.fields["fieldName"].content_type #=> String, one of "STRING", "NUMBER", "PHONE_NUMBER", "EMAIL_ADDRESS", "NAME"
     #   resp.keys #=> Hash
     #   resp.keys["name"] #=> Array
     #   resp.keys["name"][0].standard_identifiers #=> Array
@@ -3370,9 +3436,9 @@ module Aws::CustomerProfiles
     #   resp.allow_profile_creation #=> Boolean
     #   resp.source_last_updated_timestamp_format #=> String
     #   resp.fields #=> Hash
-    #   resp.fields["name"].source #=> String
-    #   resp.fields["name"].target #=> String
-    #   resp.fields["name"].content_type #=> String, one of "STRING", "NUMBER", "PHONE_NUMBER", "EMAIL_ADDRESS", "NAME"
+    #   resp.fields["fieldName"].source #=> String
+    #   resp.fields["fieldName"].target #=> String
+    #   resp.fields["fieldName"].content_type #=> String, one of "STRING", "NUMBER", "PHONE_NUMBER", "EMAIL_ADDRESS", "NAME"
     #   resp.keys #=> Hash
     #   resp.keys["name"] #=> Array
     #   resp.keys["name"][0].standard_identifiers #=> Array
@@ -3836,6 +3902,99 @@ module Aws::CustomerProfiles
       req.send_request(options)
     end
 
+    # This API retrieves the details of a specific upload job.
+    #
+    # @option params [required, String] :domain_name
+    #   The unique name of the domain containing the upload job.
+    #
+    # @option params [required, String] :job_id
+    #   The unique identifier of the upload job to retrieve.
+    #
+    # @return [Types::GetUploadJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetUploadJobResponse#job_id #job_id} => String
+    #   * {Types::GetUploadJobResponse#display_name #display_name} => String
+    #   * {Types::GetUploadJobResponse#status #status} => String
+    #   * {Types::GetUploadJobResponse#status_reason #status_reason} => String
+    #   * {Types::GetUploadJobResponse#created_at #created_at} => Time
+    #   * {Types::GetUploadJobResponse#completed_at #completed_at} => Time
+    #   * {Types::GetUploadJobResponse#fields #fields} => Hash&lt;String,Types::ObjectTypeField&gt;
+    #   * {Types::GetUploadJobResponse#unique_key #unique_key} => String
+    #   * {Types::GetUploadJobResponse#results_summary #results_summary} => Types::ResultsSummary
+    #   * {Types::GetUploadJobResponse#data_expiry #data_expiry} => Integer
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_upload_job({
+    #     domain_name: "name", # required
+    #     job_id: "uuid", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.job_id #=> String
+    #   resp.display_name #=> String
+    #   resp.status #=> String, one of "CREATED", "IN_PROGRESS", "PARTIALLY_SUCCEEDED", "SUCCEEDED", "FAILED", "STOPPED"
+    #   resp.status_reason #=> String, one of "VALIDATION_FAILURE", "INTERNAL_FAILURE"
+    #   resp.created_at #=> Time
+    #   resp.completed_at #=> Time
+    #   resp.fields #=> Hash
+    #   resp.fields["fieldName"].source #=> String
+    #   resp.fields["fieldName"].target #=> String
+    #   resp.fields["fieldName"].content_type #=> String, one of "STRING", "NUMBER", "PHONE_NUMBER", "EMAIL_ADDRESS", "NAME"
+    #   resp.unique_key #=> String
+    #   resp.results_summary.updated_records #=> Integer
+    #   resp.results_summary.created_records #=> Integer
+    #   resp.results_summary.failed_records #=> Integer
+    #   resp.data_expiry #=> Integer
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetUploadJob AWS API Documentation
+    #
+    # @overload get_upload_job(params = {})
+    # @param [Hash] params ({})
+    def get_upload_job(params = {}, options = {})
+      req = build_request(:get_upload_job, params)
+      req.send_request(options)
+    end
+
+    # This API retrieves the pre-signed URL and client token for uploading
+    # the file associated with the upload job.
+    #
+    # @option params [required, String] :domain_name
+    #   The unique name of the domain containing the upload job.
+    #
+    # @option params [required, String] :job_id
+    #   The unique identifier of the upload job to retrieve the upload path
+    #   for. This is generated from the CreateUploadJob API.
+    #
+    # @return [Types::GetUploadJobPathResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetUploadJobPathResponse#url #url} => String
+    #   * {Types::GetUploadJobPathResponse#client_token #client_token} => String
+    #   * {Types::GetUploadJobPathResponse#valid_until #valid_until} => Time
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_upload_job_path({
+    #     domain_name: "name", # required
+    #     job_id: "name", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.url #=> String
+    #   resp.client_token #=> String
+    #   resp.valid_until #=> Time
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetUploadJobPath AWS API Documentation
+    #
+    # @overload get_upload_job_path(params = {})
+    # @param [Hash] params ({})
+    def get_upload_job_path(params = {}, options = {})
+      req = build_request(:get_upload_job_path, params)
+      req.send_request(options)
+    end
+
     # Get details of specified workflow.
     #
     # @option params [required, String] :domain_name
@@ -4742,6 +4901,54 @@ module Aws::CustomerProfiles
       req.send_request(options)
     end
 
+    # This API retrieves a list of upload jobs for the specified domain.
+    #
+    # @option params [required, String] :domain_name
+    #   The unique name of the domain to list upload jobs for.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of upload jobs to return per page.
+    #
+    # @option params [String] :next_token
+    #   The pagination token from the previous call to retrieve the next page
+    #   of results.
+    #
+    # @return [Types::ListUploadJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListUploadJobsResponse#next_token #next_token} => String
+    #   * {Types::ListUploadJobsResponse#items #items} => Array&lt;Types::UploadJobItem&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.list_upload_jobs({
+    #     domain_name: "name", # required
+    #     max_results: 1,
+    #     next_token: "token",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.next_token #=> String
+    #   resp.items #=> Array
+    #   resp.items[0].job_id #=> String
+    #   resp.items[0].display_name #=> String
+    #   resp.items[0].status #=> String, one of "CREATED", "IN_PROGRESS", "PARTIALLY_SUCCEEDED", "SUCCEEDED", "FAILED", "STOPPED"
+    #   resp.items[0].status_reason #=> String, one of "VALIDATION_FAILURE", "INTERNAL_FAILURE"
+    #   resp.items[0].created_at #=> Time
+    #   resp.items[0].completed_at #=> Time
+    #   resp.items[0].data_expiry #=> Integer
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListUploadJobs AWS API Documentation
+    #
+    # @overload list_upload_jobs(params = {})
+    # @param [Hash] params ({})
+    def list_upload_jobs(params = {}, options = {})
+      req = build_request(:list_upload_jobs, params)
+      req.send_request(options)
+    end
+
     # Query to list all workflows.
     #
     # @option params [required, String] :domain_name
@@ -5209,7 +5416,7 @@ module Aws::CustomerProfiles
     #     source_last_updated_timestamp_format: "string1To255",
     #     max_profile_object_count: 1,
     #     fields: {
-    #       "name" => {
+    #       "fieldName" => {
     #         source: "text",
     #         target: "text",
     #         content_type: "STRING", # accepts STRING, NUMBER, PHONE_NUMBER, EMAIL_ADDRESS, NAME
@@ -5240,9 +5447,9 @@ module Aws::CustomerProfiles
     #   resp.max_profile_object_count #=> Integer
     #   resp.max_available_profile_object_count #=> Integer
     #   resp.fields #=> Hash
-    #   resp.fields["name"].source #=> String
-    #   resp.fields["name"].target #=> String
-    #   resp.fields["name"].content_type #=> String, one of "STRING", "NUMBER", "PHONE_NUMBER", "EMAIL_ADDRESS", "NAME"
+    #   resp.fields["fieldName"].source #=> String
+    #   resp.fields["fieldName"].target #=> String
+    #   resp.fields["fieldName"].content_type #=> String, one of "STRING", "NUMBER", "PHONE_NUMBER", "EMAIL_ADDRESS", "NAME"
     #   resp.keys #=> Hash
     #   resp.keys["name"] #=> Array
     #   resp.keys["name"][0].standard_identifiers #=> Array
@@ -5423,6 +5630,59 @@ module Aws::CustomerProfiles
       req.send_request(options)
     end
 
+    # This API starts the processing of an upload job to ingest profile
+    # data.
+    #
+    # @option params [required, String] :domain_name
+    #   The unique name of the domain containing the upload job to start.
+    #
+    # @option params [required, String] :job_id
+    #   The unique identifier of the upload job to start.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.start_upload_job({
+    #     domain_name: "name", # required
+    #     job_id: "name", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/StartUploadJob AWS API Documentation
+    #
+    # @overload start_upload_job(params = {})
+    # @param [Hash] params ({})
+    def start_upload_job(params = {}, options = {})
+      req = build_request(:start_upload_job, params)
+      req.send_request(options)
+    end
+
+    # This API stops the processing of an upload job.
+    #
+    # @option params [required, String] :domain_name
+    #   The unique name of the domain containing the upload job to stop.
+    #
+    # @option params [required, String] :job_id
+    #   The unique identifier of the upload job to stop.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.stop_upload_job({
+    #     domain_name: "name", # required
+    #     job_id: "name", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/StopUploadJob AWS API Documentation
+    #
+    # @overload stop_upload_job(params = {})
+    # @param [Hash] params ({})
+    def stop_upload_job(params = {}, options = {})
+      req = build_request(:stop_upload_job, params)
+      req.send_request(options)
+    end
+
     # Assigns one or more tags (key-value pairs) to the specified Amazon
     # Connect Customer Profiles resource. Tags can help you organize and
     # categorize your resources. You can also use them to scope user
@@ -6175,7 +6435,7 @@ module Aws::CustomerProfiles
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-customerprofiles'
-      context[:gem_version] = '1.65.0'
+      context[:gem_version] = '1.67.0'
       Seahorse::Client::Request.new(handlers, context)
     end