CustomerProfiles
****************


Client
======

class CustomerProfiles.Client

   A low-level client representing Amazon Connect Customer Profiles

   * Customer Profiles actions

   * Customer Profiles data types

   Amazon Connect Customer Profiles is a unified customer profile for
   your contact center that has pre-built connectors powered by
   AppFlow that make it easy to combine customer information from
   third party applications, such as Salesforce (CRM), ServiceNow
   (ITSM), and your enterprise resource planning (ERP), with contact
   history from your Amazon Connect contact center.

   For more information about the Amazon Connect Customer Profiles
   feature, see Use Customer Profiles in the *Amazon Connect
   Administrator's Guide*.

      import boto3

      client = boto3.client('customer-profiles')

These are the available methods:

* add_profile_key

* batch_get_calculated_attribute_for_profile

* batch_get_profile

* can_paginate

* close

* create_calculated_attribute_definition

* create_domain

* create_domain_layout

* create_event_stream

* create_event_trigger

* create_integration_workflow

* create_profile

* create_segment_definition

* create_segment_estimate

* create_segment_snapshot

* create_upload_job

* delete_calculated_attribute_definition

* delete_domain

* delete_domain_layout

* delete_event_stream

* delete_event_trigger

* delete_integration

* delete_profile

* delete_profile_key

* delete_profile_object

* delete_profile_object_type

* delete_segment_definition

* delete_workflow

* detect_profile_object_type

* get_auto_merging_preview

* get_calculated_attribute_definition

* get_calculated_attribute_for_profile

* get_domain

* get_domain_layout

* get_event_stream

* get_event_trigger

* get_identity_resolution_job

* get_integration

* get_matches

* get_paginator

* get_profile_object_type

* get_profile_object_type_template

* get_segment_definition

* get_segment_estimate

* get_segment_membership

* get_segment_snapshot

* get_similar_profiles

* get_upload_job

* get_upload_job_path

* get_waiter

* get_workflow

* get_workflow_steps

* list_account_integrations

* list_calculated_attribute_definitions

* list_calculated_attributes_for_profile

* list_domain_layouts

* list_domains

* list_event_streams

* list_event_triggers

* list_identity_resolution_jobs

* list_integrations

* list_object_type_attributes

* list_profile_attribute_values

* list_profile_object_type_templates

* list_profile_object_types

* list_profile_objects

* list_rule_based_matches

* list_segment_definitions

* list_tags_for_resource

* list_upload_jobs

* list_workflows

* merge_profiles

* put_integration

* put_profile_object

* put_profile_object_type

* search_profiles

* start_upload_job

* stop_upload_job

* tag_resource

* untag_resource

* update_calculated_attribute_definition

* update_domain

* update_domain_layout

* update_event_trigger

* update_profile


Paginators
==========

Paginators are available on a client instance via the "get_paginator"
method. For more detailed instructions and examples on the usage of
paginators, see the paginators user guide.

The available paginators are:

* GetSimilarProfiles

* ListDomainLayouts

* ListEventStreams

* ListEventTriggers

* ListObjectTypeAttributes

* ListRuleBasedMatches

* ListSegmentDefinitions

* ListUploadJobs
CustomerProfiles / Paginator / GetSimilarProfiles


GetSimilarProfiles
******************

class CustomerProfiles.Paginator.GetSimilarProfiles

      paginator = client.get_paginator('get_similar_profiles')

   paginate(**kwargs)

      Creates an iterator that will paginate through responses from
      "CustomerProfiles.Client.get_similar_profiles()".

      See also: AWS API Documentation

      **Request Syntax**

         response_iterator = paginator.paginate(
             DomainName='string',
             MatchType='RULE_BASED_MATCHING'|'ML_BASED_MATCHING',
             SearchKey='string',
             SearchValue='string',
             PaginationConfig={
                 'MaxItems': 123,
                 'PageSize': 123,
                 'StartingToken': 'string'
             }
         )

      Parameters:
         * **DomainName** (*string*) --

           **[REQUIRED]**

           The unique name of the domain.

         * **MatchType** (*string*) --

           **[REQUIRED]**

           Specify the type of matching to get similar profiles for.

         * **SearchKey** (*string*) --

           **[REQUIRED]**

           The string indicating the search key to be used.

         * **SearchValue** (*string*) --

           **[REQUIRED]**

           The string based on "SearchKey" to be searched for similar
           profiles.

         * **PaginationConfig** (*dict*) --

           A dictionary that provides parameters to control
           pagination.

           * **MaxItems** *(integer) --*

             The total number of items to return. If the total number
             of items available is more than the value specified in
             max-items then a "NextToken" will be provided in the
             output that you can use to resume pagination.

           * **PageSize** *(integer) --*

             The size of each page.

           * **StartingToken** *(string) --*

             A token to specify where to start paginating. This is the
             "NextToken" from a previous response.

      Return type:
         dict

      Returns:
         **Response Syntax**

            {
                'ProfileIds': [
                    'string',
                ],
                'MatchId': 'string',
                'MatchType': 'RULE_BASED_MATCHING'|'ML_BASED_MATCHING',
                'RuleLevel': 123,
                'ConfidenceScore': 123.0,

            }

         **Response Structure**

         * *(dict) --*

           * **ProfileIds** *(list) --*

             Set of >>``<<profileId``s that belong to the same
             matching group.

             * *(string) --*

           * **MatchId** *(string) --*

             The string "matchId" that the similar profiles belong to.

           * **MatchType** *(string) --*

             Specify the type of matching to get similar profiles for.

           * **RuleLevel** *(integer) --*

             The integer rule level that the profiles matched on.

           * **ConfidenceScore** *(float) --*

             It only has value when the "MatchType" is
             "ML_BASED_MATCHING".A number between 0 and 1, where a
             higher score means higher similarity. Examining match
             confidence scores lets you distinguish between groups of
             similar records in which the system is highly confident
             (which you may decide to merge), groups of similar
             records about which the system is uncertain (which you
             may decide to have reviewed by a human), and groups of
             similar records that the system deems to be unlikely
             (which you may decide to reject). Given confidence scores
             vary as per the data input, it should not be used as an
             absolute measure of matching quality.
CustomerProfiles / Paginator / ListEventTriggers


ListEventTriggers
*****************

class CustomerProfiles.Paginator.ListEventTriggers

      paginator = client.get_paginator('list_event_triggers')

   paginate(**kwargs)

      Creates an iterator that will paginate through responses from
      "CustomerProfiles.Client.list_event_triggers()".

      See also: AWS API Documentation

      **Request Syntax**

         response_iterator = paginator.paginate(
             DomainName='string',
             PaginationConfig={
                 'MaxItems': 123,
                 'PageSize': 123,
                 'StartingToken': 'string'
             }
         )

      Parameters:
         * **DomainName** (*string*) --

           **[REQUIRED]**

           The unique name of the domain.

         * **PaginationConfig** (*dict*) --

           A dictionary that provides parameters to control
           pagination.

           * **MaxItems** *(integer) --*

             The total number of items to return. If the total number
             of items available is more than the value specified in
             max-items then a "NextToken" will be provided in the
             output that you can use to resume pagination.

           * **PageSize** *(integer) --*

             The size of each page.

           * **StartingToken** *(string) --*

             A token to specify where to start paginating. This is the
             "NextToken" from a previous response.

      Return type:
         dict

      Returns:
         **Response Syntax**

            {
                'Items': [
                    {
                        'ObjectTypeName': 'string',
                        'EventTriggerName': 'string',
                        'Description': 'string',
                        'CreatedAt': datetime(2015, 1, 1),
                        'LastUpdatedAt': datetime(2015, 1, 1),
                        'Tags': {
                            'string': 'string'
                        }
                    },
                ],

            }

         **Response Structure**

         * *(dict) --*

           * **Items** *(list) --*

             The list of Event Triggers.

             * *(dict) --*

               The summary of the event trigger.

               * **ObjectTypeName** *(string) --*

                 The unique name of the object type.

               * **EventTriggerName** *(string) --*

                 The unique name of the event trigger.

               * **Description** *(string) --*

                 The description of the event trigger.

               * **CreatedAt** *(datetime) --*

                 The timestamp of when the event trigger was created.

               * **LastUpdatedAt** *(datetime) --*

                 The timestamp of when the event trigger was most
                 recently updated.

               * **Tags** *(dict) --*

                 An array of key-value pairs to apply to this
                 resource.

                 * *(string) --*

                   * *(string) --*
CustomerProfiles / Paginator / ListEventStreams


ListEventStreams
****************

class CustomerProfiles.Paginator.ListEventStreams

      paginator = client.get_paginator('list_event_streams')

   paginate(**kwargs)

      Creates an iterator that will paginate through responses from
      "CustomerProfiles.Client.list_event_streams()".

      See also: AWS API Documentation

      **Request Syntax**

         response_iterator = paginator.paginate(
             DomainName='string',
             PaginationConfig={
                 'MaxItems': 123,
                 'PageSize': 123,
                 'StartingToken': 'string'
             }
         )

      Parameters:
         * **DomainName** (*string*) --

           **[REQUIRED]**

           The unique name of the domain.

         * **PaginationConfig** (*dict*) --

           A dictionary that provides parameters to control
           pagination.

           * **MaxItems** *(integer) --*

             The total number of items to return. If the total number
             of items available is more than the value specified in
             max-items then a "NextToken" will be provided in the
             output that you can use to resume pagination.

           * **PageSize** *(integer) --*

             The size of each page.

           * **StartingToken** *(string) --*

             A token to specify where to start paginating. This is the
             "NextToken" from a previous response.

      Return type:
         dict

      Returns:
         **Response Syntax**

            {
                'Items': [
                    {
                        'DomainName': 'string',
                        'EventStreamName': 'string',
                        'EventStreamArn': 'string',
                        'State': 'RUNNING'|'STOPPED',
                        'StoppedSince': datetime(2015, 1, 1),
                        'DestinationSummary': {
                            'Uri': 'string',
                            'Status': 'HEALTHY'|'UNHEALTHY',
                            'UnhealthySince': datetime(2015, 1, 1)
                        },
                        'Tags': {
                            'string': 'string'
                        }
                    },
                ],

            }

         **Response Structure**

         * *(dict) --*

           * **Items** *(list) --*

             Contains summary information about an EventStream.

             * *(dict) --*

               An instance of EventStream in a list of EventStreams.

               * **DomainName** *(string) --*

                 The unique name of the domain.

               * **EventStreamName** *(string) --*

                 The name of the event stream.

               * **EventStreamArn** *(string) --*

                 A unique identifier for the event stream.

               * **State** *(string) --*

                 The operational state of destination stream for
                 export.

               * **StoppedSince** *(datetime) --*

                 The timestamp when the "State" changed to "STOPPED".

               * **DestinationSummary** *(dict) --*

                 Summary information about the Kinesis data stream.

                 * **Uri** *(string) --*

                   The StreamARN of the destination to deliver profile
                   events to. For example, arn:aws:kinesis:region
                   :account-id:stream/stream-name.

                 * **Status** *(string) --*

                   The status of enabling the Kinesis stream as a
                   destination for export.

                 * **UnhealthySince** *(datetime) --*

                   The timestamp when the status last changed to
                   "UNHEALHY".

               * **Tags** *(dict) --*

                 The tags used to organize, track, or control access
                 for this resource.

                 * *(string) --*

                   * *(string) --*
CustomerProfiles / Paginator / ListRuleBasedMatches


ListRuleBasedMatches
********************

class CustomerProfiles.Paginator.ListRuleBasedMatches

      paginator = client.get_paginator('list_rule_based_matches')

   paginate(**kwargs)

      Creates an iterator that will paginate through responses from
      "CustomerProfiles.Client.list_rule_based_matches()".

      See also: AWS API Documentation

      **Request Syntax**

         response_iterator = paginator.paginate(
             DomainName='string',
             PaginationConfig={
                 'MaxItems': 123,
                 'PageSize': 123,
                 'StartingToken': 'string'
             }
         )

      Parameters:
         * **DomainName** (*string*) --

           **[REQUIRED]**

           The unique name of the domain.

         * **PaginationConfig** (*dict*) --

           A dictionary that provides parameters to control
           pagination.

           * **MaxItems** *(integer) --*

             The total number of items to return. If the total number
             of items available is more than the value specified in
             max-items then a "NextToken" will be provided in the
             output that you can use to resume pagination.

           * **PageSize** *(integer) --*

             The size of each page.

           * **StartingToken** *(string) --*

             A token to specify where to start paginating. This is the
             "NextToken" from a previous response.

      Return type:
         dict

      Returns:
         **Response Syntax**

            {
                'MatchIds': [
                    'string',
                ],

            }

         **Response Structure**

         * *(dict) --*

           * **MatchIds** *(list) --*

             The list of "MatchIds" for the given domain.

             * *(string) --*
CustomerProfiles / Paginator / ListObjectTypeAttributes


ListObjectTypeAttributes
************************

class CustomerProfiles.Paginator.ListObjectTypeAttributes

      paginator = client.get_paginator('list_object_type_attributes')

   paginate(**kwargs)

      Creates an iterator that will paginate through responses from
      "CustomerProfiles.Client.list_object_type_attributes()".

      See also: AWS API Documentation

      **Request Syntax**

         response_iterator = paginator.paginate(
             DomainName='string',
             ObjectTypeName='string',
             PaginationConfig={
                 'MaxItems': 123,
                 'PageSize': 123,
                 'StartingToken': 'string'
             }
         )

      Parameters:
         * **DomainName** (*string*) --

           **[REQUIRED]**

           The unique identifier of the domain.

         * **ObjectTypeName** (*string*) --

           **[REQUIRED]**

           The name of the profile object type.

         * **PaginationConfig** (*dict*) --

           A dictionary that provides parameters to control
           pagination.

           * **MaxItems** *(integer) --*

             The total number of items to return. If the total number
             of items available is more than the value specified in
             max-items then a "NextToken" will be provided in the
             output that you can use to resume pagination.

           * **PageSize** *(integer) --*

             The size of each page.

           * **StartingToken** *(string) --*

             A token to specify where to start paginating. This is the
             "NextToken" from a previous response.

      Return type:
         dict

      Returns:
         **Response Syntax**

            {
                'Items': [
                    {
                        'AttributeName': 'string',
                        'LastUpdatedAt': datetime(2015, 1, 1)
                    },
                ],

            }

         **Response Structure**

         * *(dict) --*

           * **Items** *(list) --*

             The items returned as part of the response.

             * *(dict) --*

               Item that contains the attribute and when it was last
               updated.

               * **AttributeName** *(string) --*

                 Name of the attribute.

               * **LastUpdatedAt** *(datetime) --*

                 When the attribute was last updated.
CustomerProfiles / Paginator / ListSegmentDefinitions


ListSegmentDefinitions
**********************

class CustomerProfiles.Paginator.ListSegmentDefinitions

      paginator = client.get_paginator('list_segment_definitions')

   paginate(**kwargs)

      Creates an iterator that will paginate through responses from
      "CustomerProfiles.Client.list_segment_definitions()".

      See also: AWS API Documentation

      **Request Syntax**

         response_iterator = paginator.paginate(
             DomainName='string',
             PaginationConfig={
                 'MaxItems': 123,
                 'PageSize': 123,
                 'StartingToken': 'string'
             }
         )

      Parameters:
         * **DomainName** (*string*) --

           **[REQUIRED]**

           The unique identifier of the domain.

         * **PaginationConfig** (*dict*) --

           A dictionary that provides parameters to control
           pagination.

           * **MaxItems** *(integer) --*

             The total number of items to return. If the total number
             of items available is more than the value specified in
             max-items then a "NextToken" will be provided in the
             output that you can use to resume pagination.

           * **PageSize** *(integer) --*

             The size of each page.

           * **StartingToken** *(string) --*

             A token to specify where to start paginating. This is the
             "NextToken" from a previous response.

      Return type:
         dict

      Returns:
         **Response Syntax**

            {
                'Items': [
                    {
                        'SegmentDefinitionName': 'string',
                        'DisplayName': 'string',
                        'Description': 'string',
                        'SegmentDefinitionArn': 'string',
                        'CreatedAt': datetime(2015, 1, 1),
                        'Tags': {
                            'string': 'string'
                        }
                    },
                ]
            }

         **Response Structure**

         * *(dict) --*

           * **Items** *(list) --*

             List of segment definitions.

             * *(dict) --*

               Object holding the segment definition fields.

               * **SegmentDefinitionName** *(string) --*

                 Name of the segment definition.

               * **DisplayName** *(string) --*

                 Display name of the segment definition.

               * **Description** *(string) --*

                 The description of the segment definition.

               * **SegmentDefinitionArn** *(string) --*

                 The arn of the segment definition.

               * **CreatedAt** *(datetime) --*

                 When the segment definition was created.

               * **Tags** *(dict) --*

                 The tags belonging to the segment definition.

                 * *(string) --*

                   * *(string) --*
CustomerProfiles / Paginator / ListUploadJobs


ListUploadJobs
**************

class CustomerProfiles.Paginator.ListUploadJobs

      paginator = client.get_paginator('list_upload_jobs')

   paginate(**kwargs)

      Creates an iterator that will paginate through responses from
      "CustomerProfiles.Client.list_upload_jobs()".

      See also: AWS API Documentation

      **Request Syntax**

         response_iterator = paginator.paginate(
             DomainName='string',
             PaginationConfig={
                 'MaxItems': 123,
                 'PageSize': 123,
                 'StartingToken': 'string'
             }
         )

      Parameters:
         * **DomainName** (*string*) --

           **[REQUIRED]**

           The unique name of the domain to list upload jobs for.

         * **PaginationConfig** (*dict*) --

           A dictionary that provides parameters to control
           pagination.

           * **MaxItems** *(integer) --*

             The total number of items to return. If the total number
             of items available is more than the value specified in
             max-items then a "NextToken" will be provided in the
             output that you can use to resume pagination.

           * **PageSize** *(integer) --*

             The size of each page.

           * **StartingToken** *(string) --*

             A token to specify where to start paginating. This is the
             "NextToken" from a previous response.

      Return type:
         dict

      Returns:
         **Response Syntax**

            {
                'Items': [
                    {
                        'JobId': 'string',
                        'DisplayName': 'string',
                        'Status': 'CREATED'|'IN_PROGRESS'|'PARTIALLY_SUCCEEDED'|'SUCCEEDED'|'FAILED'|'STOPPED',
                        'StatusReason': 'VALIDATION_FAILURE'|'INTERNAL_FAILURE',
                        'CreatedAt': datetime(2015, 1, 1),
                        'CompletedAt': datetime(2015, 1, 1),
                        'DataExpiry': 123
                    },
                ]
            }

         **Response Structure**

         * *(dict) --*

           * **Items** *(list) --*

             The list of upload jobs for the specified domain.

             * *(dict) --*

               The summary information for an individual upload job.

               * **JobId** *(string) --*

                 The unique identifier of the upload job.

               * **DisplayName** *(string) --*

                 The name of the upload job.

               * **Status** *(string) --*

                 The current status of the upload job.

               * **StatusReason** *(string) --*

                 The reason for the current status of the upload job.

               * **CreatedAt** *(datetime) --*

                 The timestamp when the upload job was created.

               * **CompletedAt** *(datetime) --*

                 The timestamp when the upload job was completed.

               * **DataExpiry** *(integer) --*

                 The expiry duration for the profiles ingested with
                 the upload job.
CustomerProfiles / Paginator / ListDomainLayouts


ListDomainLayouts
*****************

class CustomerProfiles.Paginator.ListDomainLayouts

      paginator = client.get_paginator('list_domain_layouts')

   paginate(**kwargs)

      Creates an iterator that will paginate through responses from
      "CustomerProfiles.Client.list_domain_layouts()".

      See also: AWS API Documentation

      **Request Syntax**

         response_iterator = paginator.paginate(
             DomainName='string',
             PaginationConfig={
                 'MaxItems': 123,
                 'PageSize': 123,
                 'StartingToken': 'string'
             }
         )

      Parameters:
         * **DomainName** (*string*) --

           **[REQUIRED]**

           The unique name of the domain.

         * **PaginationConfig** (*dict*) --

           A dictionary that provides parameters to control
           pagination.

           * **MaxItems** *(integer) --*

             The total number of items to return. If the total number
             of items available is more than the value specified in
             max-items then a "NextToken" will be provided in the
             output that you can use to resume pagination.

           * **PageSize** *(integer) --*

             The size of each page.

           * **StartingToken** *(string) --*

             A token to specify where to start paginating. This is the
             "NextToken" from a previous response.

      Return type:
         dict

      Returns:
         **Response Syntax**

            {
                'Items': [
                    {
                        'LayoutDefinitionName': 'string',
                        'Description': 'string',
                        'DisplayName': 'string',
                        'IsDefault': True|False,
                        'LayoutType': 'PROFILE_EXPLORER',
                        'Tags': {
                            'string': 'string'
                        },
                        'CreatedAt': datetime(2015, 1, 1),
                        'LastUpdatedAt': datetime(2015, 1, 1)
                    },
                ],

            }

         **Response Structure**

         * *(dict) --*

           * **Items** *(list) --*

             Contains summary information about an EventStream.

             * *(dict) --*

               The layout object that contains LayoutDefinitionName,
               Description, DisplayName, IsDefault, LayoutType, Tags,
               CreatedAt, LastUpdatedAt

               * **LayoutDefinitionName** *(string) --*

                 The unique name of the layout.

               * **Description** *(string) --*

                 The description of the layout

               * **DisplayName** *(string) --*

                 The display name of the layout

               * **IsDefault** *(boolean) --*

                 If set to true for a layout, this layout will be used
                 by default to view data. If set to false, then layout
                 will not be used by default but it can be used to
                 view data by explicit selection on UI.

               * **LayoutType** *(string) --*

                 The type of layout that can be used to view data
                 under customer profiles domain.

               * **Tags** *(dict) --*

                 The tags used to organize, track, or control access
                 for this resource.

                 * *(string) --*

                   * *(string) --*

               * **CreatedAt** *(datetime) --*

                 The timestamp of when the layout was created.

               * **LastUpdatedAt** *(datetime) --*

                 The timestamp of when the layout was most recently
                 updated.
CustomerProfiles / Client / get_auto_merging_preview


get_auto_merging_preview
************************

CustomerProfiles.Client.get_auto_merging_preview(**kwargs)

   Tests the auto-merging settings of your Identity Resolution Job
   without merging your data. It randomly selects a sample of matching
   groups from the existing matching results, and applies the
   automerging settings that you provided. You can then view the
   number of profiles in the sample, the number of matches, and the
   number of profiles identified to be merged. This enables you to
   evaluate the accuracy of the attributes in your matching list.

   You can't view which profiles are matched and would be merged.

   Warning:

     We strongly recommend you use this API to do a dry run of the
     automerging process before running the Identity Resolution Job.
     Include **at least** two matching attributes. If your matching
     list includes too few attributes (such as only "FirstName" or
     only "LastName"), there may be a large number of matches. This
     increases the chances of erroneous merges.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.get_auto_merging_preview(
          DomainName='string',
          Consolidation={
              'MatchingAttributesList': [
                  [
                      'string',
                  ],
              ]
          },
          ConflictResolution={
              'ConflictResolvingModel': 'RECENCY'|'SOURCE',
              'SourceName': 'string'
          },
          MinAllowedConfidenceScoreForMerging=123.0
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **Consolidation** (*dict*) --

        **[REQUIRED]**

        A list of matching attributes that represent matching
        criteria.

        * **MatchingAttributesList** *(list) --* **[REQUIRED]**

          A list of matching criteria.

          * *(list) --*

            * *(string) --*

      * **ConflictResolution** (*dict*) --

        **[REQUIRED]**

        How the auto-merging process should resolve conflicts between
        different profiles.

        * **ConflictResolvingModel** *(string) --* **[REQUIRED]**

          How the auto-merging process should resolve conflicts
          between different profiles.

          * "RECENCY": Uses the data that was most recently updated.

          * "SOURCE": Uses the data from a specific source. For
            example, if a company has been aquired or two departments
            have merged, data from the specified source is used. If
            two duplicate profiles are from the same source, then
            "RECENCY" is used again.

        * **SourceName** *(string) --*

          The "ObjectType" name that is used to resolve profile
          merging conflicts when choosing "SOURCE" as the
          "ConflictResolvingModel".

      * **MinAllowedConfidenceScoreForMerging** (*float*) -- Minimum
        confidence score required for profiles within a matching group
        to be merged during the auto-merge process.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'DomainName': 'string',
             'NumberOfMatchesInSample': 123,
             'NumberOfProfilesInSample': 123,
             'NumberOfProfilesWillBeMerged': 123
         }

      **Response Structure**

      * *(dict) --*

        * **DomainName** *(string) --*

          The unique name of the domain.

        * **NumberOfMatchesInSample** *(integer) --*

          The number of match groups in the domain that have been
          reviewed in this preview dry run.

        * **NumberOfProfilesInSample** *(integer) --*

          The number of profiles found in this preview dry run.

        * **NumberOfProfilesWillBeMerged** *(integer) --*

          The number of profiles that would be merged if this wasn't a
          preview dry run.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / get_event_trigger


get_event_trigger
*****************

CustomerProfiles.Client.get_event_trigger(**kwargs)

   Get a specific Event Trigger from the domain.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.get_event_trigger(
          DomainName='string',
          EventTriggerName='string'
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **EventTriggerName** (*string*) --

        **[REQUIRED]**

        The unique name of the event trigger.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'EventTriggerName': 'string',
             'ObjectTypeName': 'string',
             'Description': 'string',
             'EventTriggerConditions': [
                 {
                     'EventTriggerDimensions': [
                         {
                             'ObjectAttributes': [
                                 {
                                     'Source': 'string',
                                     'FieldName': 'string',
                                     'ComparisonOperator': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL'|'LESS_THAN_OR_EQUAL'|'EQUAL'|'BEFORE'|'AFTER'|'ON'|'BETWEEN'|'NOT_BETWEEN',
                                     'Values': [
                                         'string',
                                     ]
                                 },
                             ]
                         },
                     ],
                     'LogicalOperator': 'ANY'|'ALL'|'NONE'
                 },
             ],
             'SegmentFilter': 'string',
             'EventTriggerLimits': {
                 'EventExpiration': 123,
                 'Periods': [
                     {
                         'Unit': 'HOURS'|'DAYS'|'WEEKS'|'MONTHS',
                         'Value': 123,
                         'MaxInvocationsPerProfile': 123,
                         'Unlimited': True|False
                     },
                 ]
             },
             'CreatedAt': datetime(2015, 1, 1),
             'LastUpdatedAt': datetime(2015, 1, 1),
             'Tags': {
                 'string': 'string'
             }
         }

      **Response Structure**

      * *(dict) --*

        * **EventTriggerName** *(string) --*

          The unique name of the event trigger.

        * **ObjectTypeName** *(string) --*

          The unique name of the object type.

        * **Description** *(string) --*

          The description of the event trigger.

        * **EventTriggerConditions** *(list) --*

          A list of conditions that determine when an event should
          trigger the destination.

          * *(dict) --*

            Specifies the circumstances under which the event should
            trigger the destination.

            * **EventTriggerDimensions** *(list) --*

              A list of dimensions to be evaluated for the event.

              * *(dict) --*

                A specific event dimension to be assessed.

                * **ObjectAttributes** *(list) --*

                  A list of object attributes to be evaluated.

                  * *(dict) --*

                    The criteria that a specific object attribute must
                    meet to trigger the destination.

                    * **Source** *(string) --*

                      An attribute contained within a source object.

                    * **FieldName** *(string) --*

                      A field defined within an object type.

                    * **ComparisonOperator** *(string) --*

                      The operator used to compare an attribute
                      against a list of values.

                    * **Values** *(list) --*

                      A list of attribute values used for comparison.

                      * *(string) --*

            * **LogicalOperator** *(string) --*

              The operator used to combine multiple dimensions.

        * **SegmentFilter** *(string) --*

          The destination is triggered only for profiles that meet the
          criteria of a segment definition.

        * **EventTriggerLimits** *(dict) --*

          Defines limits controlling whether an event triggers the
          destination, based on ingestion latency and the number of
          invocations per profile over specific time periods.

          * **EventExpiration** *(integer) --*

            In milliseconds. Specifies that an event will only trigger
            the destination if it is processed within a certain
            latency period.

          * **Periods** *(list) --*

            A list of time periods during which the limits apply.

            * *(dict) --*

              Defines a limit and the time period during which it is
              enforced.

              * **Unit** *(string) --*

                The unit of time.

              * **Value** *(integer) --*

                The amount of time of the specified unit.

              * **MaxInvocationsPerProfile** *(integer) --*

                The maximum allowed number of destination invocations
                per profile.

              * **Unlimited** *(boolean) --*

                If set to true, there is no limit on the number of
                destination invocations per profile. The default is
                false.

        * **CreatedAt** *(datetime) --*

          The timestamp of when the event trigger was created.

        * **LastUpdatedAt** *(datetime) --*

          The timestamp of when the event trigger was most recently
          updated.

        * **Tags** *(dict) --*

          An array of key-value pairs to apply to this resource.

          * *(string) --*

            * *(string) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / list_integrations


list_integrations
*****************

CustomerProfiles.Client.list_integrations(**kwargs)

   Lists all of the integrations in your domain.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_integrations(
          DomainName='string',
          NextToken='string',
          MaxResults=123,
          IncludeHidden=True|False
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **NextToken** (*string*) -- The pagination token from the
        previous ListIntegrations API call.

      * **MaxResults** (*integer*) -- The maximum number of objects
        returned per page.

      * **IncludeHidden** (*boolean*) -- Boolean to indicate if hidden
        integration should be returned. Defaults to "False".

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'Items': [
                 {
                     'DomainName': 'string',
                     'Uri': 'string',
                     'ObjectTypeName': 'string',
                     'CreatedAt': datetime(2015, 1, 1),
                     'LastUpdatedAt': datetime(2015, 1, 1),
                     'Tags': {
                         'string': 'string'
                     },
                     'ObjectTypeNames': {
                         'string': 'string'
                     },
                     'WorkflowId': 'string',
                     'IsUnstructured': True|False,
                     'RoleArn': 'string',
                     'EventTriggerNames': [
                         'string',
                     ]
                 },
             ],
             'NextToken': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **Items** *(list) --*

          The list of ListIntegrations instances.

          * *(dict) --*

            An integration in list of integrations.

            * **DomainName** *(string) --*

              The unique name of the domain.

            * **Uri** *(string) --*

              The URI of the S3 bucket or any other type of data
              source.

            * **ObjectTypeName** *(string) --*

              The name of the profile object type.

            * **CreatedAt** *(datetime) --*

              The timestamp of when the domain was created.

            * **LastUpdatedAt** *(datetime) --*

              The timestamp of when the domain was most recently
              edited.

            * **Tags** *(dict) --*

              The tags used to organize, track, or control access for
              this resource.

              * *(string) --*

                * *(string) --*

            * **ObjectTypeNames** *(dict) --*

              A map in which each key is an event type from an
              external application such as Segment or Shopify, and
              each value is an "ObjectTypeName" (template) used to
              ingest the event. It supports the following event types:
              "SegmentIdentify", "ShopifyCreateCustomers",
              "ShopifyUpdateCustomers", "ShopifyCreateDraftOrders",
              "ShopifyUpdateDraftOrders", "ShopifyCreateOrders", and
              "ShopifyUpdatedOrders".

              * *(string) --*

                * *(string) --*

            * **WorkflowId** *(string) --*

              Unique identifier for the workflow.

            * **IsUnstructured** *(boolean) --*

              Boolean that shows if the Flow that's associated with
              the Integration is created in Amazon Appflow, or with
              ObjectTypeName equals _unstructured via API/CLI in
              flowDefinition.

            * **RoleArn** *(string) --*

              The Amazon Resource Name (ARN) of the IAM role. The
              Integration uses this role to make Customer Profiles
              requests on your behalf.

            * **EventTriggerNames** *(list) --*

              A list of unique names for active event triggers
              associated with the integration.

              * *(string) --*

        * **NextToken** *(string) --*

          The pagination token from the previous ListIntegrations API
          call.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / get_segment_definition


get_segment_definition
**********************

CustomerProfiles.Client.get_segment_definition(**kwargs)

   Gets a segment definition from the domain.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.get_segment_definition(
          DomainName='string',
          SegmentDefinitionName='string'
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **SegmentDefinitionName** (*string*) --

        **[REQUIRED]**

        The unique name of the segment definition.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'SegmentDefinitionName': 'string',
             'DisplayName': 'string',
             'Description': 'string',
             'SegmentGroups': {
                 'Groups': [
                     {
                         'Dimensions': [
                             {
                                 'ProfileAttributes': {
                                     'AccountNumber': {
                                         'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                         'Values': [
                                             'string',
                                         ]
                                     },
                                     'AdditionalInformation': {
                                         'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                         'Values': [
                                             'string',
                                         ]
                                     },
                                     'FirstName': {
                                         'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                         'Values': [
                                             'string',
                                         ]
                                     },
                                     'LastName': {
                                         'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                         'Values': [
                                             'string',
                                         ]
                                     },
                                     'MiddleName': {
                                         'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                         'Values': [
                                             'string',
                                         ]
                                     },
                                     'GenderString': {
                                         'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                         'Values': [
                                             'string',
                                         ]
                                     },
                                     'PartyTypeString': {
                                         'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                         'Values': [
                                             'string',
                                         ]
                                     },
                                     'BirthDate': {
                                         'DimensionType': 'BEFORE'|'AFTER'|'BETWEEN'|'NOT_BETWEEN'|'ON',
                                         'Values': [
                                             'string',
                                         ]
                                     },
                                     'PhoneNumber': {
                                         'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                         'Values': [
                                             'string',
                                         ]
                                     },
                                     'BusinessName': {
                                         'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                         'Values': [
                                             'string',
                                         ]
                                     },
                                     'BusinessPhoneNumber': {
                                         'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                         'Values': [
                                             'string',
                                         ]
                                     },
                                     'HomePhoneNumber': {
                                         'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                         'Values': [
                                             'string',
                                         ]
                                     },
                                     'MobilePhoneNumber': {
                                         'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                         'Values': [
                                             'string',
                                         ]
                                     },
                                     'EmailAddress': {
                                         'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                         'Values': [
                                             'string',
                                         ]
                                     },
                                     'PersonalEmailAddress': {
                                         'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                         'Values': [
                                             'string',
                                         ]
                                     },
                                     'BusinessEmailAddress': {
                                         'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                         'Values': [
                                             'string',
                                         ]
                                     },
                                     'Address': {
                                         'City': {
                                             'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                             'Values': [
                                                 'string',
                                             ]
                                         },
                                         'Country': {
                                             'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                             'Values': [
                                                 'string',
                                             ]
                                         },
                                         'County': {
                                             'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                             'Values': [
                                                 'string',
                                             ]
                                         },
                                         'PostalCode': {
                                             'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                             'Values': [
                                                 'string',
                                             ]
                                         },
                                         'Province': {
                                             'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                             'Values': [
                                                 'string',
                                             ]
                                         },
                                         'State': {
                                             'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                             'Values': [
                                                 'string',
                                             ]
                                         }
                                     },
                                     'ShippingAddress': {
                                         'City': {
                                             'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                             'Values': [
                                                 'string',
                                             ]
                                         },
                                         'Country': {
                                             'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                             'Values': [
                                                 'string',
                                             ]
                                         },
                                         'County': {
                                             'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                             'Values': [
                                                 'string',
                                             ]
                                         },
                                         'PostalCode': {
                                             'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                             'Values': [
                                                 'string',
                                             ]
                                         },
                                         'Province': {
                                             'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                             'Values': [
                                                 'string',
                                             ]
                                         },
                                         'State': {
                                             'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                             'Values': [
                                                 'string',
                                             ]
                                         }
                                     },
                                     'MailingAddress': {
                                         'City': {
                                             'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                             'Values': [
                                                 'string',
                                             ]
                                         },
                                         'Country': {
                                             'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                             'Values': [
                                                 'string',
                                             ]
                                         },
                                         'County': {
                                             'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                             'Values': [
                                                 'string',
                                             ]
                                         },
                                         'PostalCode': {
                                             'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                             'Values': [
                                                 'string',
                                             ]
                                         },
                                         'Province': {
                                             'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                             'Values': [
                                                 'string',
                                             ]
                                         },
                                         'State': {
                                             'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                             'Values': [
                                                 'string',
                                             ]
                                         }
                                     },
                                     'BillingAddress': {
                                         'City': {
                                             'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                             'Values': [
                                                 'string',
                                             ]
                                         },
                                         'Country': {
                                             'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                             'Values': [
                                                 'string',
                                             ]
                                         },
                                         'County': {
                                             'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                             'Values': [
                                                 'string',
                                             ]
                                         },
                                         'PostalCode': {
                                             'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                             'Values': [
                                                 'string',
                                             ]
                                         },
                                         'Province': {
                                             'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                             'Values': [
                                                 'string',
                                             ]
                                         },
                                         'State': {
                                             'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                             'Values': [
                                                 'string',
                                             ]
                                         }
                                     },
                                     'Attributes': {
                                         'string': {
                                             'DimensionType': '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': [
                                                 'string',
                                             ]
                                         }
                                     },
                                     'ProfileType': {
                                         'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                         'Values': [
                                             'ACCOUNT_PROFILE'|'PROFILE',
                                         ]
                                     }
                                 },
                                 'CalculatedAttributes': {
                                     'string': {
                                         'DimensionType': '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': [
                                             'string',
                                         ],
                                         'ConditionOverrides': {
                                             'Range': {
                                                 'Start': 123,
                                                 'End': 123,
                                                 'Unit': 'DAYS'
                                             }
                                         }
                                     }
                                 }
                             },
                         ],
                         'SourceSegments': [
                             {
                                 'SegmentDefinitionName': 'string'
                             },
                         ],
                         'SourceType': 'ALL'|'ANY'|'NONE',
                         'Type': 'ALL'|'ANY'|'NONE'
                     },
                 ],
                 'Include': 'ALL'|'ANY'|'NONE'
             },
             'SegmentDefinitionArn': 'string',
             'CreatedAt': datetime(2015, 1, 1),
             'Tags': {
                 'string': 'string'
             }
         }

      **Response Structure**

      * *(dict) --*

        * **SegmentDefinitionName** *(string) --*

          The name of the segment definition.

        * **DisplayName** *(string) --*

          The display name of the segment definition.

        * **Description** *(string) --*

          The description of the segment definition.

        * **SegmentGroups** *(dict) --*

          The segment criteria associated with this definition.

          * **Groups** *(list) --*

            Holds the list of groups within the segment definition.

            * *(dict) --*

              Contains dimensions that determine what to segment on.

              * **Dimensions** *(list) --*

                Defines the attributes to segment on.

                * *(dict) --*

                  Object that holds what profile and calculated
                  attributes to segment on.

                  Note:

                    This is a Tagged Union structure. Only one of the
                    following top level keys will be set:
                    "ProfileAttributes", "CalculatedAttributes".
                    If a client receives an unknown member it will
                    set "SDK_UNKNOWN_MEMBER" as the top level key,
                    which maps to the name or tag of the unknown
                    member. The structure of "SDK_UNKNOWN_MEMBER" is
                    as follows:

                       'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

                  * **ProfileAttributes** *(dict) --*

                    Object that holds the profile attributes to
                    segment on.

                    * **AccountNumber** *(dict) --*

                      A field to describe values to segment on within
                      account number.

                      * **DimensionType** *(string) --*

                        The action to segment on.

                      * **Values** *(list) --*

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **AdditionalInformation** *(dict) --*

                      A field to describe values to segment on within
                      additional information.

                      * **DimensionType** *(string) --*

                        The action to segment with.

                      * **Values** *(list) --*

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **FirstName** *(dict) --*

                      A field to describe values to segment on within
                      first name.

                      * **DimensionType** *(string) --*

                        The action to segment on.

                      * **Values** *(list) --*

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **LastName** *(dict) --*

                      A field to describe values to segment on within
                      last name.

                      * **DimensionType** *(string) --*

                        The action to segment on.

                      * **Values** *(list) --*

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **MiddleName** *(dict) --*

                      A field to describe values to segment on within
                      middle name.

                      * **DimensionType** *(string) --*

                        The action to segment on.

                      * **Values** *(list) --*

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **GenderString** *(dict) --*

                      A field to describe values to segment on within
                      genderString.

                      * **DimensionType** *(string) --*

                        The action to segment on.

                      * **Values** *(list) --*

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **PartyTypeString** *(dict) --*

                      A field to describe values to segment on within
                      partyTypeString.

                      * **DimensionType** *(string) --*

                        The action to segment on.

                      * **Values** *(list) --*

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **BirthDate** *(dict) --*

                      A field to describe values to segment on within
                      birthDate.

                      * **DimensionType** *(string) --*

                        The action to segment with.

                      * **Values** *(list) --*

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **PhoneNumber** *(dict) --*

                      A field to describe values to segment on within
                      phone number.

                      * **DimensionType** *(string) --*

                        The action to segment on.

                      * **Values** *(list) --*

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **BusinessName** *(dict) --*

                      A field to describe values to segment on within
                      business name.

                      * **DimensionType** *(string) --*

                        The action to segment on.

                      * **Values** *(list) --*

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **BusinessPhoneNumber** *(dict) --*

                      A field to describe values to segment on within
                      business phone number.

                      * **DimensionType** *(string) --*

                        The action to segment on.

                      * **Values** *(list) --*

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **HomePhoneNumber** *(dict) --*

                      A field to describe values to segment on within
                      home phone number.

                      * **DimensionType** *(string) --*

                        The action to segment on.

                      * **Values** *(list) --*

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **MobilePhoneNumber** *(dict) --*

                      A field to describe values to segment on within
                      mobile phone number.

                      * **DimensionType** *(string) --*

                        The action to segment on.

                      * **Values** *(list) --*

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **EmailAddress** *(dict) --*

                      A field to describe values to segment on within
                      email address.

                      * **DimensionType** *(string) --*

                        The action to segment on.

                      * **Values** *(list) --*

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **PersonalEmailAddress** *(dict) --*

                      A field to describe values to segment on within
                      personal email address.

                      * **DimensionType** *(string) --*

                        The action to segment on.

                      * **Values** *(list) --*

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **BusinessEmailAddress** *(dict) --*

                      A field to describe values to segment on within
                      business email address.

                      * **DimensionType** *(string) --*

                        The action to segment on.

                      * **Values** *(list) --*

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **Address** *(dict) --*

                      A field to describe values to segment on within
                      address.

                      * **City** *(dict) --*

                        The city belonging to the address.

                        * **DimensionType** *(string) --*

                          The action to segment on.

                        * **Values** *(list) --*

                          The values to apply the DimensionType on.

                          * *(string) --*

                      * **Country** *(dict) --*

                        The country belonging to the address.

                        * **DimensionType** *(string) --*

                          The action to segment on.

                        * **Values** *(list) --*

                          The values to apply the DimensionType on.

                          * *(string) --*

                      * **County** *(dict) --*

                        The county belonging to the address.

                        * **DimensionType** *(string) --*

                          The action to segment on.

                        * **Values** *(list) --*

                          The values to apply the DimensionType on.

                          * *(string) --*

                      * **PostalCode** *(dict) --*

                        The postal code belonging to the address.

                        * **DimensionType** *(string) --*

                          The action to segment on.

                        * **Values** *(list) --*

                          The values to apply the DimensionType on.

                          * *(string) --*

                      * **Province** *(dict) --*

                        The province belonging to the address.

                        * **DimensionType** *(string) --*

                          The action to segment on.

                        * **Values** *(list) --*

                          The values to apply the DimensionType on.

                          * *(string) --*

                      * **State** *(dict) --*

                        The state belonging to the address.

                        * **DimensionType** *(string) --*

                          The action to segment on.

                        * **Values** *(list) --*

                          The values to apply the DimensionType on.

                          * *(string) --*

                    * **ShippingAddress** *(dict) --*

                      A field to describe values to segment on within
                      shipping address.

                      * **City** *(dict) --*

                        The city belonging to the address.

                        * **DimensionType** *(string) --*

                          The action to segment on.

                        * **Values** *(list) --*

                          The values to apply the DimensionType on.

                          * *(string) --*

                      * **Country** *(dict) --*

                        The country belonging to the address.

                        * **DimensionType** *(string) --*

                          The action to segment on.

                        * **Values** *(list) --*

                          The values to apply the DimensionType on.

                          * *(string) --*

                      * **County** *(dict) --*

                        The county belonging to the address.

                        * **DimensionType** *(string) --*

                          The action to segment on.

                        * **Values** *(list) --*

                          The values to apply the DimensionType on.

                          * *(string) --*

                      * **PostalCode** *(dict) --*

                        The postal code belonging to the address.

                        * **DimensionType** *(string) --*

                          The action to segment on.

                        * **Values** *(list) --*

                          The values to apply the DimensionType on.

                          * *(string) --*

                      * **Province** *(dict) --*

                        The province belonging to the address.

                        * **DimensionType** *(string) --*

                          The action to segment on.

                        * **Values** *(list) --*

                          The values to apply the DimensionType on.

                          * *(string) --*

                      * **State** *(dict) --*

                        The state belonging to the address.

                        * **DimensionType** *(string) --*

                          The action to segment on.

                        * **Values** *(list) --*

                          The values to apply the DimensionType on.

                          * *(string) --*

                    * **MailingAddress** *(dict) --*

                      A field to describe values to segment on within
                      mailing address.

                      * **City** *(dict) --*

                        The city belonging to the address.

                        * **DimensionType** *(string) --*

                          The action to segment on.

                        * **Values** *(list) --*

                          The values to apply the DimensionType on.

                          * *(string) --*

                      * **Country** *(dict) --*

                        The country belonging to the address.

                        * **DimensionType** *(string) --*

                          The action to segment on.

                        * **Values** *(list) --*

                          The values to apply the DimensionType on.

                          * *(string) --*

                      * **County** *(dict) --*

                        The county belonging to the address.

                        * **DimensionType** *(string) --*

                          The action to segment on.

                        * **Values** *(list) --*

                          The values to apply the DimensionType on.

                          * *(string) --*

                      * **PostalCode** *(dict) --*

                        The postal code belonging to the address.

                        * **DimensionType** *(string) --*

                          The action to segment on.

                        * **Values** *(list) --*

                          The values to apply the DimensionType on.

                          * *(string) --*

                      * **Province** *(dict) --*

                        The province belonging to the address.

                        * **DimensionType** *(string) --*

                          The action to segment on.

                        * **Values** *(list) --*

                          The values to apply the DimensionType on.

                          * *(string) --*

                      * **State** *(dict) --*

                        The state belonging to the address.

                        * **DimensionType** *(string) --*

                          The action to segment on.

                        * **Values** *(list) --*

                          The values to apply the DimensionType on.

                          * *(string) --*

                    * **BillingAddress** *(dict) --*

                      A field to describe values to segment on within
                      billing address.

                      * **City** *(dict) --*

                        The city belonging to the address.

                        * **DimensionType** *(string) --*

                          The action to segment on.

                        * **Values** *(list) --*

                          The values to apply the DimensionType on.

                          * *(string) --*

                      * **Country** *(dict) --*

                        The country belonging to the address.

                        * **DimensionType** *(string) --*

                          The action to segment on.

                        * **Values** *(list) --*

                          The values to apply the DimensionType on.

                          * *(string) --*

                      * **County** *(dict) --*

                        The county belonging to the address.

                        * **DimensionType** *(string) --*

                          The action to segment on.

                        * **Values** *(list) --*

                          The values to apply the DimensionType on.

                          * *(string) --*

                      * **PostalCode** *(dict) --*

                        The postal code belonging to the address.

                        * **DimensionType** *(string) --*

                          The action to segment on.

                        * **Values** *(list) --*

                          The values to apply the DimensionType on.

                          * *(string) --*

                      * **Province** *(dict) --*

                        The province belonging to the address.

                        * **DimensionType** *(string) --*

                          The action to segment on.

                        * **Values** *(list) --*

                          The values to apply the DimensionType on.

                          * *(string) --*

                      * **State** *(dict) --*

                        The state belonging to the address.

                        * **DimensionType** *(string) --*

                          The action to segment on.

                        * **Values** *(list) --*

                          The values to apply the DimensionType on.

                          * *(string) --*

                    * **Attributes** *(dict) --*

                      A field to describe values to segment on within
                      attributes.

                      * *(string) --*

                        * *(dict) --*

                          Object that segments on various Customer
                          Profile's fields.

                          * **DimensionType** *(string) --*

                            The action to segment with.

                          * **Values** *(list) --*

                            The values to apply the DimensionType on.

                            * *(string) --*

                    * **ProfileType** *(dict) --*

                      A field to describe values to segment on within
                      profile type.

                      * **DimensionType** *(string) --*

                        The action to segment on.

                      * **Values** *(list) --*

                        The values to apply the DimensionType on.

                        * *(string) --*

                  * **CalculatedAttributes** *(dict) --*

                    Object that holds the calculated attributes to
                    segment on.

                    * *(string) --*

                      * *(dict) --*

                        Object that segments on Customer Profile's
                        Calculated Attributes.

                        * **DimensionType** *(string) --*

                          The action to segment with.

                        * **Values** *(list) --*

                          The values to apply the DimensionType with.

                          * *(string) --*

                        * **ConditionOverrides** *(dict) --*

                          Applies the given condition over the initial
                          Calculated Attribute's definition.

                          * **Range** *(dict) --*

                            The relative time period over which data
                            is included in the aggregation for this
                            override.

                            * **Start** *(integer) --*

                              The start time of when to include
                              objects.

                            * **End** *(integer) --*

                              The end time of when to include objects.

                            * **Unit** *(string) --*

                              The unit for start and end.

              * **SourceSegments** *(list) --*

                Defines the starting source of data.

                * *(dict) --*

                  The source segments to build off of.

                  * **SegmentDefinitionName** *(string) --*

                    The unique name of the segment definition.

              * **SourceType** *(string) --*

                Defines how to interact with the source data.

              * **Type** *(string) --*

                Defines how to interact with the profiles found in the
                current filtering.

          * **Include** *(string) --*

            Defines whether to include or exclude the profiles that
            fit the segment criteria.

        * **SegmentDefinitionArn** *(string) --*

          The arn of the segment definition.

        * **CreatedAt** *(datetime) --*

          The timestamp of when the segment definition was created.

        * **Tags** *(dict) --*

          The tags used to organize, track, or control access for this
          resource.

          * *(string) --*

            * *(string) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"
CustomerProfiles / Client / get_paginator


get_paginator
*************

CustomerProfiles.Client.get_paginator(operation_name)

   Create a paginator for an operation.

   Parameters:
      **operation_name** (*string*) -- The operation name.  This is
      the same name as the method name on the client.  For example, if
      the method name is "create_foo", and you'd normally invoke the
      operation as "client.create_foo(**kwargs)", if the "create_foo"
      operation can be paginated, you can use the call
      "client.get_paginator("create_foo")".

   Raises:
      **OperationNotPageableError** -- Raised if the operation is not
      pageable.  You can use the "client.can_paginate" method to check
      if an operation is pageable.

   Return type:
      "botocore.paginate.Paginator"

   Returns:
      A paginator object.
CustomerProfiles / Client / list_profile_attribute_values


list_profile_attribute_values
*****************************

CustomerProfiles.Client.list_profile_attribute_values(**kwargs)

   Fetch the possible attribute values given the attribute name.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_profile_attribute_values(
          DomainName='string',
          AttributeName='string'
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique identifier of the domain.

      * **AttributeName** (*string*) --

        **[REQUIRED]**

        The attribute name.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'DomainName': 'string',
             'AttributeName': 'string',
             'Items': [
                 {
                     'Value': 'string'
                 },
             ],
             'StatusCode': 123
         }

      **Response Structure**

      * *(dict) --*

        * **DomainName** *(string) --*

          The name of the domain.

        * **AttributeName** *(string) --*

          The attribute name.

        * **Items** *(list) --*

          The items returned as part of the response.

          * *(dict) --*

            List containing the values for the given attribute.

            * **Value** *(string) --*

              An individual value belonging to the given attribute.

        * **StatusCode** *(integer) --*

          The status code for the response.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / get_calculated_attribute_for_profile


get_calculated_attribute_for_profile
************************************

CustomerProfiles.Client.get_calculated_attribute_for_profile(**kwargs)

   Retrieve a calculated attribute for a customer profile.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.get_calculated_attribute_for_profile(
          DomainName='string',
          ProfileId='string',
          CalculatedAttributeName='string'
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **ProfileId** (*string*) --

        **[REQUIRED]**

        The unique identifier of a customer profile.

      * **CalculatedAttributeName** (*string*) --

        **[REQUIRED]**

        The unique name of the calculated attribute.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'CalculatedAttributeName': 'string',
             'DisplayName': 'string',
             'IsDataPartial': 'string',
             'Value': 'string',
             'LastObjectTimestamp': datetime(2015, 1, 1)
         }

      **Response Structure**

      * *(dict) --*

        * **CalculatedAttributeName** *(string) --*

          The unique name of the calculated attribute.

        * **DisplayName** *(string) --*

          The display name of the calculated attribute.

        * **IsDataPartial** *(string) --*

          Indicates whether the calculated attribute’s value is based
          on partial data. If data is partial, it is set to true.

        * **Value** *(string) --*

          The value of the calculated attribute.

        * **LastObjectTimestamp** *(datetime) --*

          The timestamp of the newest object included in the
          calculated attribute calculation.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / create_domain_layout


create_domain_layout
********************

CustomerProfiles.Client.create_domain_layout(**kwargs)

   Creates the layout to view data for a specific domain. This API can
   only be invoked from the Amazon Connect admin website.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.create_domain_layout(
          DomainName='string',
          LayoutDefinitionName='string',
          Description='string',
          DisplayName='string',
          IsDefault=True|False,
          LayoutType='PROFILE_EXPLORER',
          Layout='string',
          Tags={
              'string': 'string'
          }
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **LayoutDefinitionName** (*string*) --

        **[REQUIRED]**

        The unique name of the layout.

      * **Description** (*string*) --

        **[REQUIRED]**

        The description of the layout

      * **DisplayName** (*string*) --

        **[REQUIRED]**

        The display name of the layout

      * **IsDefault** (*boolean*) -- If set to true for a layout, this
        layout will be used by default to view data. If set to false,
        then the layout will not be used by default, but it can be
        used to view data by explicitly selecting it in the console.

      * **LayoutType** (*string*) --

        **[REQUIRED]**

        The type of layout that can be used to view data under a
        Customer Profiles domain.

      * **Layout** (*string*) --

        **[REQUIRED]**

        A customizable layout that can be used to view data under a
        Customer Profiles domain.

      * **Tags** (*dict*) --

        The tags used to organize, track, or control access for this
        resource.

        * *(string) --*

          * *(string) --*

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'LayoutDefinitionName': 'string',
             'Description': 'string',
             'DisplayName': 'string',
             'IsDefault': True|False,
             'LayoutType': 'PROFILE_EXPLORER',
             'Layout': 'string',
             'Version': 'string',
             'Tags': {
                 'string': 'string'
             },
             'CreatedAt': datetime(2015, 1, 1),
             'LastUpdatedAt': datetime(2015, 1, 1)
         }

      **Response Structure**

      * *(dict) --*

        * **LayoutDefinitionName** *(string) --*

          The unique name of the layout.

        * **Description** *(string) --*

          The description of the layout

        * **DisplayName** *(string) --*

          The display name of the layout

        * **IsDefault** *(boolean) --*

          If set to true for a layout, this layout will be used by
          default to view data. If set to false, then the layout will
          not be used by default, but it can be used to view data by
          explicitly selecting it in the console.

        * **LayoutType** *(string) --*

          The type of layout that can be used to view data under
          customer profiles domain.

        * **Layout** *(string) --*

          A customizable layout that can be used to view data under
          Customer Profiles domain.

        * **Version** *(string) --*

          The version used to create layout.

        * **Tags** *(dict) --*

          The tags used to organize, track, or control access for this
          resource.

          * *(string) --*

            * *(string) --*

        * **CreatedAt** *(datetime) --*

          The timestamp of when the layout was created.

        * **LastUpdatedAt** *(datetime) --*

          The timestamp of when the layout was most recently updated.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / delete_event_stream


delete_event_stream
*******************

CustomerProfiles.Client.delete_event_stream(**kwargs)

   Disables and deletes the specified event stream.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.delete_event_stream(
          DomainName='string',
          EventStreamName='string'
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **EventStreamName** (*string*) --

        **[REQUIRED]**

        The name of the event stream

   Return type:
      dict

   Returns:
      **Response Syntax**

         {}

      **Response Structure**

      * *(dict) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / search_profiles


search_profiles
***************

CustomerProfiles.Client.search_profiles(**kwargs)

   Searches for profiles within a specific domain using one or more
   predefined search keys (e.g., _fullName, _phone, _email, _account,
   etc.) and/or custom-defined search keys. A search key is a data
   type pair that consists of a "KeyName" and "Values" list.

   This operation supports searching for profiles with a minimum of 1
   key-value(s) pair and up to 5 key-value(s) pairs using either "AND"
   or "OR" logic.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.search_profiles(
          NextToken='string',
          MaxResults=123,
          DomainName='string',
          KeyName='string',
          Values=[
              'string',
          ],
          AdditionalSearchKeys=[
              {
                  'KeyName': 'string',
                  'Values': [
                      'string',
                  ]
              },
          ],
          LogicalOperator='AND'|'OR'
      )

   Parameters:
      * **NextToken** (*string*) -- The pagination token from the
        previous SearchProfiles API call.

      * **MaxResults** (*integer*) --

        The maximum number of objects returned per page.

        The default is 20 if this parameter is not included in the
        request.

      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **KeyName** (*string*) --

        **[REQUIRED]**

        A searchable identifier of a customer profile. The predefined
        keys you can use to search include: _account, _profileId,
        _assetId, _caseId, _orderId, _fullName, _phone, _email,
        _ctrContactId, _marketoLeadId, _salesforceAccountId,
        _salesforceContactId, _salesforceAssetId, _zendeskUserId,
        _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId,
        _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId,
        _shopifyOrderId.

      * **Values** (*list*) --

        **[REQUIRED]**

        A list of key values.

        * *(string) --*

      * **AdditionalSearchKeys** (*list*) --

        A list of "AdditionalSearchKey" objects that are each
        searchable identifiers of a profile. Each
        "AdditionalSearchKey" object contains a "KeyName" and a list
        of "Values" associated with that specific key (i.e., a key-
        value(s) pair). These additional search keys will be used in
        conjunction with the "LogicalOperator" and the required
        "KeyName" and "Values" parameters to search for profiles that
        satisfy the search criteria.

        * *(dict) --*

          A data type pair that consists of a "KeyName" and "Values"
          list that is used in conjunction with the KeyName and Values
          parameters to search for profiles using the SearchProfiles
          API.

          * **KeyName** *(string) --* **[REQUIRED]**

            A searchable identifier of a customer profile.

          * **Values** *(list) --* **[REQUIRED]**

            A list of key values.

            * *(string) --*

      * **LogicalOperator** (*string*) --

        Relationship between all specified search keys that will be
        used to search for profiles. This includes the required
        "KeyName" and "Values" parameters as well as any key-value(s)
        pairs specified in the "AdditionalSearchKeys" list.

        This parameter influences which profiles will be returned in
        the response in the following manner:

        * "AND" - The response only includes profiles that match all
          of the search keys.

        * "OR" - The response includes profiles that match at least
          one of the search keys.

        The "OR" relationship is the default behavior if this
        parameter is not included in the request.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'Items': [
                 {
                     'ProfileId': 'string',
                     'AccountNumber': 'string',
                     'AdditionalInformation': 'string',
                     'PartyType': 'INDIVIDUAL'|'BUSINESS'|'OTHER',
                     'BusinessName': 'string',
                     'FirstName': 'string',
                     'MiddleName': 'string',
                     'LastName': 'string',
                     'BirthDate': 'string',
                     'Gender': 'MALE'|'FEMALE'|'UNSPECIFIED',
                     'PhoneNumber': 'string',
                     'MobilePhoneNumber': 'string',
                     'HomePhoneNumber': 'string',
                     'BusinessPhoneNumber': 'string',
                     'EmailAddress': 'string',
                     'PersonalEmailAddress': 'string',
                     'BusinessEmailAddress': 'string',
                     'Address': {
                         'Address1': 'string',
                         'Address2': 'string',
                         'Address3': 'string',
                         'Address4': 'string',
                         'City': 'string',
                         'County': 'string',
                         'State': 'string',
                         'Province': 'string',
                         'Country': 'string',
                         'PostalCode': 'string'
                     },
                     'ShippingAddress': {
                         'Address1': 'string',
                         'Address2': 'string',
                         'Address3': 'string',
                         'Address4': 'string',
                         'City': 'string',
                         'County': 'string',
                         'State': 'string',
                         'Province': 'string',
                         'Country': 'string',
                         'PostalCode': 'string'
                     },
                     'MailingAddress': {
                         'Address1': 'string',
                         'Address2': 'string',
                         'Address3': 'string',
                         'Address4': 'string',
                         'City': 'string',
                         'County': 'string',
                         'State': 'string',
                         'Province': 'string',
                         'Country': 'string',
                         'PostalCode': 'string'
                     },
                     'BillingAddress': {
                         'Address1': 'string',
                         'Address2': 'string',
                         'Address3': 'string',
                         'Address4': 'string',
                         'City': 'string',
                         'County': 'string',
                         'State': 'string',
                         'Province': 'string',
                         'Country': 'string',
                         'PostalCode': 'string'
                     },
                     'Attributes': {
                         'string': 'string'
                     },
                     'FoundByItems': [
                         {
                             'KeyName': 'string',
                             'Values': [
                                 'string',
                             ]
                         },
                     ],
                     'PartyTypeString': 'string',
                     'GenderString': 'string',
                     'ProfileType': 'ACCOUNT_PROFILE'|'PROFILE',
                     'EngagementPreferences': {
                         'Phone': [
                             {
                                 'KeyName': 'string',
                                 'KeyValue': 'string',
                                 'ProfileId': 'string',
                                 'ContactType': 'PhoneNumber'|'MobilePhoneNumber'|'HomePhoneNumber'|'BusinessPhoneNumber'|'EmailAddress'|'PersonalEmailAddress'|'BusinessEmailAddress'
                             },
                         ],
                         'Email': [
                             {
                                 'KeyName': 'string',
                                 'KeyValue': 'string',
                                 'ProfileId': 'string',
                                 'ContactType': 'PhoneNumber'|'MobilePhoneNumber'|'HomePhoneNumber'|'BusinessPhoneNumber'|'EmailAddress'|'PersonalEmailAddress'|'BusinessEmailAddress'
                             },
                         ]
                     }
                 },
             ],
             'NextToken': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **Items** *(list) --*

          The list of Profiles matching the search criteria.

          * *(dict) --*

            The standard profile of a customer.

            * **ProfileId** *(string) --*

              The unique identifier of a customer profile.

            * **AccountNumber** *(string) --*

              An account number that you have assigned to the
              customer.

            * **AdditionalInformation** *(string) --*

              Any additional information relevant to the customer’s
              profile.

            * **PartyType** *(string) --*

              The type of profile used to describe the customer.

            * **BusinessName** *(string) --*

              The name of the customer’s business.

            * **FirstName** *(string) --*

              The customer’s first name.

            * **MiddleName** *(string) --*

              The customer’s middle name.

            * **LastName** *(string) --*

              The customer’s last name.

            * **BirthDate** *(string) --*

              The customer’s birth date.

            * **Gender** *(string) --*

              The gender with which the customer identifies.

            * **PhoneNumber** *(string) --*

              The customer's phone number, which has not been
              specified as a mobile, home, or business number.

            * **MobilePhoneNumber** *(string) --*

              The customer’s mobile phone number.

            * **HomePhoneNumber** *(string) --*

              The customer’s home phone number.

            * **BusinessPhoneNumber** *(string) --*

              The customer’s home phone number.

            * **EmailAddress** *(string) --*

              The customer’s email address, which has not been
              specified as a personal or business address.

            * **PersonalEmailAddress** *(string) --*

              The customer’s personal email address.

            * **BusinessEmailAddress** *(string) --*

              The customer’s business email address.

            * **Address** *(dict) --*

              A generic address associated with the customer that is
              not mailing, shipping, or billing.

              * **Address1** *(string) --*

                The first line of a customer address.

              * **Address2** *(string) --*

                The second line of a customer address.

              * **Address3** *(string) --*

                The third line of a customer address.

              * **Address4** *(string) --*

                The fourth line of a customer address.

              * **City** *(string) --*

                The city in which a customer lives.

              * **County** *(string) --*

                The county in which a customer lives.

              * **State** *(string) --*

                The state in which a customer lives.

              * **Province** *(string) --*

                The province in which a customer lives.

              * **Country** *(string) --*

                The country in which a customer lives.

              * **PostalCode** *(string) --*

                The postal code of a customer address.

            * **ShippingAddress** *(dict) --*

              The customer’s shipping address.

              * **Address1** *(string) --*

                The first line of a customer address.

              * **Address2** *(string) --*

                The second line of a customer address.

              * **Address3** *(string) --*

                The third line of a customer address.

              * **Address4** *(string) --*

                The fourth line of a customer address.

              * **City** *(string) --*

                The city in which a customer lives.

              * **County** *(string) --*

                The county in which a customer lives.

              * **State** *(string) --*

                The state in which a customer lives.

              * **Province** *(string) --*

                The province in which a customer lives.

              * **Country** *(string) --*

                The country in which a customer lives.

              * **PostalCode** *(string) --*

                The postal code of a customer address.

            * **MailingAddress** *(dict) --*

              The customer’s mailing address.

              * **Address1** *(string) --*

                The first line of a customer address.

              * **Address2** *(string) --*

                The second line of a customer address.

              * **Address3** *(string) --*

                The third line of a customer address.

              * **Address4** *(string) --*

                The fourth line of a customer address.

              * **City** *(string) --*

                The city in which a customer lives.

              * **County** *(string) --*

                The county in which a customer lives.

              * **State** *(string) --*

                The state in which a customer lives.

              * **Province** *(string) --*

                The province in which a customer lives.

              * **Country** *(string) --*

                The country in which a customer lives.

              * **PostalCode** *(string) --*

                The postal code of a customer address.

            * **BillingAddress** *(dict) --*

              The customer’s billing address.

              * **Address1** *(string) --*

                The first line of a customer address.

              * **Address2** *(string) --*

                The second line of a customer address.

              * **Address3** *(string) --*

                The third line of a customer address.

              * **Address4** *(string) --*

                The fourth line of a customer address.

              * **City** *(string) --*

                The city in which a customer lives.

              * **County** *(string) --*

                The county in which a customer lives.

              * **State** *(string) --*

                The state in which a customer lives.

              * **Province** *(string) --*

                The province in which a customer lives.

              * **Country** *(string) --*

                The country in which a customer lives.

              * **PostalCode** *(string) --*

                The postal code of a customer address.

            * **Attributes** *(dict) --*

              A key value pair of attributes of a customer profile.

              * *(string) --*

                * *(string) --*

            * **FoundByItems** *(list) --*

              A list of items used to find a profile returned in a
              SearchProfiles response. An item is a key-value(s) pair
              that matches an attribute in the profile.

              If the optional "AdditionalSearchKeys" parameter was
              included in the SearchProfiles request, the
              "FoundByItems" list should be interpreted based on the
              "LogicalOperator" used in the request:

              * "AND" - The profile included in the response matched
                all of the search keys specified in the request. The
                "FoundByItems" will include all of the key-value(s)
                pairs that were specified in the request (as this is a
                requirement of "AND" search logic).

              * "OR" - The profile included in the response matched at
                least one of the search keys specified in the request.
                The "FoundByItems" will include each of the key-
                value(s) pairs that the profile was found by.

              The "OR" relationship is the default behavior if the
              "LogicalOperator" parameter is not included in the
              SearchProfiles request.

              * *(dict) --*

                A data type pair that consists of a "KeyName" and
                "Values" list that were used to find a profile
                returned in response to a SearchProfiles request.

                * **KeyName** *(string) --*

                  A searchable identifier of a customer profile.

                * **Values** *(list) --*

                  A list of key values.

                  * *(string) --*

            * **PartyTypeString** *(string) --*

              An alternative to PartyType which accepts any string as
              input.

            * **GenderString** *(string) --*

              An alternative to Gender which accepts any string as
              input.

            * **ProfileType** *(string) --*

              The type of the profile.

            * **EngagementPreferences** *(dict) --*

              The customer or account’s engagement preferences.

              * **Phone** *(list) --*

                A list of phone-related contact preferences

                * *(dict) --*

                  Object that defines users contact preference.

                  * **KeyName** *(string) --*

                    A searchable, unique identifier of a customer
                    profile.

                  * **KeyValue** *(string) --*

                    The key value used to look up profile based off
                    the keyName.

                  * **ProfileId** *(string) --*

                    The unique identifier of a customer profile.

                  * **ContactType** *(string) --*

                    The contact type used for engagement. For example:
                    HomePhoneNumber, PersonalEmailAddress.

              * **Email** *(list) --*

                A list of email-related contact preferences

                * *(dict) --*

                  Object that defines users contact preference.

                  * **KeyName** *(string) --*

                    A searchable, unique identifier of a customer
                    profile.

                  * **KeyValue** *(string) --*

                    The key value used to look up profile based off
                    the keyName.

                  * **ProfileId** *(string) --*

                    The unique identifier of a customer profile.

                  * **ContactType** *(string) --*

                    The contact type used for engagement. For example:
                    HomePhoneNumber, PersonalEmailAddress.

        * **NextToken** *(string) --*

          The pagination token from the previous SearchProfiles API
          call.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / get_segment_estimate


get_segment_estimate
********************

CustomerProfiles.Client.get_segment_estimate(**kwargs)

   Gets the result of a segment estimate query.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.get_segment_estimate(
          DomainName='string',
          EstimateId='string'
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **EstimateId** (*string*) --

        **[REQUIRED]**

        The query Id passed by a previous "CreateSegmentEstimate"
        operation.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'DomainName': 'string',
             'EstimateId': 'string',
             'Status': 'RUNNING'|'SUCCEEDED'|'FAILED',
             'Estimate': 'string',
             'Message': 'string',
             'StatusCode': 123
         }

      **Response Structure**

      * *(dict) --*

        * **DomainName** *(string) --*

          The unique name of the domain.

        * **EstimateId** *(string) --*

          The "QueryId" which is the same as the value passed in
          "QueryId".

        * **Status** *(string) --*

          The current status of the query.

        * **Estimate** *(string) --*

          The estimated number of profiles contained in the segment.

        * **Message** *(string) --*

          The error message if there is any error.

        * **StatusCode** *(integer) --*

          The status code of the segment estimate.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / list_profile_objects


list_profile_objects
********************

CustomerProfiles.Client.list_profile_objects(**kwargs)

   Returns a list of objects associated with a profile of a given
   ProfileObjectType.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_profile_objects(
          NextToken='string',
          MaxResults=123,
          DomainName='string',
          ObjectTypeName='string',
          ProfileId='string',
          ObjectFilter={
              'KeyName': 'string',
              'Values': [
                  'string',
              ]
          }
      )

   Parameters:
      * **NextToken** (*string*) -- The pagination token from the
        previous call to ListProfileObjects.

      * **MaxResults** (*integer*) -- The maximum number of objects
        returned per page.

      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **ObjectTypeName** (*string*) --

        **[REQUIRED]**

        The name of the profile object type.

      * **ProfileId** (*string*) --

        **[REQUIRED]**

        The unique identifier of a customer profile.

      * **ObjectFilter** (*dict*) --

        Applies a filter to the response to include profile objects
        with the specified index values.

        * **KeyName** *(string) --* **[REQUIRED]**

          A searchable identifier of a profile object. The predefined
          keys you can use to search for "_asset" include: "_assetId",
          "_assetName", and "_serialNumber". The predefined keys you
          can use to search for "_case" include: "_caseId". The
          predefined keys you can use to search for "_order" include:
          "_orderId".

        * **Values** *(list) --* **[REQUIRED]**

          A list of key values.

          * *(string) --*

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'Items': [
                 {
                     'ObjectTypeName': 'string',
                     'ProfileObjectUniqueKey': 'string',
                     'Object': 'string'
                 },
             ],
             'NextToken': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **Items** *(list) --*

          The list of ListProfileObject instances.

          * *(dict) --*

            A ProfileObject in a list of ProfileObjects.

            * **ObjectTypeName** *(string) --*

              Specifies the kind of object being added to a profile,
              such as "Salesforce-Account."

            * **ProfileObjectUniqueKey** *(string) --*

              The unique identifier of the ProfileObject generated by
              the service.

            * **Object** *(string) --*

              A JSON representation of a ProfileObject that belongs to
              a profile.

        * **NextToken** *(string) --*

          The pagination token from the previous call to
          ListProfileObjects.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / list_domains


list_domains
************

CustomerProfiles.Client.list_domains(**kwargs)

   Returns a list of all the domains for an AWS account that have been
   created.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_domains(
          NextToken='string',
          MaxResults=123
      )

   Parameters:
      * **NextToken** (*string*) -- The pagination token from the
        previous ListDomain API call.

      * **MaxResults** (*integer*) -- The maximum number of objects
        returned per page.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'Items': [
                 {
                     'DomainName': 'string',
                     'CreatedAt': datetime(2015, 1, 1),
                     'LastUpdatedAt': datetime(2015, 1, 1),
                     'Tags': {
                         'string': 'string'
                     }
                 },
             ],
             'NextToken': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **Items** *(list) --*

          The list of ListDomains instances.

          * *(dict) --*

            An object in a list that represents a domain.

            * **DomainName** *(string) --*

              The unique name of the domain.

            * **CreatedAt** *(datetime) --*

              The timestamp of when the domain was created.

            * **LastUpdatedAt** *(datetime) --*

              The timestamp of when the domain was most recently
              edited.

            * **Tags** *(dict) --*

              The tags used to organize, track, or control access for
              this resource.

              * *(string) --*

                * *(string) --*

        * **NextToken** *(string) --*

          The pagination token from the previous ListDomains API call.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / list_event_streams


list_event_streams
******************

CustomerProfiles.Client.list_event_streams(**kwargs)

   Returns a list of all the event streams in a specific domain.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_event_streams(
          DomainName='string',
          NextToken='string',
          MaxResults=123
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **NextToken** (*string*) -- Identifies the next page of
        results to return.

      * **MaxResults** (*integer*) -- The maximum number of objects
        returned per page.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'Items': [
                 {
                     'DomainName': 'string',
                     'EventStreamName': 'string',
                     'EventStreamArn': 'string',
                     'State': 'RUNNING'|'STOPPED',
                     'StoppedSince': datetime(2015, 1, 1),
                     'DestinationSummary': {
                         'Uri': 'string',
                         'Status': 'HEALTHY'|'UNHEALTHY',
                         'UnhealthySince': datetime(2015, 1, 1)
                     },
                     'Tags': {
                         'string': 'string'
                     }
                 },
             ],
             'NextToken': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **Items** *(list) --*

          Contains summary information about an EventStream.

          * *(dict) --*

            An instance of EventStream in a list of EventStreams.

            * **DomainName** *(string) --*

              The unique name of the domain.

            * **EventStreamName** *(string) --*

              The name of the event stream.

            * **EventStreamArn** *(string) --*

              A unique identifier for the event stream.

            * **State** *(string) --*

              The operational state of destination stream for export.

            * **StoppedSince** *(datetime) --*

              The timestamp when the "State" changed to "STOPPED".

            * **DestinationSummary** *(dict) --*

              Summary information about the Kinesis data stream.

              * **Uri** *(string) --*

                The StreamARN of the destination to deliver profile
                events to. For example, arn:aws:kinesis:region
                :account-id:stream/stream-name.

              * **Status** *(string) --*

                The status of enabling the Kinesis stream as a
                destination for export.

              * **UnhealthySince** *(datetime) --*

                The timestamp when the status last changed to
                "UNHEALHY".

            * **Tags** *(dict) --*

              The tags used to organize, track, or control access for
              this resource.

              * *(string) --*

                * *(string) --*

        * **NextToken** *(string) --*

          Identifies the next page of results to return.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / can_paginate


can_paginate
************

CustomerProfiles.Client.can_paginate(operation_name)

   Check if an operation can be paginated.

   Parameters:
      **operation_name** (*string*) -- The operation name.  This is
      the same name as the method name on the client.  For example, if
      the method name is "create_foo", and you'd normally invoke the
      operation as "client.create_foo(**kwargs)", if the "create_foo"
      operation can be paginated, you can use the call
      "client.get_paginator("create_foo")".

   Returns:
      "True" if the operation can be paginated, "False" otherwise.
CustomerProfiles / Client / list_rule_based_matches


list_rule_based_matches
***********************

CustomerProfiles.Client.list_rule_based_matches(**kwargs)

   Returns a set of "MatchIds" that belong to the given domain.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_rule_based_matches(
          NextToken='string',
          MaxResults=123,
          DomainName='string'
      )

   Parameters:
      * **NextToken** (*string*) -- The pagination token from the
        previous "ListRuleBasedMatches" API call.

      * **MaxResults** (*integer*) -- The maximum number of "MatchIds"
        returned per page.

      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'MatchIds': [
                 'string',
             ],
             'NextToken': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **MatchIds** *(list) --*

          The list of "MatchIds" for the given domain.

          * *(string) --*

        * **NextToken** *(string) --*

          The pagination token from the previous
          "ListRuleBasedMatches" API call.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / update_calculated_attribute_definition


update_calculated_attribute_definition
**************************************

CustomerProfiles.Client.update_calculated_attribute_definition(**kwargs)

   Updates an existing calculated attribute definition. When updating
   the Conditions, note that increasing the date range of a calculated
   attribute will not trigger inclusion of historical data greater
   than the current date range.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.update_calculated_attribute_definition(
          DomainName='string',
          CalculatedAttributeName='string',
          DisplayName='string',
          Description='string',
          Conditions={
              'Range': {
                  'Value': 123,
                  'Unit': 'DAYS',
                  'ValueRange': {
                      'Start': 123,
                      'End': 123
                  },
                  'TimestampSource': 'string',
                  'TimestampFormat': 'string'
              },
              'ObjectCount': 123,
              'Threshold': {
                  'Value': 'string',
                  'Operator': 'EQUAL_TO'|'GREATER_THAN'|'LESS_THAN'|'NOT_EQUAL_TO'
              }
          }
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **CalculatedAttributeName** (*string*) --

        **[REQUIRED]**

        The unique name of the calculated attribute.

      * **DisplayName** (*string*) -- The display name of the
        calculated attribute.

      * **Description** (*string*) -- The description of the
        calculated attribute.

      * **Conditions** (*dict*) --

        The conditions including range, object count, and threshold
        for the calculated attribute.

        * **Range** *(dict) --*

          The relative time period over which data is included in the
          aggregation.

          * **Value** *(integer) --*

            The amount of time of the specified unit.

          * **Unit** *(string) --*

            The unit of time.

          * **ValueRange** *(dict) --*

            A structure letting customers specify a relative time
            window over which over which data is included in the
            Calculated Attribute. Use positive numbers to indicate
            that the endpoint is in the past, and negative numbers to
            indicate it is in the future. ValueRange overrides Value.

            * **Start** *(integer) --* **[REQUIRED]**

              The start time of when to include objects. Use positive
              numbers to indicate that the starting point is in the
              past, and negative numbers to indicate it is in the
              future.

            * **End** *(integer) --* **[REQUIRED]**

              The end time of when to include objects. Use positive
              numbers to indicate that the starting point is in the
              past, and negative numbers to indicate it is in the
              future.

          * **TimestampSource** *(string) --*

            An expression specifying the field in your JSON object
            from which the date should be parsed. The expression
            should follow the structure of "{ObjectTypeName.<Location
            of timestamp field in JSON pointer format>}". E.g. if your
            object type is MyType and source JSON is {"generatedAt":
            {"timestamp": "1737587945945"}}, then TimestampSource
            should be "{MyType.generatedAt.timestamp}".

          * **TimestampFormat** *(string) --*

            The format the timestamp field in your JSON object is
            specified. This value should be one of EPOCHMILLI (for
            Unix epoch timestamps with second/millisecond level
            precision) or ISO_8601 (following ISO_8601 format with
            second/millisecond level precision, with an optional
            offset of Z or in the format HH:MM or HHMM.). E.g. if your
            object type is MyType and source JSON is {"generatedAt":
            {"timestamp": "2001-07-04T12:08:56.235-0700"}}, then
            TimestampFormat should be "ISO_8601".

        * **ObjectCount** *(integer) --*

          The number of profile objects used for the calculated
          attribute.

        * **Threshold** *(dict) --*

          The threshold for the calculated attribute.

          * **Value** *(string) --* **[REQUIRED]**

            The value of the threshold.

          * **Operator** *(string) --* **[REQUIRED]**

            The operator of the threshold.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'CalculatedAttributeName': 'string',
             'DisplayName': 'string',
             'Description': 'string',
             'CreatedAt': datetime(2015, 1, 1),
             'LastUpdatedAt': datetime(2015, 1, 1),
             'Statistic': 'FIRST_OCCURRENCE'|'LAST_OCCURRENCE'|'COUNT'|'SUM'|'MINIMUM'|'MAXIMUM'|'AVERAGE'|'MAX_OCCURRENCE',
             'Conditions': {
                 'Range': {
                     'Value': 123,
                     'Unit': 'DAYS',
                     'ValueRange': {
                         'Start': 123,
                         'End': 123
                     },
                     'TimestampSource': 'string',
                     'TimestampFormat': 'string'
                 },
                 'ObjectCount': 123,
                 'Threshold': {
                     'Value': 'string',
                     'Operator': 'EQUAL_TO'|'GREATER_THAN'|'LESS_THAN'|'NOT_EQUAL_TO'
                 }
             },
             'AttributeDetails': {
                 'Attributes': [
                     {
                         'Name': 'string'
                     },
                 ],
                 'Expression': 'string'
             },
             'UseHistoricalData': True|False,
             'Status': 'PREPARING'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
             'Readiness': {
                 'ProgressPercentage': 123,
                 'Message': 'string'
             },
             'Tags': {
                 'string': 'string'
             }
         }

      **Response Structure**

      * *(dict) --*

        * **CalculatedAttributeName** *(string) --*

          The unique name of the calculated attribute.

        * **DisplayName** *(string) --*

          The display name of the calculated attribute.

        * **Description** *(string) --*

          The description of the calculated attribute.

        * **CreatedAt** *(datetime) --*

          The timestamp of when the calculated attribute definition
          was created.

        * **LastUpdatedAt** *(datetime) --*

          The timestamp of when the calculated attribute definition
          was most recently edited.

        * **Statistic** *(string) --*

          The aggregation operation to perform for the calculated
          attribute.

        * **Conditions** *(dict) --*

          The conditions including range, object count, and threshold
          for the calculated attribute.

          * **Range** *(dict) --*

            The relative time period over which data is included in
            the aggregation.

            * **Value** *(integer) --*

              The amount of time of the specified unit.

            * **Unit** *(string) --*

              The unit of time.

            * **ValueRange** *(dict) --*

              A structure letting customers specify a relative time
              window over which over which data is included in the
              Calculated Attribute. Use positive numbers to indicate
              that the endpoint is in the past, and negative numbers
              to indicate it is in the future. ValueRange overrides
              Value.

              * **Start** *(integer) --*

                The start time of when to include objects. Use
                positive numbers to indicate that the starting point
                is in the past, and negative numbers to indicate it is
                in the future.

              * **End** *(integer) --*

                The end time of when to include objects. Use positive
                numbers to indicate that the starting point is in the
                past, and negative numbers to indicate it is in the
                future.

            * **TimestampSource** *(string) --*

              An expression specifying the field in your JSON object
              from which the date should be parsed. The expression
              should follow the structure of
              "{ObjectTypeName.<Location of timestamp field in JSON
              pointer format>}". E.g. if your object type is MyType
              and source JSON is {"generatedAt": {"timestamp":
              "1737587945945"}}, then TimestampSource should be
              "{MyType.generatedAt.timestamp}".

            * **TimestampFormat** *(string) --*

              The format the timestamp field in your JSON object is
              specified. This value should be one of EPOCHMILLI (for
              Unix epoch timestamps with second/millisecond level
              precision) or ISO_8601 (following ISO_8601 format with
              second/millisecond level precision, with an optional
              offset of Z or in the format HH:MM or HHMM.). E.g. if
              your object type is MyType and source JSON is
              {"generatedAt": {"timestamp":
              "2001-07-04T12:08:56.235-0700"}}, then TimestampFormat
              should be "ISO_8601".

          * **ObjectCount** *(integer) --*

            The number of profile objects used for the calculated
            attribute.

          * **Threshold** *(dict) --*

            The threshold for the calculated attribute.

            * **Value** *(string) --*

              The value of the threshold.

            * **Operator** *(string) --*

              The operator of the threshold.

        * **AttributeDetails** *(dict) --*

          The mathematical expression and a list of attribute items
          specified in that expression.

          * **Attributes** *(list) --*

            A list of attribute items specified in the mathematical
            expression.

            * *(dict) --*

              The details of a single attribute item specified in the
              mathematical expression.

              * **Name** *(string) --*

                The name of an attribute defined in a profile object
                type.

          * **Expression** *(string) --*

            Mathematical expression that is performed on attribute
            items provided in the attribute list. Each element in the
            expression should follow the structure of
            "{ObjectTypeName.AttributeName}".

        * **UseHistoricalData** *(boolean) --*

          Whether historical data ingested before the Calculated
          Attribute was created should be included in calculations.

        * **Status** *(string) --*

          Status of the Calculated Attribute creation (whether all
          historical data has been indexed.)

        * **Readiness** *(dict) --*

          Information indicating if the Calculated Attribute is ready
          for use by confirming all historical data has been processed
          and reflected.

          * **ProgressPercentage** *(integer) --*

            Approximately how far the Calculated Attribute creation is
            from completion.

          * **Message** *(string) --*

            Any customer messaging.

        * **Tags** *(dict) --*

          The tags used to organize, track, or control access for this
          resource.

          * *(string) --*

            * *(string) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / list_profile_object_types


list_profile_object_types
*************************

CustomerProfiles.Client.list_profile_object_types(**kwargs)

   Lists all of the templates available within the service.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_profile_object_types(
          DomainName='string',
          NextToken='string',
          MaxResults=123
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **NextToken** (*string*) -- Identifies the next page of
        results to return.

      * **MaxResults** (*integer*) -- The maximum number of objects
        returned per page.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'Items': [
                 {
                     'ObjectTypeName': 'string',
                     'Description': 'string',
                     'CreatedAt': datetime(2015, 1, 1),
                     'LastUpdatedAt': datetime(2015, 1, 1),
                     'MaxProfileObjectCount': 123,
                     'MaxAvailableProfileObjectCount': 123,
                     'Tags': {
                         'string': 'string'
                     }
                 },
             ],
             'NextToken': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **Items** *(list) --*

          The list of ListProfileObjectTypes instances.

          * *(dict) --*

            A ProfileObjectType instance.

            * **ObjectTypeName** *(string) --*

              The name of the profile object type.

            * **Description** *(string) --*

              Description of the profile object type.

            * **CreatedAt** *(datetime) --*

              The timestamp of when the domain was created.

            * **LastUpdatedAt** *(datetime) --*

              The timestamp of when the domain was most recently
              edited.

            * **MaxProfileObjectCount** *(integer) --*

              The amount of profile object max count assigned to the
              object type.

            * **MaxAvailableProfileObjectCount** *(integer) --*

              The amount of provisioned profile object max count
              available.

            * **Tags** *(dict) --*

              The tags used to organize, track, or control access for
              this resource.

              * *(string) --*

                * *(string) --*

        * **NextToken** *(string) --*

          Identifies the next page of results to return.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / merge_profiles


merge_profiles
**************

CustomerProfiles.Client.merge_profiles(**kwargs)

   Runs an AWS Lambda job that does the following:

   * All the profileKeys in the "ProfileToBeMerged" will be moved to
     the main profile.

   * All the objects in the "ProfileToBeMerged" will be moved to the
     main profile.

   * All the "ProfileToBeMerged" will be deleted at the end.

   * All the profileKeys in the "ProfileIdsToBeMerged" will be moved
     to the main profile.

   * Standard fields are merged as follows:

     * Fields are always "union"-ed if there are no conflicts in
       standard fields or attributeKeys.

     * When there are conflicting fields:

       * If no "SourceProfileIds" entry is specified, the main Profile
         value is always taken.

       * If a "SourceProfileIds" entry is specified, the specified
         profileId is always taken, even if it is a NULL value.

   You can use MergeProfiles together with GetMatches, which returns
   potentially matching profiles, or use it with the results of
   another matching system. After profiles have been merged, they
   cannot be separated (unmerged).

   See also: AWS API Documentation

   **Request Syntax**

      response = client.merge_profiles(
          DomainName='string',
          MainProfileId='string',
          ProfileIdsToBeMerged=[
              'string',
          ],
          FieldSourceProfileIds={
              'AccountNumber': 'string',
              'AdditionalInformation': 'string',
              'PartyType': 'string',
              'BusinessName': 'string',
              'FirstName': 'string',
              'MiddleName': 'string',
              'LastName': 'string',
              'BirthDate': 'string',
              'Gender': 'string',
              'PhoneNumber': 'string',
              'MobilePhoneNumber': 'string',
              'HomePhoneNumber': 'string',
              'BusinessPhoneNumber': 'string',
              'EmailAddress': 'string',
              'PersonalEmailAddress': 'string',
              'BusinessEmailAddress': 'string',
              'Address': 'string',
              'ShippingAddress': 'string',
              'MailingAddress': 'string',
              'BillingAddress': 'string',
              'Attributes': {
                  'string': 'string'
              },
              'ProfileType': 'string',
              'EngagementPreferences': 'string'
          }
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **MainProfileId** (*string*) --

        **[REQUIRED]**

        The identifier of the profile to be taken.

      * **ProfileIdsToBeMerged** (*list*) --

        **[REQUIRED]**

        The identifier of the profile to be merged into MainProfileId.

        * *(string) --*

      * **FieldSourceProfileIds** (*dict*) --

        The identifiers of the fields in the profile that has the
        information you want to apply to the merge. For example, say
        you want to merge EmailAddress from Profile1 into MainProfile.
        This would be the identifier of the EmailAddress field in
        Profile1.

        * **AccountNumber** *(string) --*

          A unique identifier for the account number field to be
          merged.

        * **AdditionalInformation** *(string) --*

          A unique identifier for the additional information field to
          be merged.

        * **PartyType** *(string) --*

          A unique identifier for the party type field to be merged.

        * **BusinessName** *(string) --*

          A unique identifier for the business name field to be
          merged.

        * **FirstName** *(string) --*

          A unique identifier for the first name field to be merged.

        * **MiddleName** *(string) --*

          A unique identifier for the middle name field to be merged.

        * **LastName** *(string) --*

          A unique identifier for the last name field to be merged.

        * **BirthDate** *(string) --*

          A unique identifier for the birthdate field to be merged.

        * **Gender** *(string) --*

          A unique identifier for the gender field to be merged.

        * **PhoneNumber** *(string) --*

          A unique identifier for the phone number field to be merged.

        * **MobilePhoneNumber** *(string) --*

          A unique identifier for the mobile phone number field to be
          merged.

        * **HomePhoneNumber** *(string) --*

          A unique identifier for the home phone number field to be
          merged.

        * **BusinessPhoneNumber** *(string) --*

          A unique identifier for the business phone number field to
          be merged.

        * **EmailAddress** *(string) --*

          A unique identifier for the email address field to be
          merged.

        * **PersonalEmailAddress** *(string) --*

          A unique identifier for the personal email address field to
          be merged.

        * **BusinessEmailAddress** *(string) --*

          A unique identifier for the party type field to be merged.

        * **Address** *(string) --*

          A unique identifier for the party type field to be merged.

        * **ShippingAddress** *(string) --*

          A unique identifier for the shipping address field to be
          merged.

        * **MailingAddress** *(string) --*

          A unique identifier for the mailing address field to be
          merged.

        * **BillingAddress** *(string) --*

          A unique identifier for the billing type field to be merged.

        * **Attributes** *(dict) --*

          A unique identifier for the attributes field to be merged.

          * *(string) --*

            * *(string) --*

        * **ProfileType** *(string) --*

          A unique identifier for the profile type field to be merged.

        * **EngagementPreferences** *(string) --*

          A unique identifier for the engagement preferences field to
          be merged.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'Message': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **Message** *(string) --*

          A message that indicates the merge request is complete.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / get_segment_snapshot


get_segment_snapshot
********************

CustomerProfiles.Client.get_segment_snapshot(**kwargs)

   Retrieve the latest status of a segment snapshot.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.get_segment_snapshot(
          DomainName='string',
          SegmentDefinitionName='string',
          SnapshotId='string'
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique identifier of the domain.

      * **SegmentDefinitionName** (*string*) --

        **[REQUIRED]**

        The unique name of the segment definition.

      * **SnapshotId** (*string*) --

        **[REQUIRED]**

        The unique identifier of the segment snapshot.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'SnapshotId': 'string',
             'Status': 'COMPLETED'|'IN_PROGRESS'|'FAILED',
             'StatusMessage': 'string',
             'DataFormat': 'CSV'|'JSONL'|'ORC',
             'EncryptionKey': 'string',
             'RoleArn': 'string',
             'DestinationUri': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **SnapshotId** *(string) --*

          The unique identifier of the segment snapshot.

        * **Status** *(string) --*

          The status of the asynchronous job for exporting the segment
          snapshot.

        * **StatusMessage** *(string) --*

          The status message of the asynchronous job for exporting the
          segment snapshot.

        * **DataFormat** *(string) --*

          The format in which the segment will be exported.

        * **EncryptionKey** *(string) --*

          The Amazon Resource Name (ARN) of the KMS key used to
          encrypt the exported segment.

        * **RoleArn** *(string) --*

          The Amazon Resource Name (ARN) of the IAM role that allows
          Customer Profiles service principal to assume the role for
          conducting KMS and S3 operations.

        * **DestinationUri** *(string) --*

          The destination to which the segment will be exported. This
          field must be provided if the request is not submitted from
          the Amazon Connect Admin Website.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / get_similar_profiles


get_similar_profiles
********************

CustomerProfiles.Client.get_similar_profiles(**kwargs)

   Returns a set of profiles that belong to the same matching group
   using the "matchId" or "profileId". You can also specify the type
   of matching that you want for finding similar profiles using either
   "RULE_BASED_MATCHING" or "ML_BASED_MATCHING".

   See also: AWS API Documentation

   **Request Syntax**

      response = client.get_similar_profiles(
          NextToken='string',
          MaxResults=123,
          DomainName='string',
          MatchType='RULE_BASED_MATCHING'|'ML_BASED_MATCHING',
          SearchKey='string',
          SearchValue='string'
      )

   Parameters:
      * **NextToken** (*string*) -- The pagination token from the
        previous "GetSimilarProfiles" API call.

      * **MaxResults** (*integer*) -- The maximum number of objects
        returned per page.

      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **MatchType** (*string*) --

        **[REQUIRED]**

        Specify the type of matching to get similar profiles for.

      * **SearchKey** (*string*) --

        **[REQUIRED]**

        The string indicating the search key to be used.

      * **SearchValue** (*string*) --

        **[REQUIRED]**

        The string based on "SearchKey" to be searched for similar
        profiles.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'ProfileIds': [
                 'string',
             ],
             'MatchId': 'string',
             'MatchType': 'RULE_BASED_MATCHING'|'ML_BASED_MATCHING',
             'RuleLevel': 123,
             'ConfidenceScore': 123.0,
             'NextToken': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **ProfileIds** *(list) --*

          Set of >>``<<profileId``s that belong to the same matching
          group.

          * *(string) --*

        * **MatchId** *(string) --*

          The string "matchId" that the similar profiles belong to.

        * **MatchType** *(string) --*

          Specify the type of matching to get similar profiles for.

        * **RuleLevel** *(integer) --*

          The integer rule level that the profiles matched on.

        * **ConfidenceScore** *(float) --*

          It only has value when the "MatchType" is
          "ML_BASED_MATCHING".A number between 0 and 1, where a higher
          score means higher similarity. Examining match confidence
          scores lets you distinguish between groups of similar
          records in which the system is highly confident (which you
          may decide to merge), groups of similar records about which
          the system is uncertain (which you may decide to have
          reviewed by a human), and groups of similar records that the
          system deems to be unlikely (which you may decide to
          reject). Given confidence scores vary as per the data input,
          it should not be used as an absolute measure of matching
          quality.

        * **NextToken** *(string) --*

          The pagination token from the previous "GetSimilarProfiles"
          API call.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / delete_workflow


delete_workflow
***************

CustomerProfiles.Client.delete_workflow(**kwargs)

   Deletes the specified workflow and all its corresponding resources.
   This is an async process.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.delete_workflow(
          DomainName='string',
          WorkflowId='string'
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **WorkflowId** (*string*) --

        **[REQUIRED]**

        Unique identifier for the workflow.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {}

      **Response Structure**

      * *(dict) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / add_profile_key


add_profile_key
***************

CustomerProfiles.Client.add_profile_key(**kwargs)

   Associates a new key value with a specific profile, such as a
   Contact Record ContactId.

   A profile object can have a single unique key and any number of
   additional keys that can be used to identify the profile that it
   belongs to.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.add_profile_key(
          ProfileId='string',
          KeyName='string',
          Values=[
              'string',
          ],
          DomainName='string'
      )

   Parameters:
      * **ProfileId** (*string*) --

        **[REQUIRED]**

        The unique identifier of a customer profile.

      * **KeyName** (*string*) --

        **[REQUIRED]**

        A searchable identifier of a customer profile. The predefined
        keys you can use include: _account, _profileId, _assetId,
        _caseId, _orderId, _fullName, _phone, _email, _ctrContactId,
        _marketoLeadId, _salesforceAccountId, _salesforceContactId,
        _salesforceAssetId, _zendeskUserId, _zendeskExternalId,
        _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId,
        _segmentUserId, _shopifyCustomerId, _shopifyOrderId.

      * **Values** (*list*) --

        **[REQUIRED]**

        A list of key values.

        * *(string) --*

      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'KeyName': 'string',
             'Values': [
                 'string',
             ]
         }

      **Response Structure**

      * *(dict) --*

        * **KeyName** *(string) --*

          A searchable identifier of a customer profile.

        * **Values** *(list) --*

          A list of key values.

          * *(string) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / get_matches


get_matches
***********

CustomerProfiles.Client.get_matches(**kwargs)

   Before calling this API, use CreateDomain or UpdateDomain to enable
   identity resolution: set "Matching" to true.

   GetMatches returns potentially matching profiles, based on the
   results of the latest run of a machine learning process.

   Warning:

     The process of matching duplicate profiles. If "Matching" =
     "true", Amazon Connect Customer Profiles starts a weekly batch
     process called Identity Resolution Job. If you do not specify a
     date and time for Identity Resolution Job to run, by default it
     runs every Saturday at 12AM UTC to detect duplicate profiles in
     your domains.After the Identity Resolution Job completes, use the
     GetMatches API to return and review the results. Or, if you have
     configured "ExportingConfig" in the "MatchingRequest", you can
     download the results from S3.

   Amazon Connect uses the following profile attributes to identify
   matches:

   * PhoneNumber

   * HomePhoneNumber

   * BusinessPhoneNumber

   * MobilePhoneNumber

   * EmailAddress

   * PersonalEmailAddress

   * BusinessEmailAddress

   * FullName

   For example, two or more profiles—with spelling mistakes such as
   **John Doe** and **Jhn Doe**, or different casing email addresses
   such as **JOHN_DOE@ANYCOMPANY.COM** and **johndoe@anycompany.com**,
   or different phone number formats such as **555-010-0000** and
   **+1-555-010-0000**—can be detected as belonging to the same
   customer **John Doe** and merged into a unified profile.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.get_matches(
          NextToken='string',
          MaxResults=123,
          DomainName='string'
      )

   Parameters:
      * **NextToken** (*string*) -- 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.

      * **MaxResults** (*integer*) -- The maximum number of results to
        return per page.

      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'NextToken': 'string',
             'MatchGenerationDate': datetime(2015, 1, 1),
             'PotentialMatches': 123,
             'Matches': [
                 {
                     'MatchId': 'string',
                     'ProfileIds': [
                         'string',
                     ],
                     'ConfidenceScore': 123.0
                 },
             ]
         }

      **Response Structure**

      * *(dict) --*

        * **NextToken** *(string) --*

          If there are additional results, this is the token for the
          next set of results.

        * **MatchGenerationDate** *(datetime) --*

          The timestamp this version of Match Result generated.

        * **PotentialMatches** *(integer) --*

          The number of potential matches found.

        * **Matches** *(list) --*

          The list of matched profiles for this instance.

          * *(dict) --*

            The Match group object.

            * **MatchId** *(string) --*

              The unique identifiers for this group of profiles that
              match.

            * **ProfileIds** *(list) --*

              A list of identifiers for profiles that match.

              * *(string) --*

            * **ConfidenceScore** *(float) --*

              A number between 0 and 1, where a higher score means
              higher similarity. Examining match confidence scores
              lets you distinguish between groups of similar records
              in which the system is highly confident (which you may
              decide to merge), groups of similar records about which
              the system is uncertain (which you may decide to have
              reviewed by a human), and groups of similar records that
              the system deems to be unlikely (which you may decide to
              reject). Given confidence scores vary as per the data
              input, it should not be used an absolute measure of
              matching quality.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / list_calculated_attribute_definitions


list_calculated_attribute_definitions
*************************************

CustomerProfiles.Client.list_calculated_attribute_definitions(**kwargs)

   Lists calculated attribute definitions for Customer Profiles

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_calculated_attribute_definitions(
          DomainName='string',
          NextToken='string',
          MaxResults=123
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **NextToken** (*string*) -- The pagination token from the
        previous call to ListCalculatedAttributeDefinitions.

      * **MaxResults** (*integer*) -- The maximum number of calculated
        attribute definitions returned per page.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'Items': [
                 {
                     'CalculatedAttributeName': 'string',
                     'DisplayName': 'string',
                     'Description': 'string',
                     'CreatedAt': datetime(2015, 1, 1),
                     'LastUpdatedAt': datetime(2015, 1, 1),
                     'UseHistoricalData': True|False,
                     'Status': 'PREPARING'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
                     'Tags': {
                         'string': 'string'
                     }
                 },
             ],
             'NextToken': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **Items** *(list) --*

          The list of calculated attribute definitions.

          * *(dict) --*

            The details of a single calculated attribute definition.

            * **CalculatedAttributeName** *(string) --*

              The unique name of the calculated attribute.

            * **DisplayName** *(string) --*

              The display name of the calculated attribute.

            * **Description** *(string) --*

              The threshold for the calculated attribute.

            * **CreatedAt** *(datetime) --*

              The threshold for the calculated attribute.

            * **LastUpdatedAt** *(datetime) --*

              The timestamp of when the calculated attribute
              definition was most recently edited.

            * **UseHistoricalData** *(boolean) --*

              Whether historical data ingested before the Calculated
              Attribute was created should be included in
              calculations.

            * **Status** *(string) --*

              Status of the Calculated Attribute creation (whether all
              historical data has been indexed.)

            * **Tags** *(dict) --*

              The tags used to organize, track, or control access for
              this resource.

              * *(string) --*

                * *(string) --*

        * **NextToken** *(string) --*

          The pagination token from the previous call to
          ListCalculatedAttributeDefinitions.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / delete_event_trigger


delete_event_trigger
********************

CustomerProfiles.Client.delete_event_trigger(**kwargs)

   Disable and deletes the Event Trigger.

   Note:

     You cannot delete an Event Trigger with an active Integration
     associated.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.delete_event_trigger(
          DomainName='string',
          EventTriggerName='string'
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **EventTriggerName** (*string*) --

        **[REQUIRED]**

        The unique name of the event trigger.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'Message': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **Message** *(string) --*

          A message that indicates the delete request is done.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / get_integration


get_integration
***************

CustomerProfiles.Client.get_integration(**kwargs)

   Returns an integration for a domain.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.get_integration(
          DomainName='string',
          Uri='string'
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **Uri** (*string*) --

        **[REQUIRED]**

        The URI of the S3 bucket or any other type of data source.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'DomainName': 'string',
             'Uri': 'string',
             'ObjectTypeName': 'string',
             'CreatedAt': datetime(2015, 1, 1),
             'LastUpdatedAt': datetime(2015, 1, 1),
             'Tags': {
                 'string': 'string'
             },
             'ObjectTypeNames': {
                 'string': 'string'
             },
             'WorkflowId': 'string',
             'IsUnstructured': True|False,
             'RoleArn': 'string',
             'EventTriggerNames': [
                 'string',
             ]
         }

      **Response Structure**

      * *(dict) --*

        * **DomainName** *(string) --*

          The unique name of the domain.

        * **Uri** *(string) --*

          The URI of the S3 bucket or any other type of data source.

        * **ObjectTypeName** *(string) --*

          The name of the profile object type.

        * **CreatedAt** *(datetime) --*

          The timestamp of when the domain was created.

        * **LastUpdatedAt** *(datetime) --*

          The timestamp of when the domain was most recently edited.

        * **Tags** *(dict) --*

          The tags used to organize, track, or control access for this
          resource.

          * *(string) --*

            * *(string) --*

        * **ObjectTypeNames** *(dict) --*

          A map in which each key is an event type from an external
          application such as Segment or Shopify, and each value is an
          "ObjectTypeName" (template) used to ingest the event. It
          supports the following event types: "SegmentIdentify",
          "ShopifyCreateCustomers", "ShopifyUpdateCustomers",
          "ShopifyCreateDraftOrders", "ShopifyUpdateDraftOrders",
          "ShopifyCreateOrders", and "ShopifyUpdatedOrders".

          * *(string) --*

            * *(string) --*

        * **WorkflowId** *(string) --*

          Unique identifier for the workflow.

        * **IsUnstructured** *(boolean) --*

          Boolean that shows if the Flow that's associated with the
          Integration is created in Amazon Appflow, or with
          ObjectTypeName equals _unstructured via API/CLI in
          flowDefinition.

        * **RoleArn** *(string) --*

          The Amazon Resource Name (ARN) of the IAM role. The
          Integration uses this role to make Customer Profiles
          requests on your behalf.

        * **EventTriggerNames** *(list) --*

          A list of unique names for active event triggers associated
          with the integration. This list would be empty if no Event
          Trigger is associated with the integration.

          * *(string) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / create_segment_snapshot


create_segment_snapshot
***********************

CustomerProfiles.Client.create_segment_snapshot(**kwargs)

   Triggers a job to export a segment to a specified destination.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.create_segment_snapshot(
          DomainName='string',
          SegmentDefinitionName='string',
          DataFormat='CSV'|'JSONL'|'ORC',
          EncryptionKey='string',
          RoleArn='string',
          DestinationUri='string'
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **SegmentDefinitionName** (*string*) --

        **[REQUIRED]**

        The name of the segment definition used in this snapshot
        request.

      * **DataFormat** (*string*) --

        **[REQUIRED]**

        The format in which the segment will be exported.

      * **EncryptionKey** (*string*) -- The Amazon Resource Name (ARN)
        of the KMS key used to encrypt the exported segment.

      * **RoleArn** (*string*) -- The Amazon Resource Name (ARN) of
        the IAM role that allows Customer Profiles service principal
        to assume the role for conducting KMS and S3 operations.

      * **DestinationUri** (*string*) -- The destination to which the
        segment will be exported. This field must be provided if the
        request is not submitted from the Amazon Connect Admin
        Website.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'SnapshotId': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **SnapshotId** *(string) --*

          The unique identifier of the segment snapshot.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / get_workflow


get_workflow
************

CustomerProfiles.Client.get_workflow(**kwargs)

   Get details of specified workflow.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.get_workflow(
          DomainName='string',
          WorkflowId='string'
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **WorkflowId** (*string*) --

        **[REQUIRED]**

        Unique identifier for the workflow.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'WorkflowId': 'string',
             'WorkflowType': 'APPFLOW_INTEGRATION',
             'Status': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETE'|'FAILED'|'SPLIT'|'RETRY'|'CANCELLED',
             'ErrorDescription': 'string',
             'StartDate': datetime(2015, 1, 1),
             'LastUpdatedAt': datetime(2015, 1, 1),
             'Attributes': {
                 'AppflowIntegration': {
                     'SourceConnectorType': 'Salesforce'|'Marketo'|'Zendesk'|'Servicenow'|'S3',
                     'ConnectorProfileName': 'string',
                     'RoleArn': 'string'
                 }
             },
             'Metrics': {
                 'AppflowIntegration': {
                     'RecordsProcessed': 123,
                     'StepsCompleted': 123,
                     'TotalSteps': 123
                 }
             }
         }

      **Response Structure**

      * *(dict) --*

        * **WorkflowId** *(string) --*

          Unique identifier for the workflow.

        * **WorkflowType** *(string) --*

          The type of workflow. The only supported value is
          APPFLOW_INTEGRATION.

        * **Status** *(string) --*

          Status of workflow execution.

        * **ErrorDescription** *(string) --*

          Workflow error messages during execution (if any).

        * **StartDate** *(datetime) --*

          The timestamp that represents when workflow execution
          started.

        * **LastUpdatedAt** *(datetime) --*

          The timestamp that represents when workflow execution last
          updated.

        * **Attributes** *(dict) --*

          Attributes provided for workflow execution.

          * **AppflowIntegration** *(dict) --*

            Workflow attributes specific to "APPFLOW_INTEGRATION"
            workflow.

            * **SourceConnectorType** *(string) --*

              Specifies the source connector type, such as Salesforce,
              ServiceNow, and Marketo. Indicates source of ingestion.

            * **ConnectorProfileName** *(string) --*

              The name of the AppFlow connector profile used for
              ingestion.

            * **RoleArn** *(string) --*

              The Amazon Resource Name (ARN) of the IAM role. Customer
              Profiles assumes this role to create resources on your
              behalf as part of workflow execution.

        * **Metrics** *(dict) --*

          Workflow specific execution metrics.

          * **AppflowIntegration** *(dict) --*

            Workflow execution metrics for "APPFLOW_INTEGRATION"
            workflow.

            * **RecordsProcessed** *(integer) --*

              Number of records processed in "APPFLOW_INTEGRATION"
              workflow.

            * **StepsCompleted** *(integer) --*

              Total steps completed in "APPFLOW_INTEGRATION" workflow.

            * **TotalSteps** *(integer) --*

              Total steps in "APPFLOW_INTEGRATION" workflow.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / list_upload_jobs


list_upload_jobs
****************

CustomerProfiles.Client.list_upload_jobs(**kwargs)

   This API retrieves a list of upload jobs for the specified domain.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_upload_jobs(
          DomainName='string',
          MaxResults=123,
          NextToken='string'
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain to list upload jobs for.

      * **MaxResults** (*integer*) -- The maximum number of upload
        jobs to return per page.

      * **NextToken** (*string*) -- The pagination token from the
        previous call to retrieve the next page of results.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'NextToken': 'string',
             'Items': [
                 {
                     'JobId': 'string',
                     'DisplayName': 'string',
                     'Status': 'CREATED'|'IN_PROGRESS'|'PARTIALLY_SUCCEEDED'|'SUCCEEDED'|'FAILED'|'STOPPED',
                     'StatusReason': 'VALIDATION_FAILURE'|'INTERNAL_FAILURE',
                     'CreatedAt': datetime(2015, 1, 1),
                     'CompletedAt': datetime(2015, 1, 1),
                     'DataExpiry': 123
                 },
             ]
         }

      **Response Structure**

      * *(dict) --*

        * **NextToken** *(string) --*

          The pagination token to use to retrieve the next page of
          results.

        * **Items** *(list) --*

          The list of upload jobs for the specified domain.

          * *(dict) --*

            The summary information for an individual upload job.

            * **JobId** *(string) --*

              The unique identifier of the upload job.

            * **DisplayName** *(string) --*

              The name of the upload job.

            * **Status** *(string) --*

              The current status of the upload job.

            * **StatusReason** *(string) --*

              The reason for the current status of the upload job.

            * **CreatedAt** *(datetime) --*

              The timestamp when the upload job was created.

            * **CompletedAt** *(datetime) --*

              The timestamp when the upload job was completed.

            * **DataExpiry** *(integer) --*

              The expiry duration for the profiles ingested with the
              upload job.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"
CustomerProfiles / Client / list_calculated_attributes_for_profile


list_calculated_attributes_for_profile
**************************************

CustomerProfiles.Client.list_calculated_attributes_for_profile(**kwargs)

   Retrieve a list of calculated attributes for a customer profile.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_calculated_attributes_for_profile(
          NextToken='string',
          MaxResults=123,
          DomainName='string',
          ProfileId='string'
      )

   Parameters:
      * **NextToken** (*string*) -- The pagination token from the
        previous call to ListCalculatedAttributesForProfile.

      * **MaxResults** (*integer*) -- The maximum number of calculated
        attributes returned per page.

      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **ProfileId** (*string*) --

        **[REQUIRED]**

        The unique identifier of a customer profile.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'Items': [
                 {
                     'CalculatedAttributeName': 'string',
                     'DisplayName': 'string',
                     'IsDataPartial': 'string',
                     'Value': 'string',
                     'LastObjectTimestamp': datetime(2015, 1, 1)
                 },
             ],
             'NextToken': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **Items** *(list) --*

          The list of calculated attributes.

          * *(dict) --*

            The details of a single calculated attribute for a
            profile.

            * **CalculatedAttributeName** *(string) --*

              The unique name of the calculated attribute.

            * **DisplayName** *(string) --*

              The display name of the calculated attribute.

            * **IsDataPartial** *(string) --*

              Indicates whether the calculated attribute’s value is
              based on partial data. If data is partial, it is set to
              true.

            * **Value** *(string) --*

              The value of the calculated attribute.

            * **LastObjectTimestamp** *(datetime) --*

              The timestamp of the newest object included in the
              calculated attribute calculation.

        * **NextToken** *(string) --*

          The pagination token from the previous call to
          ListCalculatedAttributesForProfile.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / list_tags_for_resource


list_tags_for_resource
**********************

CustomerProfiles.Client.list_tags_for_resource(**kwargs)

   Displays the tags associated with an Amazon Connect Customer
   Profiles resource. In Connect Customer Profiles, domains, profile
   object types, and integrations can be tagged.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_tags_for_resource(
          resourceArn='string'
      )

   Parameters:
      **resourceArn** (*string*) --

      **[REQUIRED]**

      The ARN of the resource for which you want to view tags.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'tags': {
                 'string': 'string'
             }
         }

      **Response Structure**

      * *(dict) --*

        * **tags** *(dict) --*

          The tags used to organize, track, or control access for this
          resource.

          * *(string) --*

            * *(string) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.InternalServerException"

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"
CustomerProfiles / Client / create_domain


create_domain
*************

CustomerProfiles.Client.create_domain(**kwargs)

   Creates a domain, which is a container for all customer data, such
   as customer profile attributes, object types, profile keys, and
   encryption keys. You can create multiple domains, and each domain
   can have multiple third-party integrations.

   Each Amazon Connect instance can be associated with only one
   domain. Multiple Amazon Connect instances can be associated with
   one domain.

   Use this API or UpdateDomain to enable identity resolution: set
   "Matching" to true.

   To prevent cross-service impersonation when you call this API, see
   Cross-service confused deputy prevention for sample policies that
   you should apply.

   Note:

     It is not possible to associate a Customer Profiles domain with
     an Amazon Connect Instance directly from the API. If you would
     like to create a domain and associate a Customer Profiles domain,
     use the Amazon Connect admin website. For more information, see
     Enable Customer Profiles.Each Amazon Connect instance can be
     associated with only one domain. Multiple Amazon Connect
     instances can be associated with one domain.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.create_domain(
          DomainName='string',
          DefaultExpirationDays=123,
          DefaultEncryptionKey='string',
          DeadLetterQueueUrl='string',
          Matching={
              'Enabled': True|False,
              'JobSchedule': {
                  'DayOfTheWeek': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
                  'Time': 'string'
              },
              'AutoMerging': {
                  'Enabled': True|False,
                  'Consolidation': {
                      'MatchingAttributesList': [
                          [
                              'string',
                          ],
                      ]
                  },
                  'ConflictResolution': {
                      'ConflictResolvingModel': 'RECENCY'|'SOURCE',
                      'SourceName': 'string'
                  },
                  'MinAllowedConfidenceScoreForMerging': 123.0
              },
              'ExportingConfig': {
                  'S3Exporting': {
                      'S3BucketName': 'string',
                      'S3KeyName': 'string'
                  }
              }
          },
          RuleBasedMatching={
              'Enabled': True|False,
              'MatchingRules': [
                  {
                      'Rule': [
                          'string',
                      ]
                  },
              ],
              'MaxAllowedRuleLevelForMerging': 123,
              'MaxAllowedRuleLevelForMatching': 123,
              'AttributeTypesSelector': {
                  'AttributeMatchingModel': 'ONE_TO_ONE'|'MANY_TO_MANY',
                  'Address': [
                      'string',
                  ],
                  'PhoneNumber': [
                      'string',
                  ],
                  'EmailAddress': [
                      'string',
                  ]
              },
              'ConflictResolution': {
                  'ConflictResolvingModel': 'RECENCY'|'SOURCE',
                  'SourceName': 'string'
              },
              'ExportingConfig': {
                  'S3Exporting': {
                      'S3BucketName': 'string',
                      'S3KeyName': 'string'
                  }
              }
          },
          Tags={
              'string': 'string'
          }
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **DefaultExpirationDays** (*integer*) --

        **[REQUIRED]**

        The default number of days until the data within the domain
        expires.

      * **DefaultEncryptionKey** (*string*) -- The default encryption
        key, which is an AWS managed key, is used when no specific
        type of encryption key is specified. It is used to encrypt all
        data before it is placed in permanent or semi-permanent
        storage.

      * **DeadLetterQueueUrl** (*string*) -- The URL of the SQS dead
        letter queue, which is used for reporting errors associated
        with ingesting data from third party applications. You must
        set up a policy on the DeadLetterQueue for the SendMessage
        operation to enable Amazon Connect Customer Profiles to send
        messages to the DeadLetterQueue.

      * **Matching** (*dict*) --

        The process of matching duplicate profiles. If "Matching" =
        "true", Amazon Connect Customer Profiles starts a weekly batch
        process called Identity Resolution Job. If you do not specify
        a date and time for Identity Resolution Job to run, by default
        it runs every Saturday at 12AM UTC to detect duplicate
        profiles in your domains.

        After the Identity Resolution Job completes, use the
        GetMatches API to return and review the results. Or, if you
        have configured "ExportingConfig" in the "MatchingRequest",
        you can download the results from S3.

        * **Enabled** *(boolean) --* **[REQUIRED]**

          The flag that enables the matching process of duplicate
          profiles.

        * **JobSchedule** *(dict) --*

          The day and time when do you want to start the Identity
          Resolution Job every week.

          * **DayOfTheWeek** *(string) --* **[REQUIRED]**

            The day when the Identity Resolution Job should run every
            week.

          * **Time** *(string) --* **[REQUIRED]**

            The time when the Identity Resolution Job should run every
            week.

        * **AutoMerging** *(dict) --*

          Configuration information about the auto-merging process.

          * **Enabled** *(boolean) --* **[REQUIRED]**

            The flag that enables the auto-merging of duplicate
            profiles.

          * **Consolidation** *(dict) --*

            A list of matching attributes that represent matching
            criteria. If two profiles meet at least one of the
            requirements in the matching attributes list, they will be
            merged.

            * **MatchingAttributesList** *(list) --* **[REQUIRED]**

              A list of matching criteria.

              * *(list) --*

                * *(string) --*

          * **ConflictResolution** *(dict) --*

            How the auto-merging process should resolve conflicts
            between different profiles. For example, if Profile A and
            Profile B have the same "FirstName" and "LastName" (and
            that is the matching criteria), which "EmailAddress"
            should be used?

            * **ConflictResolvingModel** *(string) --* **[REQUIRED]**

              How the auto-merging process should resolve conflicts
              between different profiles.

              * "RECENCY": Uses the data that was most recently
                updated.

              * "SOURCE": Uses the data from a specific source. For
                example, if a company has been aquired or two
                departments have merged, data from the specified
                source is used. If two duplicate profiles are from the
                same source, then "RECENCY" is used again.

            * **SourceName** *(string) --*

              The "ObjectType" name that is used to resolve profile
              merging conflicts when choosing "SOURCE" as the
              "ConflictResolvingModel".

          * **MinAllowedConfidenceScoreForMerging** *(float) --*

            A number between 0 and 1 that represents the minimum
            confidence score required for profiles within a matching
            group to be merged during the auto-merge process. A higher
            score means higher similarity required to merge profiles.

        * **ExportingConfig** *(dict) --*

          Configuration information for exporting Identity Resolution
          results, for example, to an S3 bucket.

          * **S3Exporting** *(dict) --*

            The S3 location where Identity Resolution Jobs write
            result files.

            * **S3BucketName** *(string) --* **[REQUIRED]**

              The name of the S3 bucket where Identity Resolution Jobs
              write result files.

            * **S3KeyName** *(string) --*

              The S3 key name of the location where Identity
              Resolution Jobs write result files.

      * **RuleBasedMatching** (*dict*) --

        The process of matching duplicate profiles using the Rule-
        Based matching. If "RuleBasedMatching" = true, Amazon Connect
        Customer Profiles will start to match and merge your profiles
        according to your configuration in the
        "RuleBasedMatchingRequest". You can use the
        "ListRuleBasedMatches" and "GetSimilarProfiles" API to return
        and review the results. Also, if you have configured
        "ExportingConfig" in the "RuleBasedMatchingRequest", you can
        download the results from S3.

        * **Enabled** *(boolean) --* **[REQUIRED]**

          The flag that enables the rule-based matching process of
          duplicate profiles.

        * **MatchingRules** *(list) --*

          Configures how the rule-based matching process should match
          profiles. You can have up to 15 "MatchingRule" in the
          "MatchingRules".

          * *(dict) --*

            Specifies how does the rule-based matching process should
            match profiles. You can choose from the following
            attributes to build the matching Rule:

            * AccountNumber

            * Address.Address

            * Address.City

            * Address.Country

            * Address.County

            * Address.PostalCode

            * Address.State

            * Address.Province

            * BirthDate

            * BusinessName

            * EmailAddress

            * FirstName

            * Gender

            * LastName

            * MiddleName

            * PhoneNumber

            * Any customized profile attributes that start with the
              "Attributes"

            * **Rule** *(list) --* **[REQUIRED]**

              A single rule level of the "MatchRules". Configures how
              the rule-based matching process should match profiles.

              * *(string) --*

        * **MaxAllowedRuleLevelForMerging** *(integer) --*

          MatchingRule

        * **MaxAllowedRuleLevelForMatching** *(integer) --*

          Indicates the maximum allowed rule level.

        * **AttributeTypesSelector** *(dict) --*

          Configures information about the "AttributeTypesSelector"
          where the rule-based identity resolution uses to match
          profiles.

          * **AttributeMatchingModel** *(string) --* **[REQUIRED]**

            Configures the "AttributeMatchingModel", you can either
            choose "ONE_TO_ONE" or "MANY_TO_MANY".

          * **Address** *(list) --*

            The "Address" type. You can choose from "Address",
            "BusinessAddress", "MaillingAddress", and
            "ShippingAddress".

            You only can use the Address type in the "MatchingRule".
            For example, if you want to match profile based on
            "BusinessAddress.City" or "MaillingAddress.City", you need
            to choose the "BusinessAddress" and the "MaillingAddress"
            to represent the Address type and specify the
            "Address.City" on the matching rule.

            * *(string) --*

          * **PhoneNumber** *(list) --*

            The "PhoneNumber" type. You can choose from "PhoneNumber",
            "HomePhoneNumber", and "MobilePhoneNumber".

            You only can use the "PhoneNumber" type in the
            "MatchingRule". For example, if you want to match a
            profile based on "Phone" or "HomePhone", you need to
            choose the "Phone" and the "HomePhone" to represent the
            "PhoneNumber" type and only specify the "PhoneNumber" on
            the matching rule.

            * *(string) --*

          * **EmailAddress** *(list) --*

            The "Email" type. You can choose from "EmailAddress",
            "BusinessEmailAddress" and "PersonalEmailAddress".

            You only can use the "EmailAddress" type in the
            "MatchingRule". For example, if you want to match profile
            based on "PersonalEmailAddress" or "BusinessEmailAddress",
            you need to choose the "PersonalEmailAddress" and the
            "BusinessEmailAddress" to represent the "EmailAddress"
            type and only specify the "EmailAddress" on the matching
            rule.

            * *(string) --*

        * **ConflictResolution** *(dict) --*

          How the auto-merging process should resolve conflicts
          between different profiles.

          * **ConflictResolvingModel** *(string) --* **[REQUIRED]**

            How the auto-merging process should resolve conflicts
            between different profiles.

            * "RECENCY": Uses the data that was most recently updated.

            * "SOURCE": Uses the data from a specific source. For
              example, if a company has been aquired or two
              departments have merged, data from the specified source
              is used. If two duplicate profiles are from the same
              source, then "RECENCY" is used again.

          * **SourceName** *(string) --*

            The "ObjectType" name that is used to resolve profile
            merging conflicts when choosing "SOURCE" as the
            "ConflictResolvingModel".

        * **ExportingConfig** *(dict) --*

          Configuration information about the S3 bucket where Identity
          Resolution Jobs writes result files.

          Note:

            You need to give Customer Profiles service principal write
            permission to your S3 bucket. Otherwise, you'll get an
            exception in the API response. For an example policy, see
            Amazon Connect Customer Profiles cross-service confused
            deputy prevention.

          * **S3Exporting** *(dict) --*

            The S3 location where Identity Resolution Jobs write
            result files.

            * **S3BucketName** *(string) --* **[REQUIRED]**

              The name of the S3 bucket where Identity Resolution Jobs
              write result files.

            * **S3KeyName** *(string) --*

              The S3 key name of the location where Identity
              Resolution Jobs write result files.

      * **Tags** (*dict*) --

        The tags used to organize, track, or control access for this
        resource.

        * *(string) --*

          * *(string) --*

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'DomainName': 'string',
             'DefaultExpirationDays': 123,
             'DefaultEncryptionKey': 'string',
             'DeadLetterQueueUrl': 'string',
             'Matching': {
                 'Enabled': True|False,
                 'JobSchedule': {
                     'DayOfTheWeek': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
                     'Time': 'string'
                 },
                 'AutoMerging': {
                     'Enabled': True|False,
                     'Consolidation': {
                         'MatchingAttributesList': [
                             [
                                 'string',
                             ],
                         ]
                     },
                     'ConflictResolution': {
                         'ConflictResolvingModel': 'RECENCY'|'SOURCE',
                         'SourceName': 'string'
                     },
                     'MinAllowedConfidenceScoreForMerging': 123.0
                 },
                 'ExportingConfig': {
                     'S3Exporting': {
                         'S3BucketName': 'string',
                         'S3KeyName': 'string'
                     }
                 }
             },
             'RuleBasedMatching': {
                 'Enabled': True|False,
                 'MatchingRules': [
                     {
                         'Rule': [
                             'string',
                         ]
                     },
                 ],
                 'Status': 'PENDING'|'IN_PROGRESS'|'ACTIVE',
                 'MaxAllowedRuleLevelForMerging': 123,
                 'MaxAllowedRuleLevelForMatching': 123,
                 'AttributeTypesSelector': {
                     'AttributeMatchingModel': 'ONE_TO_ONE'|'MANY_TO_MANY',
                     'Address': [
                         'string',
                     ],
                     'PhoneNumber': [
                         'string',
                     ],
                     'EmailAddress': [
                         'string',
                     ]
                 },
                 'ConflictResolution': {
                     'ConflictResolvingModel': 'RECENCY'|'SOURCE',
                     'SourceName': 'string'
                 },
                 'ExportingConfig': {
                     'S3Exporting': {
                         'S3BucketName': 'string',
                         'S3KeyName': 'string'
                     }
                 }
             },
             'CreatedAt': datetime(2015, 1, 1),
             'LastUpdatedAt': datetime(2015, 1, 1),
             'Tags': {
                 'string': 'string'
             }
         }

      **Response Structure**

      * *(dict) --*

        * **DomainName** *(string) --*

          The unique name of the domain.

        * **DefaultExpirationDays** *(integer) --*

          The default number of days until the data within the domain
          expires.

        * **DefaultEncryptionKey** *(string) --*

          The default encryption key, which is an AWS managed key, is
          used when no specific type of encryption key is specified.
          It is used to encrypt all data before it is placed in
          permanent or semi-permanent storage.

        * **DeadLetterQueueUrl** *(string) --*

          The URL of the SQS dead letter queue, which is used for
          reporting errors associated with ingesting data from third
          party applications.

        * **Matching** *(dict) --*

          The process of matching duplicate profiles. If "Matching" =
          "true", Amazon Connect Customer Profiles starts a weekly
          batch process called Identity Resolution Job. If you do not
          specify a date and time for Identity Resolution Job to run,
          by default it runs every Saturday at 12AM UTC to detect
          duplicate profiles in your domains.

          After the Identity Resolution Job completes, use the
          GetMatches API to return and review the results. Or, if you
          have configured "ExportingConfig" in the "MatchingRequest",
          you can download the results from S3.

          * **Enabled** *(boolean) --*

            The flag that enables the matching process of duplicate
            profiles.

          * **JobSchedule** *(dict) --*

            The day and time when do you want to start the Identity
            Resolution Job every week.

            * **DayOfTheWeek** *(string) --*

              The day when the Identity Resolution Job should run
              every week.

            * **Time** *(string) --*

              The time when the Identity Resolution Job should run
              every week.

          * **AutoMerging** *(dict) --*

            Configuration information about the auto-merging process.

            * **Enabled** *(boolean) --*

              The flag that enables the auto-merging of duplicate
              profiles.

            * **Consolidation** *(dict) --*

              A list of matching attributes that represent matching
              criteria. If two profiles meet at least one of the
              requirements in the matching attributes list, they will
              be merged.

              * **MatchingAttributesList** *(list) --*

                A list of matching criteria.

                * *(list) --*

                  * *(string) --*

            * **ConflictResolution** *(dict) --*

              How the auto-merging process should resolve conflicts
              between different profiles. For example, if Profile A
              and Profile B have the same "FirstName" and "LastName"
              (and that is the matching criteria), which
              "EmailAddress" should be used?

              * **ConflictResolvingModel** *(string) --*

                How the auto-merging process should resolve conflicts
                between different profiles.

                * "RECENCY": Uses the data that was most recently
                  updated.

                * "SOURCE": Uses the data from a specific source. For
                  example, if a company has been aquired or two
                  departments have merged, data from the specified
                  source is used. If two duplicate profiles are from
                  the same source, then "RECENCY" is used again.

              * **SourceName** *(string) --*

                The "ObjectType" name that is used to resolve profile
                merging conflicts when choosing "SOURCE" as the
                "ConflictResolvingModel".

            * **MinAllowedConfidenceScoreForMerging** *(float) --*

              A number between 0 and 1 that represents the minimum
              confidence score required for profiles within a matching
              group to be merged during the auto-merge process. A
              higher score means higher similarity required to merge
              profiles.

          * **ExportingConfig** *(dict) --*

            Configuration information for exporting Identity
            Resolution results, for example, to an S3 bucket.

            * **S3Exporting** *(dict) --*

              The S3 location where Identity Resolution Jobs write
              result files.

              * **S3BucketName** *(string) --*

                The name of the S3 bucket where Identity Resolution
                Jobs write result files.

              * **S3KeyName** *(string) --*

                The S3 key name of the location where Identity
                Resolution Jobs write result files.

        * **RuleBasedMatching** *(dict) --*

          The process of matching duplicate profiles using the Rule-
          Based matching. If "RuleBasedMatching" = true, Amazon
          Connect Customer Profiles will start to match and merge your
          profiles according to your configuration in the
          "RuleBasedMatchingRequest". You can use the
          "ListRuleBasedMatches" and "GetSimilarProfiles" API to
          return and review the results. Also, if you have configured
          "ExportingConfig" in the "RuleBasedMatchingRequest", you can
          download the results from S3.

          * **Enabled** *(boolean) --*

            The flag that enables the rule-based matching process of
            duplicate profiles.

          * **MatchingRules** *(list) --*

            Configures how the rule-based matching process should
            match profiles. You can have up to 15 "MatchingRule" in
            the "MatchingRules".

            * *(dict) --*

              Specifies how does the rule-based matching process
              should match profiles. You can choose from the following
              attributes to build the matching Rule:

              * AccountNumber

              * Address.Address

              * Address.City

              * Address.Country

              * Address.County

              * Address.PostalCode

              * Address.State

              * Address.Province

              * BirthDate

              * BusinessName

              * EmailAddress

              * FirstName

              * Gender

              * LastName

              * MiddleName

              * PhoneNumber

              * Any customized profile attributes that start with the
                "Attributes"

              * **Rule** *(list) --*

                A single rule level of the "MatchRules". Configures
                how the rule-based matching process should match
                profiles.

                * *(string) --*

          * **Status** *(string) --*

            PENDING

            * The first status after configuration a rule-based
              matching rule. If it is an existing domain, the rule-
              based Identity Resolution waits one hour before creating
              the matching rule. If it is a new domain, the system
              will skip the "PENDING" stage.

            IN_PROGRESS

            * The system is creating the rule-based matching rule.
              Under this status, the system is evaluating the existing
              data and you can no longer change the Rule-based
              matching configuration.

            ACTIVE

            * The rule is ready to use. You can change the rule a day
              after the status is in "ACTIVE".

          * **MaxAllowedRuleLevelForMerging** *(integer) --*

            MatchingRule

          * **MaxAllowedRuleLevelForMatching** *(integer) --*

            Indicates the maximum allowed rule level.

          * **AttributeTypesSelector** *(dict) --*

            Configures information about the "AttributeTypesSelector"
            where the rule-based identity resolution uses to match
            profiles.

            * **AttributeMatchingModel** *(string) --*

              Configures the "AttributeMatchingModel", you can either
              choose "ONE_TO_ONE" or "MANY_TO_MANY".

            * **Address** *(list) --*

              The "Address" type. You can choose from "Address",
              "BusinessAddress", "MaillingAddress", and
              "ShippingAddress".

              You only can use the Address type in the "MatchingRule".
              For example, if you want to match profile based on
              "BusinessAddress.City" or "MaillingAddress.City", you
              need to choose the "BusinessAddress" and the
              "MaillingAddress" to represent the Address type and
              specify the "Address.City" on the matching rule.

              * *(string) --*

            * **PhoneNumber** *(list) --*

              The "PhoneNumber" type. You can choose from
              "PhoneNumber", "HomePhoneNumber", and
              "MobilePhoneNumber".

              You only can use the "PhoneNumber" type in the
              "MatchingRule". For example, if you want to match a
              profile based on "Phone" or "HomePhone", you need to
              choose the "Phone" and the "HomePhone" to represent the
              "PhoneNumber" type and only specify the "PhoneNumber" on
              the matching rule.

              * *(string) --*

            * **EmailAddress** *(list) --*

              The "Email" type. You can choose from "EmailAddress",
              "BusinessEmailAddress" and "PersonalEmailAddress".

              You only can use the "EmailAddress" type in the
              "MatchingRule". For example, if you want to match
              profile based on "PersonalEmailAddress" or
              "BusinessEmailAddress", you need to choose the
              "PersonalEmailAddress" and the "BusinessEmailAddress" to
              represent the "EmailAddress" type and only specify the
              "EmailAddress" on the matching rule.

              * *(string) --*

          * **ConflictResolution** *(dict) --*

            How the auto-merging process should resolve conflicts
            between different profiles.

            * **ConflictResolvingModel** *(string) --*

              How the auto-merging process should resolve conflicts
              between different profiles.

              * "RECENCY": Uses the data that was most recently
                updated.

              * "SOURCE": Uses the data from a specific source. For
                example, if a company has been aquired or two
                departments have merged, data from the specified
                source is used. If two duplicate profiles are from the
                same source, then "RECENCY" is used again.

            * **SourceName** *(string) --*

              The "ObjectType" name that is used to resolve profile
              merging conflicts when choosing "SOURCE" as the
              "ConflictResolvingModel".

          * **ExportingConfig** *(dict) --*

            Configuration information about the S3 bucket where
            Identity Resolution Jobs writes result files.

            Note:

              You need to give Customer Profiles service principal
              write permission to your S3 bucket. Otherwise, you'll
              get an exception in the API response. For an example
              policy, see Amazon Connect Customer Profiles cross-
              service confused deputy prevention.

            * **S3Exporting** *(dict) --*

              The S3 location where Identity Resolution Jobs write
              result files.

              * **S3BucketName** *(string) --*

                The name of the S3 bucket where Identity Resolution
                Jobs write result files.

              * **S3KeyName** *(string) --*

                The S3 key name of the location where Identity
                Resolution Jobs write result files.

        * **CreatedAt** *(datetime) --*

          The timestamp of when the domain was created.

        * **LastUpdatedAt** *(datetime) --*

          The timestamp of when the domain was most recently edited.

        * **Tags** *(dict) --*

          The tags used to organize, track, or control access for this
          resource.

          * *(string) --*

            * *(string) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / get_profile_object_type_template


get_profile_object_type_template
********************************

CustomerProfiles.Client.get_profile_object_type_template(**kwargs)

   Returns the template information for a specific object type.

   A template is a predefined ProfileObjectType, such as “Salesforce-
   Account” or “Salesforce-Contact.” When a user sends a
   ProfileObject, using the PutProfileObject API, with an
   ObjectTypeName that matches one of the TemplateIds, it uses the
   mappings from the template.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.get_profile_object_type_template(
          TemplateId='string'
      )

   Parameters:
      **TemplateId** (*string*) --

      **[REQUIRED]**

      A unique identifier for the object template.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'TemplateId': 'string',
             'SourceName': 'string',
             'SourceObject': 'string',
             'AllowProfileCreation': True|False,
             'SourceLastUpdatedTimestampFormat': 'string',
             'Fields': {
                 'string': {
                     'Source': 'string',
                     'Target': 'string',
                     'ContentType': 'STRING'|'NUMBER'|'PHONE_NUMBER'|'EMAIL_ADDRESS'|'NAME'
                 }
             },
             'Keys': {
                 'string': [
                     {
                         'StandardIdentifiers': [
                             'PROFILE'|'ASSET'|'CASE'|'ORDER'|'COMMUNICATION_RECORD'|'AIR_PREFERENCE'|'HOTEL_PREFERENCE'|'AIR_BOOKING'|'AIR_SEGMENT'|'HOTEL_RESERVATION'|'HOTEL_STAY_REVENUE'|'LOYALTY'|'LOYALTY_TRANSACTION'|'LOYALTY_PROMOTION'|'UNIQUE'|'SECONDARY'|'LOOKUP_ONLY'|'NEW_ONLY',
                         ],
                         'FieldNames': [
                             'string',
                         ]
                     },
                 ]
             }
         }

      **Response Structure**

      * *(dict) --*

        * **TemplateId** *(string) --*

          A unique identifier for the object template.

        * **SourceName** *(string) --*

          The name of the source of the object template.

        * **SourceObject** *(string) --*

          The source of the object template.

        * **AllowProfileCreation** *(boolean) --*

          Indicates whether a profile should be created when data is
          received if one doesn’t exist for an object of this type.
          The default is "FALSE". If the AllowProfileCreation flag is
          set to "FALSE", then the service tries to fetch a standard
          profile and associate this object with the profile. If it is
          set to "TRUE", and if no match is found, then the service
          creates a new standard profile.

        * **SourceLastUpdatedTimestampFormat** *(string) --*

          The format of your "sourceLastUpdatedTimestamp" that was
          previously set up.

        * **Fields** *(dict) --*

          A map of the name and ObjectType field.

          * *(string) --*

            * *(dict) --*

              Represents a field in a ProfileObjectType.

              * **Source** *(string) --*

                A field of a ProfileObject. For example:
                _source.FirstName, where “_source” is a
                ProfileObjectType of a Zendesk user and “FirstName” is
                a field in that ObjectType.

              * **Target** *(string) --*

                The location of the data in the standard ProfileObject
                model. For example: _profile.Address.PostalCode.

              * **ContentType** *(string) --*

                The content type of the field. Used for determining
                equality when searching.

        * **Keys** *(dict) --*

          A list of unique keys that can be used to map data to the
          profile.

          * *(string) --*

            * *(list) --*

              * *(dict) --*

                An object that defines the Key element of a
                ProfileObject. A Key is a special element that can be
                used to search for a customer profile.

                * **StandardIdentifiers** *(list) --*

                  The types of keys that a ProfileObject can have.
                  Each ProfileObject can have only 1 UNIQUE key but
                  multiple PROFILE keys. PROFILE, ASSET, CASE, or
                  ORDER means that this key can be used to tie an
                  object to a PROFILE, ASSET, CASE, or ORDER
                  respectively. UNIQUE means that it can be used to
                  uniquely identify an object. If a key a is marked as
                  SECONDARY, it will be used to search for profiles
                  after all other PROFILE keys have been searched. A
                  LOOKUP_ONLY key is only used to match a profile but
                  is not persisted to be used for searching of the
                  profile. A NEW_ONLY key is only used if the profile
                  does not already exist before the object is
                  ingested, otherwise it is only used for matching
                  objects to profiles.

                  * *(string) --*

                * **FieldNames** *(list) --*

                  The reference for the key name of the fields map.

                  * *(string) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / untag_resource


untag_resource
**************

CustomerProfiles.Client.untag_resource(**kwargs)

   Removes one or more tags from the specified Amazon Connect Customer
   Profiles resource. In Connect Customer Profiles, domains, profile
   object types, and integrations can be tagged.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.untag_resource(
          resourceArn='string',
          tagKeys=[
              'string',
          ]
      )

   Parameters:
      * **resourceArn** (*string*) --

        **[REQUIRED]**

        The ARN of the resource from which you are removing tags.

      * **tagKeys** (*list*) --

        **[REQUIRED]**

        The list of tag keys to remove from the resource.

        * *(string) --*

   Return type:
      dict

   Returns:
      **Response Syntax**

         {}

      **Response Structure**

      * *(dict) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.InternalServerException"

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"
CustomerProfiles / Client / delete_domain


delete_domain
*************

CustomerProfiles.Client.delete_domain(**kwargs)

   Deletes a specific domain and all of its customer data, such as
   customer profile attributes and their related objects.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.delete_domain(
          DomainName='string'
      )

   Parameters:
      **DomainName** (*string*) --

      **[REQUIRED]**

      The unique name of the domain.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'Message': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **Message** *(string) --*

          A message that indicates the delete request is done.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / delete_profile_object


delete_profile_object
*********************

CustomerProfiles.Client.delete_profile_object(**kwargs)

   Removes an object associated with a profile of a given
   ProfileObjectType.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.delete_profile_object(
          ProfileId='string',
          ProfileObjectUniqueKey='string',
          ObjectTypeName='string',
          DomainName='string'
      )

   Parameters:
      * **ProfileId** (*string*) --

        **[REQUIRED]**

        The unique identifier of a customer profile.

      * **ProfileObjectUniqueKey** (*string*) --

        **[REQUIRED]**

        The unique identifier of the profile object generated by the
        service.

      * **ObjectTypeName** (*string*) --

        **[REQUIRED]**

        The name of the profile object type.

      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'Message': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **Message** *(string) --*

          A message that indicates the delete request is done.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / update_domain


update_domain
*************

CustomerProfiles.Client.update_domain(**kwargs)

   Updates the properties of a domain, including creating or selecting
   a dead letter queue or an encryption key.

   After a domain is created, the name can’t be changed.

   Use this API or CreateDomain to enable identity resolution: set
   "Matching" to true.

   To prevent cross-service impersonation when you call this API, see
   Cross-service confused deputy prevention for sample policies that
   you should apply.

   To add or remove tags on an existing Domain, see TagResource/
   UntagResource.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.update_domain(
          DomainName='string',
          DefaultExpirationDays=123,
          DefaultEncryptionKey='string',
          DeadLetterQueueUrl='string',
          Matching={
              'Enabled': True|False,
              'JobSchedule': {
                  'DayOfTheWeek': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
                  'Time': 'string'
              },
              'AutoMerging': {
                  'Enabled': True|False,
                  'Consolidation': {
                      'MatchingAttributesList': [
                          [
                              'string',
                          ],
                      ]
                  },
                  'ConflictResolution': {
                      'ConflictResolvingModel': 'RECENCY'|'SOURCE',
                      'SourceName': 'string'
                  },
                  'MinAllowedConfidenceScoreForMerging': 123.0
              },
              'ExportingConfig': {
                  'S3Exporting': {
                      'S3BucketName': 'string',
                      'S3KeyName': 'string'
                  }
              }
          },
          RuleBasedMatching={
              'Enabled': True|False,
              'MatchingRules': [
                  {
                      'Rule': [
                          'string',
                      ]
                  },
              ],
              'MaxAllowedRuleLevelForMerging': 123,
              'MaxAllowedRuleLevelForMatching': 123,
              'AttributeTypesSelector': {
                  'AttributeMatchingModel': 'ONE_TO_ONE'|'MANY_TO_MANY',
                  'Address': [
                      'string',
                  ],
                  'PhoneNumber': [
                      'string',
                  ],
                  'EmailAddress': [
                      'string',
                  ]
              },
              'ConflictResolution': {
                  'ConflictResolvingModel': 'RECENCY'|'SOURCE',
                  'SourceName': 'string'
              },
              'ExportingConfig': {
                  'S3Exporting': {
                      'S3BucketName': 'string',
                      'S3KeyName': 'string'
                  }
              }
          },
          Tags={
              'string': 'string'
          }
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **DefaultExpirationDays** (*integer*) -- The default number of
        days until the data within the domain expires.

      * **DefaultEncryptionKey** (*string*) -- The default encryption
        key, which is an AWS managed key, is used when no specific
        type of encryption key is specified. It is used to encrypt all
        data before it is placed in permanent or semi-permanent
        storage. If specified as an empty string, it will clear any
        existing value.

      * **DeadLetterQueueUrl** (*string*) -- The URL of the SQS dead
        letter queue, which is used for reporting errors associated
        with ingesting data from third party applications. If
        specified as an empty string, it will clear any existing
        value. You must set up a policy on the DeadLetterQueue for the
        SendMessage operation to enable Amazon Connect Customer
        Profiles to send messages to the DeadLetterQueue.

      * **Matching** (*dict*) --

        The process of matching duplicate profiles. If "Matching" =
        "true", Amazon Connect Customer Profiles starts a weekly batch
        process called Identity Resolution Job. If you do not specify
        a date and time for Identity Resolution Job to run, by default
        it runs every Saturday at 12AM UTC to detect duplicate
        profiles in your domains.

        After the Identity Resolution Job completes, use the
        GetMatches API to return and review the results. Or, if you
        have configured "ExportingConfig" in the "MatchingRequest",
        you can download the results from S3.

        * **Enabled** *(boolean) --* **[REQUIRED]**

          The flag that enables the matching process of duplicate
          profiles.

        * **JobSchedule** *(dict) --*

          The day and time when do you want to start the Identity
          Resolution Job every week.

          * **DayOfTheWeek** *(string) --* **[REQUIRED]**

            The day when the Identity Resolution Job should run every
            week.

          * **Time** *(string) --* **[REQUIRED]**

            The time when the Identity Resolution Job should run every
            week.

        * **AutoMerging** *(dict) --*

          Configuration information about the auto-merging process.

          * **Enabled** *(boolean) --* **[REQUIRED]**

            The flag that enables the auto-merging of duplicate
            profiles.

          * **Consolidation** *(dict) --*

            A list of matching attributes that represent matching
            criteria. If two profiles meet at least one of the
            requirements in the matching attributes list, they will be
            merged.

            * **MatchingAttributesList** *(list) --* **[REQUIRED]**

              A list of matching criteria.

              * *(list) --*

                * *(string) --*

          * **ConflictResolution** *(dict) --*

            How the auto-merging process should resolve conflicts
            between different profiles. For example, if Profile A and
            Profile B have the same "FirstName" and "LastName" (and
            that is the matching criteria), which "EmailAddress"
            should be used?

            * **ConflictResolvingModel** *(string) --* **[REQUIRED]**

              How the auto-merging process should resolve conflicts
              between different profiles.

              * "RECENCY": Uses the data that was most recently
                updated.

              * "SOURCE": Uses the data from a specific source. For
                example, if a company has been aquired or two
                departments have merged, data from the specified
                source is used. If two duplicate profiles are from the
                same source, then "RECENCY" is used again.

            * **SourceName** *(string) --*

              The "ObjectType" name that is used to resolve profile
              merging conflicts when choosing "SOURCE" as the
              "ConflictResolvingModel".

          * **MinAllowedConfidenceScoreForMerging** *(float) --*

            A number between 0 and 1 that represents the minimum
            confidence score required for profiles within a matching
            group to be merged during the auto-merge process. A higher
            score means higher similarity required to merge profiles.

        * **ExportingConfig** *(dict) --*

          Configuration information for exporting Identity Resolution
          results, for example, to an S3 bucket.

          * **S3Exporting** *(dict) --*

            The S3 location where Identity Resolution Jobs write
            result files.

            * **S3BucketName** *(string) --* **[REQUIRED]**

              The name of the S3 bucket where Identity Resolution Jobs
              write result files.

            * **S3KeyName** *(string) --*

              The S3 key name of the location where Identity
              Resolution Jobs write result files.

      * **RuleBasedMatching** (*dict*) --

        The process of matching duplicate profiles using the rule-
        Based matching. If "RuleBasedMatching" = true, Amazon Connect
        Customer Profiles will start to match and merge your profiles
        according to your configuration in the
        "RuleBasedMatchingRequest". You can use the
        "ListRuleBasedMatches" and "GetSimilarProfiles" API to return
        and review the results. Also, if you have configured
        "ExportingConfig" in the "RuleBasedMatchingRequest", you can
        download the results from S3.

        * **Enabled** *(boolean) --* **[REQUIRED]**

          The flag that enables the rule-based matching process of
          duplicate profiles.

        * **MatchingRules** *(list) --*

          Configures how the rule-based matching process should match
          profiles. You can have up to 15 "MatchingRule" in the
          "MatchingRules".

          * *(dict) --*

            Specifies how does the rule-based matching process should
            match profiles. You can choose from the following
            attributes to build the matching Rule:

            * AccountNumber

            * Address.Address

            * Address.City

            * Address.Country

            * Address.County

            * Address.PostalCode

            * Address.State

            * Address.Province

            * BirthDate

            * BusinessName

            * EmailAddress

            * FirstName

            * Gender

            * LastName

            * MiddleName

            * PhoneNumber

            * Any customized profile attributes that start with the
              "Attributes"

            * **Rule** *(list) --* **[REQUIRED]**

              A single rule level of the "MatchRules". Configures how
              the rule-based matching process should match profiles.

              * *(string) --*

        * **MaxAllowedRuleLevelForMerging** *(integer) --*

          MatchingRule

        * **MaxAllowedRuleLevelForMatching** *(integer) --*

          Indicates the maximum allowed rule level.

        * **AttributeTypesSelector** *(dict) --*

          Configures information about the "AttributeTypesSelector"
          where the rule-based identity resolution uses to match
          profiles.

          * **AttributeMatchingModel** *(string) --* **[REQUIRED]**

            Configures the "AttributeMatchingModel", you can either
            choose "ONE_TO_ONE" or "MANY_TO_MANY".

          * **Address** *(list) --*

            The "Address" type. You can choose from "Address",
            "BusinessAddress", "MaillingAddress", and
            "ShippingAddress".

            You only can use the Address type in the "MatchingRule".
            For example, if you want to match profile based on
            "BusinessAddress.City" or "MaillingAddress.City", you need
            to choose the "BusinessAddress" and the "MaillingAddress"
            to represent the Address type and specify the
            "Address.City" on the matching rule.

            * *(string) --*

          * **PhoneNumber** *(list) --*

            The "PhoneNumber" type. You can choose from "PhoneNumber",
            "HomePhoneNumber", and "MobilePhoneNumber".

            You only can use the "PhoneNumber" type in the
            "MatchingRule". For example, if you want to match a
            profile based on "Phone" or "HomePhone", you need to
            choose the "Phone" and the "HomePhone" to represent the
            "PhoneNumber" type and only specify the "PhoneNumber" on
            the matching rule.

            * *(string) --*

          * **EmailAddress** *(list) --*

            The "Email" type. You can choose from "EmailAddress",
            "BusinessEmailAddress" and "PersonalEmailAddress".

            You only can use the "EmailAddress" type in the
            "MatchingRule". For example, if you want to match profile
            based on "PersonalEmailAddress" or "BusinessEmailAddress",
            you need to choose the "PersonalEmailAddress" and the
            "BusinessEmailAddress" to represent the "EmailAddress"
            type and only specify the "EmailAddress" on the matching
            rule.

            * *(string) --*

        * **ConflictResolution** *(dict) --*

          How the auto-merging process should resolve conflicts
          between different profiles.

          * **ConflictResolvingModel** *(string) --* **[REQUIRED]**

            How the auto-merging process should resolve conflicts
            between different profiles.

            * "RECENCY": Uses the data that was most recently updated.

            * "SOURCE": Uses the data from a specific source. For
              example, if a company has been aquired or two
              departments have merged, data from the specified source
              is used. If two duplicate profiles are from the same
              source, then "RECENCY" is used again.

          * **SourceName** *(string) --*

            The "ObjectType" name that is used to resolve profile
            merging conflicts when choosing "SOURCE" as the
            "ConflictResolvingModel".

        * **ExportingConfig** *(dict) --*

          Configuration information about the S3 bucket where Identity
          Resolution Jobs writes result files.

          Note:

            You need to give Customer Profiles service principal write
            permission to your S3 bucket. Otherwise, you'll get an
            exception in the API response. For an example policy, see
            Amazon Connect Customer Profiles cross-service confused
            deputy prevention.

          * **S3Exporting** *(dict) --*

            The S3 location where Identity Resolution Jobs write
            result files.

            * **S3BucketName** *(string) --* **[REQUIRED]**

              The name of the S3 bucket where Identity Resolution Jobs
              write result files.

            * **S3KeyName** *(string) --*

              The S3 key name of the location where Identity
              Resolution Jobs write result files.

      * **Tags** (*dict*) --

        The tags used to organize, track, or control access for this
        resource.

        * *(string) --*

          * *(string) --*

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'DomainName': 'string',
             'DefaultExpirationDays': 123,
             'DefaultEncryptionKey': 'string',
             'DeadLetterQueueUrl': 'string',
             'Matching': {
                 'Enabled': True|False,
                 'JobSchedule': {
                     'DayOfTheWeek': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
                     'Time': 'string'
                 },
                 'AutoMerging': {
                     'Enabled': True|False,
                     'Consolidation': {
                         'MatchingAttributesList': [
                             [
                                 'string',
                             ],
                         ]
                     },
                     'ConflictResolution': {
                         'ConflictResolvingModel': 'RECENCY'|'SOURCE',
                         'SourceName': 'string'
                     },
                     'MinAllowedConfidenceScoreForMerging': 123.0
                 },
                 'ExportingConfig': {
                     'S3Exporting': {
                         'S3BucketName': 'string',
                         'S3KeyName': 'string'
                     }
                 }
             },
             'RuleBasedMatching': {
                 'Enabled': True|False,
                 'MatchingRules': [
                     {
                         'Rule': [
                             'string',
                         ]
                     },
                 ],
                 'Status': 'PENDING'|'IN_PROGRESS'|'ACTIVE',
                 'MaxAllowedRuleLevelForMerging': 123,
                 'MaxAllowedRuleLevelForMatching': 123,
                 'AttributeTypesSelector': {
                     'AttributeMatchingModel': 'ONE_TO_ONE'|'MANY_TO_MANY',
                     'Address': [
                         'string',
                     ],
                     'PhoneNumber': [
                         'string',
                     ],
                     'EmailAddress': [
                         'string',
                     ]
                 },
                 'ConflictResolution': {
                     'ConflictResolvingModel': 'RECENCY'|'SOURCE',
                     'SourceName': 'string'
                 },
                 'ExportingConfig': {
                     'S3Exporting': {
                         'S3BucketName': 'string',
                         'S3KeyName': 'string'
                     }
                 }
             },
             'CreatedAt': datetime(2015, 1, 1),
             'LastUpdatedAt': datetime(2015, 1, 1),
             'Tags': {
                 'string': 'string'
             }
         }

      **Response Structure**

      * *(dict) --*

        * **DomainName** *(string) --*

          The unique name of the domain.

        * **DefaultExpirationDays** *(integer) --*

          The default number of days until the data within the domain
          expires.

        * **DefaultEncryptionKey** *(string) --*

          The default encryption key, which is an AWS managed key, is
          used when no specific type of encryption key is specified.
          It is used to encrypt all data before it is placed in
          permanent or semi-permanent storage.

        * **DeadLetterQueueUrl** *(string) --*

          The URL of the SQS dead letter queue, which is used for
          reporting errors associated with ingesting data from third
          party applications.

        * **Matching** *(dict) --*

          The process of matching duplicate profiles. If "Matching" =
          "true", Amazon Connect Customer Profiles starts a weekly
          batch process called Identity Resolution Job. If you do not
          specify a date and time for Identity Resolution Job to run,
          by default it runs every Saturday at 12AM UTC to detect
          duplicate profiles in your domains.

          After the Identity Resolution Job completes, use the
          GetMatches API to return and review the results. Or, if you
          have configured "ExportingConfig" in the "MatchingRequest",
          you can download the results from S3.

          * **Enabled** *(boolean) --*

            The flag that enables the matching process of duplicate
            profiles.

          * **JobSchedule** *(dict) --*

            The day and time when do you want to start the Identity
            Resolution Job every week.

            * **DayOfTheWeek** *(string) --*

              The day when the Identity Resolution Job should run
              every week.

            * **Time** *(string) --*

              The time when the Identity Resolution Job should run
              every week.

          * **AutoMerging** *(dict) --*

            Configuration information about the auto-merging process.

            * **Enabled** *(boolean) --*

              The flag that enables the auto-merging of duplicate
              profiles.

            * **Consolidation** *(dict) --*

              A list of matching attributes that represent matching
              criteria. If two profiles meet at least one of the
              requirements in the matching attributes list, they will
              be merged.

              * **MatchingAttributesList** *(list) --*

                A list of matching criteria.

                * *(list) --*

                  * *(string) --*

            * **ConflictResolution** *(dict) --*

              How the auto-merging process should resolve conflicts
              between different profiles. For example, if Profile A
              and Profile B have the same "FirstName" and "LastName"
              (and that is the matching criteria), which
              "EmailAddress" should be used?

              * **ConflictResolvingModel** *(string) --*

                How the auto-merging process should resolve conflicts
                between different profiles.

                * "RECENCY": Uses the data that was most recently
                  updated.

                * "SOURCE": Uses the data from a specific source. For
                  example, if a company has been aquired or two
                  departments have merged, data from the specified
                  source is used. If two duplicate profiles are from
                  the same source, then "RECENCY" is used again.

              * **SourceName** *(string) --*

                The "ObjectType" name that is used to resolve profile
                merging conflicts when choosing "SOURCE" as the
                "ConflictResolvingModel".

            * **MinAllowedConfidenceScoreForMerging** *(float) --*

              A number between 0 and 1 that represents the minimum
              confidence score required for profiles within a matching
              group to be merged during the auto-merge process. A
              higher score means higher similarity required to merge
              profiles.

          * **ExportingConfig** *(dict) --*

            Configuration information for exporting Identity
            Resolution results, for example, to an S3 bucket.

            * **S3Exporting** *(dict) --*

              The S3 location where Identity Resolution Jobs write
              result files.

              * **S3BucketName** *(string) --*

                The name of the S3 bucket where Identity Resolution
                Jobs write result files.

              * **S3KeyName** *(string) --*

                The S3 key name of the location where Identity
                Resolution Jobs write result files.

        * **RuleBasedMatching** *(dict) --*

          The process of matching duplicate profiles using the rule-
          Based matching. If "RuleBasedMatching" = true, Amazon
          Connect Customer Profiles will start to match and merge your
          profiles according to your configuration in the
          "RuleBasedMatchingRequest". You can use the
          "ListRuleBasedMatches" and "GetSimilarProfiles" API to
          return and review the results. Also, if you have configured
          "ExportingConfig" in the "RuleBasedMatchingRequest", you can
          download the results from S3.

          * **Enabled** *(boolean) --*

            The flag that enables the rule-based matching process of
            duplicate profiles.

          * **MatchingRules** *(list) --*

            Configures how the rule-based matching process should
            match profiles. You can have up to 15 "MatchingRule" in
            the "MatchingRules".

            * *(dict) --*

              Specifies how does the rule-based matching process
              should match profiles. You can choose from the following
              attributes to build the matching Rule:

              * AccountNumber

              * Address.Address

              * Address.City

              * Address.Country

              * Address.County

              * Address.PostalCode

              * Address.State

              * Address.Province

              * BirthDate

              * BusinessName

              * EmailAddress

              * FirstName

              * Gender

              * LastName

              * MiddleName

              * PhoneNumber

              * Any customized profile attributes that start with the
                "Attributes"

              * **Rule** *(list) --*

                A single rule level of the "MatchRules". Configures
                how the rule-based matching process should match
                profiles.

                * *(string) --*

          * **Status** *(string) --*

            PENDING

            * The first status after configuration a rule-based
              matching rule. If it is an existing domain, the rule-
              based Identity Resolution waits one hour before creating
              the matching rule. If it is a new domain, the system
              will skip the "PENDING" stage.

            IN_PROGRESS

            * The system is creating the rule-based matching rule.
              Under this status, the system is evaluating the existing
              data and you can no longer change the Rule-based
              matching configuration.

            ACTIVE

            * The rule is ready to use. You can change the rule a day
              after the status is in "ACTIVE".

          * **MaxAllowedRuleLevelForMerging** *(integer) --*

            MatchingRule

          * **MaxAllowedRuleLevelForMatching** *(integer) --*

            Indicates the maximum allowed rule level.

          * **AttributeTypesSelector** *(dict) --*

            Configures information about the "AttributeTypesSelector"
            where the rule-based identity resolution uses to match
            profiles.

            * **AttributeMatchingModel** *(string) --*

              Configures the "AttributeMatchingModel", you can either
              choose "ONE_TO_ONE" or "MANY_TO_MANY".

            * **Address** *(list) --*

              The "Address" type. You can choose from "Address",
              "BusinessAddress", "MaillingAddress", and
              "ShippingAddress".

              You only can use the Address type in the "MatchingRule".
              For example, if you want to match profile based on
              "BusinessAddress.City" or "MaillingAddress.City", you
              need to choose the "BusinessAddress" and the
              "MaillingAddress" to represent the Address type and
              specify the "Address.City" on the matching rule.

              * *(string) --*

            * **PhoneNumber** *(list) --*

              The "PhoneNumber" type. You can choose from
              "PhoneNumber", "HomePhoneNumber", and
              "MobilePhoneNumber".

              You only can use the "PhoneNumber" type in the
              "MatchingRule". For example, if you want to match a
              profile based on "Phone" or "HomePhone", you need to
              choose the "Phone" and the "HomePhone" to represent the
              "PhoneNumber" type and only specify the "PhoneNumber" on
              the matching rule.

              * *(string) --*

            * **EmailAddress** *(list) --*

              The "Email" type. You can choose from "EmailAddress",
              "BusinessEmailAddress" and "PersonalEmailAddress".

              You only can use the "EmailAddress" type in the
              "MatchingRule". For example, if you want to match
              profile based on "PersonalEmailAddress" or
              "BusinessEmailAddress", you need to choose the
              "PersonalEmailAddress" and the "BusinessEmailAddress" to
              represent the "EmailAddress" type and only specify the
              "EmailAddress" on the matching rule.

              * *(string) --*

          * **ConflictResolution** *(dict) --*

            How the auto-merging process should resolve conflicts
            between different profiles.

            * **ConflictResolvingModel** *(string) --*

              How the auto-merging process should resolve conflicts
              between different profiles.

              * "RECENCY": Uses the data that was most recently
                updated.

              * "SOURCE": Uses the data from a specific source. For
                example, if a company has been aquired or two
                departments have merged, data from the specified
                source is used. If two duplicate profiles are from the
                same source, then "RECENCY" is used again.

            * **SourceName** *(string) --*

              The "ObjectType" name that is used to resolve profile
              merging conflicts when choosing "SOURCE" as the
              "ConflictResolvingModel".

          * **ExportingConfig** *(dict) --*

            Configuration information about the S3 bucket where
            Identity Resolution Jobs writes result files.

            Note:

              You need to give Customer Profiles service principal
              write permission to your S3 bucket. Otherwise, you'll
              get an exception in the API response. For an example
              policy, see Amazon Connect Customer Profiles cross-
              service confused deputy prevention.

            * **S3Exporting** *(dict) --*

              The S3 location where Identity Resolution Jobs write
              result files.

              * **S3BucketName** *(string) --*

                The name of the S3 bucket where Identity Resolution
                Jobs write result files.

              * **S3KeyName** *(string) --*

                The S3 key name of the location where Identity
                Resolution Jobs write result files.

        * **CreatedAt** *(datetime) --*

          The timestamp of when the domain was created.

        * **LastUpdatedAt** *(datetime) --*

          The timestamp of when the domain was most recently edited.

        * **Tags** *(dict) --*

          The tags used to organize, track, or control access for this
          resource.

          * *(string) --*

            * *(string) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / update_event_trigger


update_event_trigger
********************

CustomerProfiles.Client.update_event_trigger(**kwargs)

   Update the properties of an Event Trigger.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.update_event_trigger(
          DomainName='string',
          EventTriggerName='string',
          ObjectTypeName='string',
          Description='string',
          EventTriggerConditions=[
              {
                  'EventTriggerDimensions': [
                      {
                          'ObjectAttributes': [
                              {
                                  'Source': 'string',
                                  'FieldName': 'string',
                                  'ComparisonOperator': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL'|'LESS_THAN_OR_EQUAL'|'EQUAL'|'BEFORE'|'AFTER'|'ON'|'BETWEEN'|'NOT_BETWEEN',
                                  'Values': [
                                      'string',
                                  ]
                              },
                          ]
                      },
                  ],
                  'LogicalOperator': 'ANY'|'ALL'|'NONE'
              },
          ],
          SegmentFilter='string',
          EventTriggerLimits={
              'EventExpiration': 123,
              'Periods': [
                  {
                      'Unit': 'HOURS'|'DAYS'|'WEEKS'|'MONTHS',
                      'Value': 123,
                      'MaxInvocationsPerProfile': 123,
                      'Unlimited': True|False
                  },
              ]
          }
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **EventTriggerName** (*string*) --

        **[REQUIRED]**

        The unique name of the event trigger.

      * **ObjectTypeName** (*string*) -- The unique name of the object
        type.

      * **Description** (*string*) -- The description of the event
        trigger.

      * **EventTriggerConditions** (*list*) --

        A list of conditions that determine when an event should
        trigger the destination.

        * *(dict) --*

          Specifies the circumstances under which the event should
          trigger the destination.

          * **EventTriggerDimensions** *(list) --* **[REQUIRED]**

            A list of dimensions to be evaluated for the event.

            * *(dict) --*

              A specific event dimension to be assessed.

              * **ObjectAttributes** *(list) --* **[REQUIRED]**

                A list of object attributes to be evaluated.

                * *(dict) --*

                  The criteria that a specific object attribute must
                  meet to trigger the destination.

                  * **Source** *(string) --*

                    An attribute contained within a source object.

                  * **FieldName** *(string) --*

                    A field defined within an object type.

                  * **ComparisonOperator** *(string) --*
                    **[REQUIRED]**

                    The operator used to compare an attribute against
                    a list of values.

                  * **Values** *(list) --* **[REQUIRED]**

                    A list of attribute values used for comparison.

                    * *(string) --*

          * **LogicalOperator** *(string) --* **[REQUIRED]**

            The operator used to combine multiple dimensions.

      * **SegmentFilter** (*string*) -- The destination is triggered
        only for profiles that meet the criteria of a segment
        definition.

      * **EventTriggerLimits** (*dict*) --

        Defines limits controlling whether an event triggers the
        destination, based on ingestion latency and the number of
        invocations per profile over specific time periods.

        * **EventExpiration** *(integer) --*

          In milliseconds. Specifies that an event will only trigger
          the destination if it is processed within a certain latency
          period.

        * **Periods** *(list) --*

          A list of time periods during which the limits apply.

          * *(dict) --*

            Defines a limit and the time period during which it is
            enforced.

            * **Unit** *(string) --* **[REQUIRED]**

              The unit of time.

            * **Value** *(integer) --* **[REQUIRED]**

              The amount of time of the specified unit.

            * **MaxInvocationsPerProfile** *(integer) --*

              The maximum allowed number of destination invocations
              per profile.

            * **Unlimited** *(boolean) --*

              If set to true, there is no limit on the number of
              destination invocations per profile. The default is
              false.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'EventTriggerName': 'string',
             'ObjectTypeName': 'string',
             'Description': 'string',
             'EventTriggerConditions': [
                 {
                     'EventTriggerDimensions': [
                         {
                             'ObjectAttributes': [
                                 {
                                     'Source': 'string',
                                     'FieldName': 'string',
                                     'ComparisonOperator': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL'|'LESS_THAN_OR_EQUAL'|'EQUAL'|'BEFORE'|'AFTER'|'ON'|'BETWEEN'|'NOT_BETWEEN',
                                     'Values': [
                                         'string',
                                     ]
                                 },
                             ]
                         },
                     ],
                     'LogicalOperator': 'ANY'|'ALL'|'NONE'
                 },
             ],
             'SegmentFilter': 'string',
             'EventTriggerLimits': {
                 'EventExpiration': 123,
                 'Periods': [
                     {
                         'Unit': 'HOURS'|'DAYS'|'WEEKS'|'MONTHS',
                         'Value': 123,
                         'MaxInvocationsPerProfile': 123,
                         'Unlimited': True|False
                     },
                 ]
             },
             'CreatedAt': datetime(2015, 1, 1),
             'LastUpdatedAt': datetime(2015, 1, 1),
             'Tags': {
                 'string': 'string'
             }
         }

      **Response Structure**

      * *(dict) --*

        * **EventTriggerName** *(string) --*

          The unique name of the event trigger.

        * **ObjectTypeName** *(string) --*

          The unique name of the object type.

        * **Description** *(string) --*

          The description of the event trigger.

        * **EventTriggerConditions** *(list) --*

          A list of conditions that determine when an event should
          trigger the destination.

          * *(dict) --*

            Specifies the circumstances under which the event should
            trigger the destination.

            * **EventTriggerDimensions** *(list) --*

              A list of dimensions to be evaluated for the event.

              * *(dict) --*

                A specific event dimension to be assessed.

                * **ObjectAttributes** *(list) --*

                  A list of object attributes to be evaluated.

                  * *(dict) --*

                    The criteria that a specific object attribute must
                    meet to trigger the destination.

                    * **Source** *(string) --*

                      An attribute contained within a source object.

                    * **FieldName** *(string) --*

                      A field defined within an object type.

                    * **ComparisonOperator** *(string) --*

                      The operator used to compare an attribute
                      against a list of values.

                    * **Values** *(list) --*

                      A list of attribute values used for comparison.

                      * *(string) --*

            * **LogicalOperator** *(string) --*

              The operator used to combine multiple dimensions.

        * **SegmentFilter** *(string) --*

          The destination is triggered only for profiles that meet the
          criteria of a segment definition.

        * **EventTriggerLimits** *(dict) --*

          Defines limits controlling whether an event triggers the
          destination, based on ingestion latency and the number of
          invocations per profile over specific time periods.

          * **EventExpiration** *(integer) --*

            In milliseconds. Specifies that an event will only trigger
            the destination if it is processed within a certain
            latency period.

          * **Periods** *(list) --*

            A list of time periods during which the limits apply.

            * *(dict) --*

              Defines a limit and the time period during which it is
              enforced.

              * **Unit** *(string) --*

                The unit of time.

              * **Value** *(integer) --*

                The amount of time of the specified unit.

              * **MaxInvocationsPerProfile** *(integer) --*

                The maximum allowed number of destination invocations
                per profile.

              * **Unlimited** *(boolean) --*

                If set to true, there is no limit on the number of
                destination invocations per profile. The default is
                false.

        * **CreatedAt** *(datetime) --*

          The timestamp of when the event trigger was created.

        * **LastUpdatedAt** *(datetime) --*

          The timestamp of when the event trigger was most recently
          updated.

        * **Tags** *(dict) --*

          An array of key-value pairs to apply to this resource.

          * *(string) --*

            * *(string) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / list_account_integrations


list_account_integrations
*************************

CustomerProfiles.Client.list_account_integrations(**kwargs)

   Lists all of the integrations associated to a specific URI in the
   AWS account.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_account_integrations(
          Uri='string',
          NextToken='string',
          MaxResults=123,
          IncludeHidden=True|False
      )

   Parameters:
      * **Uri** (*string*) --

        **[REQUIRED]**

        The URI of the S3 bucket or any other type of data source.

      * **NextToken** (*string*) -- The pagination token from the
        previous ListAccountIntegrations API call.

      * **MaxResults** (*integer*) -- The maximum number of objects
        returned per page.

      * **IncludeHidden** (*boolean*) -- Boolean to indicate if hidden
        integration should be returned. Defaults to "False".

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'Items': [
                 {
                     'DomainName': 'string',
                     'Uri': 'string',
                     'ObjectTypeName': 'string',
                     'CreatedAt': datetime(2015, 1, 1),
                     'LastUpdatedAt': datetime(2015, 1, 1),
                     'Tags': {
                         'string': 'string'
                     },
                     'ObjectTypeNames': {
                         'string': 'string'
                     },
                     'WorkflowId': 'string',
                     'IsUnstructured': True|False,
                     'RoleArn': 'string',
                     'EventTriggerNames': [
                         'string',
                     ]
                 },
             ],
             'NextToken': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **Items** *(list) --*

          The list of ListAccountIntegration instances.

          * *(dict) --*

            An integration in list of integrations.

            * **DomainName** *(string) --*

              The unique name of the domain.

            * **Uri** *(string) --*

              The URI of the S3 bucket or any other type of data
              source.

            * **ObjectTypeName** *(string) --*

              The name of the profile object type.

            * **CreatedAt** *(datetime) --*

              The timestamp of when the domain was created.

            * **LastUpdatedAt** *(datetime) --*

              The timestamp of when the domain was most recently
              edited.

            * **Tags** *(dict) --*

              The tags used to organize, track, or control access for
              this resource.

              * *(string) --*

                * *(string) --*

            * **ObjectTypeNames** *(dict) --*

              A map in which each key is an event type from an
              external application such as Segment or Shopify, and
              each value is an "ObjectTypeName" (template) used to
              ingest the event. It supports the following event types:
              "SegmentIdentify", "ShopifyCreateCustomers",
              "ShopifyUpdateCustomers", "ShopifyCreateDraftOrders",
              "ShopifyUpdateDraftOrders", "ShopifyCreateOrders", and
              "ShopifyUpdatedOrders".

              * *(string) --*

                * *(string) --*

            * **WorkflowId** *(string) --*

              Unique identifier for the workflow.

            * **IsUnstructured** *(boolean) --*

              Boolean that shows if the Flow that's associated with
              the Integration is created in Amazon Appflow, or with
              ObjectTypeName equals _unstructured via API/CLI in
              flowDefinition.

            * **RoleArn** *(string) --*

              The Amazon Resource Name (ARN) of the IAM role. The
              Integration uses this role to make Customer Profiles
              requests on your behalf.

            * **EventTriggerNames** *(list) --*

              A list of unique names for active event triggers
              associated with the integration.

              * *(string) --*

        * **NextToken** *(string) --*

          The pagination token from the previous
          ListAccountIntegrations API call.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / put_profile_object_type


put_profile_object_type
***********************

CustomerProfiles.Client.put_profile_object_type(**kwargs)

   Defines a ProfileObjectType.

   To add or remove tags on an existing ObjectType, see TagResource/
   UntagResource.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.put_profile_object_type(
          DomainName='string',
          ObjectTypeName='string',
          Description='string',
          TemplateId='string',
          ExpirationDays=123,
          EncryptionKey='string',
          AllowProfileCreation=True|False,
          SourceLastUpdatedTimestampFormat='string',
          MaxProfileObjectCount=123,
          Fields={
              'string': {
                  'Source': 'string',
                  'Target': 'string',
                  'ContentType': 'STRING'|'NUMBER'|'PHONE_NUMBER'|'EMAIL_ADDRESS'|'NAME'
              }
          },
          Keys={
              'string': [
                  {
                      'StandardIdentifiers': [
                          'PROFILE'|'ASSET'|'CASE'|'ORDER'|'COMMUNICATION_RECORD'|'AIR_PREFERENCE'|'HOTEL_PREFERENCE'|'AIR_BOOKING'|'AIR_SEGMENT'|'HOTEL_RESERVATION'|'HOTEL_STAY_REVENUE'|'LOYALTY'|'LOYALTY_TRANSACTION'|'LOYALTY_PROMOTION'|'UNIQUE'|'SECONDARY'|'LOOKUP_ONLY'|'NEW_ONLY',
                      ],
                      'FieldNames': [
                          'string',
                      ]
                  },
              ]
          },
          Tags={
              'string': 'string'
          }
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **ObjectTypeName** (*string*) --

        **[REQUIRED]**

        The name of the profile object type.

      * **Description** (*string*) --

        **[REQUIRED]**

        Description of the profile object type.

      * **TemplateId** (*string*) -- A unique identifier for the
        object template. For some attributes in the request, the
        service will use the default value from the object template
        when TemplateId is present. If these attributes are present in
        the request, the service may return a "BadRequestException".
        These attributes include: AllowProfileCreation,
        SourceLastUpdatedTimestampFormat, Fields, and Keys. For
        example, if AllowProfileCreation is set to true when
        TemplateId is set, the service may return a
        "BadRequestException".

      * **ExpirationDays** (*integer*) -- The number of days until the
        data in the object expires.

      * **EncryptionKey** (*string*) -- The customer-provided key to
        encrypt the profile object that will be created in this
        profile object type.

      * **AllowProfileCreation** (*boolean*) -- Indicates whether a
        profile should be created when data is received if one doesn’t
        exist for an object of this type. The default is "FALSE". If
        the AllowProfileCreation flag is set to "FALSE", then the
        service tries to fetch a standard profile and associate this
        object with the profile. If it is set to "TRUE", and if no
        match is found, then the service creates a new standard
        profile.

      * **SourceLastUpdatedTimestampFormat** (*string*) -- The format
        of your "sourceLastUpdatedTimestamp" that was previously set
        up.

      * **MaxProfileObjectCount** (*integer*) -- The amount of profile
        object max count assigned to the object type

      * **Fields** (*dict*) --

        A map of the name and ObjectType field.

        * *(string) --*

          * *(dict) --*

            Represents a field in a ProfileObjectType.

            * **Source** *(string) --*

              A field of a ProfileObject. For example:
              _source.FirstName, where “_source” is a
              ProfileObjectType of a Zendesk user and “FirstName” is a
              field in that ObjectType.

            * **Target** *(string) --*

              The location of the data in the standard ProfileObject
              model. For example: _profile.Address.PostalCode.

            * **ContentType** *(string) --*

              The content type of the field. Used for determining
              equality when searching.

      * **Keys** (*dict*) --

        A list of unique keys that can be used to map data to the
        profile.

        * *(string) --*

          * *(list) --*

            * *(dict) --*

              An object that defines the Key element of a
              ProfileObject. A Key is a special element that can be
              used to search for a customer profile.

              * **StandardIdentifiers** *(list) --*

                The types of keys that a ProfileObject can have. Each
                ProfileObject can have only 1 UNIQUE key but multiple
                PROFILE keys. PROFILE, ASSET, CASE, or ORDER means
                that this key can be used to tie an object to a
                PROFILE, ASSET, CASE, or ORDER respectively. UNIQUE
                means that it can be used to uniquely identify an
                object. If a key a is marked as SECONDARY, it will be
                used to search for profiles after all other PROFILE
                keys have been searched. A LOOKUP_ONLY key is only
                used to match a profile but is not persisted to be
                used for searching of the profile. A NEW_ONLY key is
                only used if the profile does not already exist before
                the object is ingested, otherwise it is only used for
                matching objects to profiles.

                * *(string) --*

              * **FieldNames** *(list) --*

                The reference for the key name of the fields map.

                * *(string) --*

      * **Tags** (*dict*) --

        The tags used to organize, track, or control access for this
        resource.

        * *(string) --*

          * *(string) --*

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'ObjectTypeName': 'string',
             'Description': 'string',
             'TemplateId': 'string',
             'ExpirationDays': 123,
             'EncryptionKey': 'string',
             'AllowProfileCreation': True|False,
             'SourceLastUpdatedTimestampFormat': 'string',
             'MaxProfileObjectCount': 123,
             'MaxAvailableProfileObjectCount': 123,
             'Fields': {
                 'string': {
                     'Source': 'string',
                     'Target': 'string',
                     'ContentType': 'STRING'|'NUMBER'|'PHONE_NUMBER'|'EMAIL_ADDRESS'|'NAME'
                 }
             },
             'Keys': {
                 'string': [
                     {
                         'StandardIdentifiers': [
                             'PROFILE'|'ASSET'|'CASE'|'ORDER'|'COMMUNICATION_RECORD'|'AIR_PREFERENCE'|'HOTEL_PREFERENCE'|'AIR_BOOKING'|'AIR_SEGMENT'|'HOTEL_RESERVATION'|'HOTEL_STAY_REVENUE'|'LOYALTY'|'LOYALTY_TRANSACTION'|'LOYALTY_PROMOTION'|'UNIQUE'|'SECONDARY'|'LOOKUP_ONLY'|'NEW_ONLY',
                         ],
                         'FieldNames': [
                             'string',
                         ]
                     },
                 ]
             },
             'CreatedAt': datetime(2015, 1, 1),
             'LastUpdatedAt': datetime(2015, 1, 1),
             'Tags': {
                 'string': 'string'
             }
         }

      **Response Structure**

      * *(dict) --*

        * **ObjectTypeName** *(string) --*

          The name of the profile object type.

        * **Description** *(string) --*

          Description of the profile object type.

        * **TemplateId** *(string) --*

          A unique identifier for the object template.

        * **ExpirationDays** *(integer) --*

          The number of days until the data in the object expires.

        * **EncryptionKey** *(string) --*

          The customer-provided key to encrypt the profile object that
          will be created in this profile object type.

        * **AllowProfileCreation** *(boolean) --*

          Indicates whether a profile should be created when data is
          received if one doesn’t exist for an object of this type.
          The default is "FALSE". If the AllowProfileCreation flag is
          set to "FALSE", then the service tries to fetch a standard
          profile and associate this object with the profile. If it is
          set to "TRUE", and if no match is found, then the service
          creates a new standard profile.

        * **SourceLastUpdatedTimestampFormat** *(string) --*

          The format of your "sourceLastUpdatedTimestamp" that was
          previously set up in fields that were parsed using
          SimpleDateFormat. If you have "sourceLastUpdatedTimestamp"
          in your field, you must set up
          "sourceLastUpdatedTimestampFormat".

        * **MaxProfileObjectCount** *(integer) --*

          The amount of profile object max count assigned to the
          object type.

        * **MaxAvailableProfileObjectCount** *(integer) --*

          The amount of provisioned profile object max count
          available.

        * **Fields** *(dict) --*

          A map of the name and ObjectType field.

          * *(string) --*

            * *(dict) --*

              Represents a field in a ProfileObjectType.

              * **Source** *(string) --*

                A field of a ProfileObject. For example:
                _source.FirstName, where “_source” is a
                ProfileObjectType of a Zendesk user and “FirstName” is
                a field in that ObjectType.

              * **Target** *(string) --*

                The location of the data in the standard ProfileObject
                model. For example: _profile.Address.PostalCode.

              * **ContentType** *(string) --*

                The content type of the field. Used for determining
                equality when searching.

        * **Keys** *(dict) --*

          A list of unique keys that can be used to map data to the
          profile.

          * *(string) --*

            * *(list) --*

              * *(dict) --*

                An object that defines the Key element of a
                ProfileObject. A Key is a special element that can be
                used to search for a customer profile.

                * **StandardIdentifiers** *(list) --*

                  The types of keys that a ProfileObject can have.
                  Each ProfileObject can have only 1 UNIQUE key but
                  multiple PROFILE keys. PROFILE, ASSET, CASE, or
                  ORDER means that this key can be used to tie an
                  object to a PROFILE, ASSET, CASE, or ORDER
                  respectively. UNIQUE means that it can be used to
                  uniquely identify an object. If a key a is marked as
                  SECONDARY, it will be used to search for profiles
                  after all other PROFILE keys have been searched. A
                  LOOKUP_ONLY key is only used to match a profile but
                  is not persisted to be used for searching of the
                  profile. A NEW_ONLY key is only used if the profile
                  does not already exist before the object is
                  ingested, otherwise it is only used for matching
                  objects to profiles.

                  * *(string) --*

                * **FieldNames** *(list) --*

                  The reference for the key name of the fields map.

                  * *(string) --*

        * **CreatedAt** *(datetime) --*

          The timestamp of when the domain was created.

        * **LastUpdatedAt** *(datetime) --*

          The timestamp of when the domain was most recently edited.

        * **Tags** *(dict) --*

          The tags used to organize, track, or control access for this
          resource.

          * *(string) --*

            * *(string) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / get_waiter


get_waiter
**********

CustomerProfiles.Client.get_waiter(waiter_name)

   Returns an object that can wait for some condition.

   Parameters:
      **waiter_name** (*str*) -- The name of the waiter to get. See
      the waiters section of the service docs for a list of available
      waiters.

   Returns:
      The specified waiter object.

   Return type:
      "botocore.waiter.Waiter"
CustomerProfiles / Client / create_segment_estimate


create_segment_estimate
***********************

CustomerProfiles.Client.create_segment_estimate(**kwargs)

   Creates a segment estimate query.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.create_segment_estimate(
          DomainName='string',
          SegmentQuery={
              'Groups': [
                  {
                      'Dimensions': [
                          {
                              'ProfileAttributes': {
                                  'AccountNumber': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'AdditionalInformation': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'FirstName': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'LastName': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'MiddleName': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'GenderString': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'PartyTypeString': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'BirthDate': {
                                      'DimensionType': 'BEFORE'|'AFTER'|'BETWEEN'|'NOT_BETWEEN'|'ON',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'PhoneNumber': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'BusinessName': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'BusinessPhoneNumber': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'HomePhoneNumber': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'MobilePhoneNumber': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'EmailAddress': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'PersonalEmailAddress': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'BusinessEmailAddress': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'Address': {
                                      'City': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'Country': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'County': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'PostalCode': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'Province': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'State': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      }
                                  },
                                  'ShippingAddress': {
                                      'City': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'Country': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'County': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'PostalCode': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'Province': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'State': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      }
                                  },
                                  'MailingAddress': {
                                      'City': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'Country': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'County': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'PostalCode': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'Province': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'State': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      }
                                  },
                                  'BillingAddress': {
                                      'City': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'Country': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'County': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'PostalCode': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'Province': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'State': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      }
                                  },
                                  'Attributes': {
                                      'string': {
                                          'DimensionType': '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': [
                                              'string',
                                          ]
                                      }
                                  },
                                  'ProfileType': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                      'Values': [
                                          'ACCOUNT_PROFILE'|'PROFILE',
                                      ]
                                  }
                              },
                              'CalculatedAttributes': {
                                  'string': {
                                      'DimensionType': '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': [
                                          'string',
                                      ],
                                      'ConditionOverrides': {
                                          'Range': {
                                              'Start': 123,
                                              'End': 123,
                                              'Unit': 'DAYS'
                                          }
                                      }
                                  }
                              }
                          },
                      ],
                      'SourceSegments': [
                          {
                              'SegmentDefinitionName': 'string'
                          },
                      ],
                      'SourceType': 'ALL'|'ANY'|'NONE',
                      'Type': 'ALL'|'ANY'|'NONE'
                  },
              ],
              'Include': 'ALL'|'ANY'|'NONE'
          }
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **SegmentQuery** (*dict*) --

        **[REQUIRED]**

        The segment query for calculating a segment estimate.

        * **Groups** *(list) --*

          Holds the list of groups within the segment definition.

          * *(dict) --*

            Contains dimensions that determine what to segment on.

            * **Dimensions** *(list) --*

              Defines the attributes to segment on.

              * *(dict) --*

                Object that holds what profile and calculated
                attributes to segment on.

                Note:

                  This is a Tagged Union structure. Only one of the
                  following top level keys can be set:
                  "ProfileAttributes", "CalculatedAttributes".

                * **ProfileAttributes** *(dict) --*

                  Object that holds the profile attributes to segment
                  on.

                  * **AccountNumber** *(dict) --*

                    A field to describe values to segment on within
                    account number.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment on.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **AdditionalInformation** *(dict) --*

                    A field to describe values to segment on within
                    additional information.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment with.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **FirstName** *(dict) --*

                    A field to describe values to segment on within
                    first name.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment on.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **LastName** *(dict) --*

                    A field to describe values to segment on within
                    last name.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment on.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **MiddleName** *(dict) --*

                    A field to describe values to segment on within
                    middle name.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment on.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **GenderString** *(dict) --*

                    A field to describe values to segment on within
                    genderString.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment on.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **PartyTypeString** *(dict) --*

                    A field to describe values to segment on within
                    partyTypeString.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment on.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **BirthDate** *(dict) --*

                    A field to describe values to segment on within
                    birthDate.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment with.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **PhoneNumber** *(dict) --*

                    A field to describe values to segment on within
                    phone number.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment on.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **BusinessName** *(dict) --*

                    A field to describe values to segment on within
                    business name.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment on.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **BusinessPhoneNumber** *(dict) --*

                    A field to describe values to segment on within
                    business phone number.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment on.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **HomePhoneNumber** *(dict) --*

                    A field to describe values to segment on within
                    home phone number.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment on.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **MobilePhoneNumber** *(dict) --*

                    A field to describe values to segment on within
                    mobile phone number.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment on.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **EmailAddress** *(dict) --*

                    A field to describe values to segment on within
                    email address.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment on.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **PersonalEmailAddress** *(dict) --*

                    A field to describe values to segment on within
                    personal email address.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment on.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **BusinessEmailAddress** *(dict) --*

                    A field to describe values to segment on within
                    business email address.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment on.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **Address** *(dict) --*

                    A field to describe values to segment on within
                    address.

                    * **City** *(dict) --*

                      The city belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **Country** *(dict) --*

                      The country belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **County** *(dict) --*

                      The county belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **PostalCode** *(dict) --*

                      The postal code belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **Province** *(dict) --*

                      The province belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **State** *(dict) --*

                      The state belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                  * **ShippingAddress** *(dict) --*

                    A field to describe values to segment on within
                    shipping address.

                    * **City** *(dict) --*

                      The city belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **Country** *(dict) --*

                      The country belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **County** *(dict) --*

                      The county belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **PostalCode** *(dict) --*

                      The postal code belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **Province** *(dict) --*

                      The province belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **State** *(dict) --*

                      The state belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                  * **MailingAddress** *(dict) --*

                    A field to describe values to segment on within
                    mailing address.

                    * **City** *(dict) --*

                      The city belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **Country** *(dict) --*

                      The country belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **County** *(dict) --*

                      The county belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **PostalCode** *(dict) --*

                      The postal code belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **Province** *(dict) --*

                      The province belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **State** *(dict) --*

                      The state belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                  * **BillingAddress** *(dict) --*

                    A field to describe values to segment on within
                    billing address.

                    * **City** *(dict) --*

                      The city belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **Country** *(dict) --*

                      The country belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **County** *(dict) --*

                      The county belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **PostalCode** *(dict) --*

                      The postal code belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **Province** *(dict) --*

                      The province belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **State** *(dict) --*

                      The state belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                  * **Attributes** *(dict) --*

                    A field to describe values to segment on within
                    attributes.

                    * *(string) --*

                      * *(dict) --*

                        Object that segments on various Customer
                        Profile's fields.

                        * **DimensionType** *(string) --*
                          **[REQUIRED]**

                          The action to segment with.

                        * **Values** *(list) --* **[REQUIRED]**

                          The values to apply the DimensionType on.

                          * *(string) --*

                  * **ProfileType** *(dict) --*

                    A field to describe values to segment on within
                    profile type.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment on.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                * **CalculatedAttributes** *(dict) --*

                  Object that holds the calculated attributes to
                  segment on.

                  * *(string) --*

                    * *(dict) --*

                      Object that segments on Customer Profile's
                      Calculated Attributes.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment with.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType with.

                        * *(string) --*

                      * **ConditionOverrides** *(dict) --*

                        Applies the given condition over the initial
                        Calculated Attribute's definition.

                        * **Range** *(dict) --*

                          The relative time period over which data is
                          included in the aggregation for this
                          override.

                          * **Start** *(integer) --* **[REQUIRED]**

                            The start time of when to include objects.

                          * **End** *(integer) --*

                            The end time of when to include objects.

                          * **Unit** *(string) --* **[REQUIRED]**

                            The unit for start and end.

            * **SourceSegments** *(list) --*

              Defines the starting source of data.

              * *(dict) --*

                The source segments to build off of.

                * **SegmentDefinitionName** *(string) --*

                  The unique name of the segment definition.

            * **SourceType** *(string) --*

              Defines how to interact with the source data.

            * **Type** *(string) --*

              Defines how to interact with the profiles found in the
              current filtering.

        * **Include** *(string) --*

          Define whether to include or exclude the profiles that fit
          the segment criteria.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'DomainName': 'string',
             'EstimateId': 'string',
             'StatusCode': 123
         }

      **Response Structure**

      * *(dict) --*

        * **DomainName** *(string) --*

          The unique name of the domain.

        * **EstimateId** *(string) --*

          A unique identifier for the resource. The value can be
          passed to "GetSegmentEstimate" to retrieve the result of
          segment estimate status.

        * **StatusCode** *(integer) --*

          The status code for the response.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / delete_integration


delete_integration
******************

CustomerProfiles.Client.delete_integration(**kwargs)

   Removes an integration from a specific domain.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.delete_integration(
          DomainName='string',
          Uri='string'
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **Uri** (*string*) --

        **[REQUIRED]**

        The URI of the S3 bucket or any other type of data source.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'Message': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **Message** *(string) --*

          A message that indicates the delete request is done.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / get_workflow_steps


get_workflow_steps
******************

CustomerProfiles.Client.get_workflow_steps(**kwargs)

   Get granular list of steps in workflow.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.get_workflow_steps(
          DomainName='string',
          WorkflowId='string',
          NextToken='string',
          MaxResults=123
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **WorkflowId** (*string*) --

        **[REQUIRED]**

        Unique identifier for the workflow.

      * **NextToken** (*string*) -- 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.

      * **MaxResults** (*integer*) -- The maximum number of results to
        return per page.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'WorkflowId': 'string',
             'WorkflowType': 'APPFLOW_INTEGRATION',
             'Items': [
                 {
                     'AppflowIntegration': {
                         'FlowName': 'string',
                         'Status': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETE'|'FAILED'|'SPLIT'|'RETRY'|'CANCELLED',
                         'ExecutionMessage': 'string',
                         'RecordsProcessed': 123,
                         'BatchRecordsStartTime': 'string',
                         'BatchRecordsEndTime': 'string',
                         'CreatedAt': datetime(2015, 1, 1),
                         'LastUpdatedAt': datetime(2015, 1, 1)
                     }
                 },
             ],
             'NextToken': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **WorkflowId** *(string) --*

          Unique identifier for the workflow.

        * **WorkflowType** *(string) --*

          The type of workflow. The only supported value is
          APPFLOW_INTEGRATION.

        * **Items** *(list) --*

          List containing workflow step details.

          * *(dict) --*

            List containing steps in workflow.

            * **AppflowIntegration** *(dict) --*

              Workflow step information specific to
              "APPFLOW_INTEGRATION" workflow.

              * **FlowName** *(string) --*

                Name of the flow created during execution of workflow
                step. "APPFLOW_INTEGRATION" workflow type creates an
                appflow flow during workflow step execution on the
                customers behalf.

              * **Status** *(string) --*

                Workflow step status for "APPFLOW_INTEGRATION"
                workflow.

              * **ExecutionMessage** *(string) --*

                Message indicating execution of workflow step for
                "APPFLOW_INTEGRATION" workflow.

              * **RecordsProcessed** *(integer) --*

                Total number of records processed during execution of
                workflow step for "APPFLOW_INTEGRATION" workflow.

              * **BatchRecordsStartTime** *(string) --*

                Start datetime of records pulled in batch during
                execution of workflow step for "APPFLOW_INTEGRATION"
                workflow.

              * **BatchRecordsEndTime** *(string) --*

                End datetime of records pulled in batch during
                execution of workflow step for "APPFLOW_INTEGRATION"
                workflow.

              * **CreatedAt** *(datetime) --*

                Creation timestamp of workflow step for
                "APPFLOW_INTEGRATION" workflow.

              * **LastUpdatedAt** *(datetime) --*

                Last updated timestamp for workflow step for
                "APPFLOW_INTEGRATION" workflow.

        * **NextToken** *(string) --*

          If there are additional results, this is the token for the
          next set of results.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / put_profile_object


put_profile_object
******************

CustomerProfiles.Client.put_profile_object(**kwargs)

   Adds additional objects to customer profiles of a given ObjectType.

   When adding a specific profile object, like a Contact Record, an
   inferred profile can get created if it is not mapped to an existing
   profile. The resulting profile will only have a phone number
   populated in the standard ProfileObject. Any additional Contact
   Records with the same phone number will be mapped to the same
   inferred profile.

   When a ProfileObject is created and if a ProfileObjectType already
   exists for the ProfileObject, it will provide data to a standard
   profile depending on the ProfileObjectType definition.

   PutProfileObject needs an ObjectType, which can be created using
   PutProfileObjectType.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.put_profile_object(
          ObjectTypeName='string',
          Object='string',
          DomainName='string'
      )

   Parameters:
      * **ObjectTypeName** (*string*) --

        **[REQUIRED]**

        The name of the profile object type.

      * **Object** (*string*) --

        **[REQUIRED]**

        A string that is serialized from a JSON object.

      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'ProfileObjectUniqueKey': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **ProfileObjectUniqueKey** *(string) --*

          The unique identifier of the profile object generated by the
          service.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / batch_get_profile


batch_get_profile
*****************

CustomerProfiles.Client.batch_get_profile(**kwargs)

   Get a batch of profiles.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.batch_get_profile(
          DomainName='string',
          ProfileIds=[
              'string',
          ]
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **ProfileIds** (*list*) --

        **[REQUIRED]**

        List of unique identifiers for customer profiles to retrieve.

        * *(string) --*

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'Errors': [
                 {
                     'Code': 'string',
                     'Message': 'string',
                     'ProfileId': 'string'
                 },
             ],
             'Profiles': [
                 {
                     'ProfileId': 'string',
                     'AccountNumber': 'string',
                     'AdditionalInformation': 'string',
                     'PartyType': 'INDIVIDUAL'|'BUSINESS'|'OTHER',
                     'BusinessName': 'string',
                     'FirstName': 'string',
                     'MiddleName': 'string',
                     'LastName': 'string',
                     'BirthDate': 'string',
                     'Gender': 'MALE'|'FEMALE'|'UNSPECIFIED',
                     'PhoneNumber': 'string',
                     'MobilePhoneNumber': 'string',
                     'HomePhoneNumber': 'string',
                     'BusinessPhoneNumber': 'string',
                     'EmailAddress': 'string',
                     'PersonalEmailAddress': 'string',
                     'BusinessEmailAddress': 'string',
                     'Address': {
                         'Address1': 'string',
                         'Address2': 'string',
                         'Address3': 'string',
                         'Address4': 'string',
                         'City': 'string',
                         'County': 'string',
                         'State': 'string',
                         'Province': 'string',
                         'Country': 'string',
                         'PostalCode': 'string'
                     },
                     'ShippingAddress': {
                         'Address1': 'string',
                         'Address2': 'string',
                         'Address3': 'string',
                         'Address4': 'string',
                         'City': 'string',
                         'County': 'string',
                         'State': 'string',
                         'Province': 'string',
                         'Country': 'string',
                         'PostalCode': 'string'
                     },
                     'MailingAddress': {
                         'Address1': 'string',
                         'Address2': 'string',
                         'Address3': 'string',
                         'Address4': 'string',
                         'City': 'string',
                         'County': 'string',
                         'State': 'string',
                         'Province': 'string',
                         'Country': 'string',
                         'PostalCode': 'string'
                     },
                     'BillingAddress': {
                         'Address1': 'string',
                         'Address2': 'string',
                         'Address3': 'string',
                         'Address4': 'string',
                         'City': 'string',
                         'County': 'string',
                         'State': 'string',
                         'Province': 'string',
                         'Country': 'string',
                         'PostalCode': 'string'
                     },
                     'Attributes': {
                         'string': 'string'
                     },
                     'FoundByItems': [
                         {
                             'KeyName': 'string',
                             'Values': [
                                 'string',
                             ]
                         },
                     ],
                     'PartyTypeString': 'string',
                     'GenderString': 'string',
                     'ProfileType': 'ACCOUNT_PROFILE'|'PROFILE',
                     'EngagementPreferences': {
                         'Phone': [
                             {
                                 'KeyName': 'string',
                                 'KeyValue': 'string',
                                 'ProfileId': 'string',
                                 'ContactType': 'PhoneNumber'|'MobilePhoneNumber'|'HomePhoneNumber'|'BusinessPhoneNumber'|'EmailAddress'|'PersonalEmailAddress'|'BusinessEmailAddress'
                             },
                         ],
                         'Email': [
                             {
                                 'KeyName': 'string',
                                 'KeyValue': 'string',
                                 'ProfileId': 'string',
                                 'ContactType': 'PhoneNumber'|'MobilePhoneNumber'|'HomePhoneNumber'|'BusinessPhoneNumber'|'EmailAddress'|'PersonalEmailAddress'|'BusinessEmailAddress'
                             },
                         ]
                     }
                 },
             ]
         }

      **Response Structure**

      * *(dict) --*

        * **Errors** *(list) --*

          For information about the errors that are common to all
          actions, see Common Errors.

          * *(dict) --*

            Error object describing why a specific profile failed.

            * **Code** *(string) --*

              Status code for why a specific profile failed.

            * **Message** *(string) --*

              Message describing why a specific profile failed.

            * **ProfileId** *(string) --*

              The profile id that failed.

        * **Profiles** *(list) --*

          Array of Profile Objects.

          * *(dict) --*

            The standard profile of a customer.

            * **ProfileId** *(string) --*

              The unique identifier of a customer profile.

            * **AccountNumber** *(string) --*

              An account number that you have assigned to the
              customer.

            * **AdditionalInformation** *(string) --*

              Any additional information relevant to the customer’s
              profile.

            * **PartyType** *(string) --*

              The type of profile used to describe the customer.

            * **BusinessName** *(string) --*

              The name of the customer’s business.

            * **FirstName** *(string) --*

              The customer’s first name.

            * **MiddleName** *(string) --*

              The customer’s middle name.

            * **LastName** *(string) --*

              The customer’s last name.

            * **BirthDate** *(string) --*

              The customer’s birth date.

            * **Gender** *(string) --*

              The gender with which the customer identifies.

            * **PhoneNumber** *(string) --*

              The customer's phone number, which has not been
              specified as a mobile, home, or business number.

            * **MobilePhoneNumber** *(string) --*

              The customer’s mobile phone number.

            * **HomePhoneNumber** *(string) --*

              The customer’s home phone number.

            * **BusinessPhoneNumber** *(string) --*

              The customer’s home phone number.

            * **EmailAddress** *(string) --*

              The customer’s email address, which has not been
              specified as a personal or business address.

            * **PersonalEmailAddress** *(string) --*

              The customer’s personal email address.

            * **BusinessEmailAddress** *(string) --*

              The customer’s business email address.

            * **Address** *(dict) --*

              A generic address associated with the customer that is
              not mailing, shipping, or billing.

              * **Address1** *(string) --*

                The first line of a customer address.

              * **Address2** *(string) --*

                The second line of a customer address.

              * **Address3** *(string) --*

                The third line of a customer address.

              * **Address4** *(string) --*

                The fourth line of a customer address.

              * **City** *(string) --*

                The city in which a customer lives.

              * **County** *(string) --*

                The county in which a customer lives.

              * **State** *(string) --*

                The state in which a customer lives.

              * **Province** *(string) --*

                The province in which a customer lives.

              * **Country** *(string) --*

                The country in which a customer lives.

              * **PostalCode** *(string) --*

                The postal code of a customer address.

            * **ShippingAddress** *(dict) --*

              The customer’s shipping address.

              * **Address1** *(string) --*

                The first line of a customer address.

              * **Address2** *(string) --*

                The second line of a customer address.

              * **Address3** *(string) --*

                The third line of a customer address.

              * **Address4** *(string) --*

                The fourth line of a customer address.

              * **City** *(string) --*

                The city in which a customer lives.

              * **County** *(string) --*

                The county in which a customer lives.

              * **State** *(string) --*

                The state in which a customer lives.

              * **Province** *(string) --*

                The province in which a customer lives.

              * **Country** *(string) --*

                The country in which a customer lives.

              * **PostalCode** *(string) --*

                The postal code of a customer address.

            * **MailingAddress** *(dict) --*

              The customer’s mailing address.

              * **Address1** *(string) --*

                The first line of a customer address.

              * **Address2** *(string) --*

                The second line of a customer address.

              * **Address3** *(string) --*

                The third line of a customer address.

              * **Address4** *(string) --*

                The fourth line of a customer address.

              * **City** *(string) --*

                The city in which a customer lives.

              * **County** *(string) --*

                The county in which a customer lives.

              * **State** *(string) --*

                The state in which a customer lives.

              * **Province** *(string) --*

                The province in which a customer lives.

              * **Country** *(string) --*

                The country in which a customer lives.

              * **PostalCode** *(string) --*

                The postal code of a customer address.

            * **BillingAddress** *(dict) --*

              The customer’s billing address.

              * **Address1** *(string) --*

                The first line of a customer address.

              * **Address2** *(string) --*

                The second line of a customer address.

              * **Address3** *(string) --*

                The third line of a customer address.

              * **Address4** *(string) --*

                The fourth line of a customer address.

              * **City** *(string) --*

                The city in which a customer lives.

              * **County** *(string) --*

                The county in which a customer lives.

              * **State** *(string) --*

                The state in which a customer lives.

              * **Province** *(string) --*

                The province in which a customer lives.

              * **Country** *(string) --*

                The country in which a customer lives.

              * **PostalCode** *(string) --*

                The postal code of a customer address.

            * **Attributes** *(dict) --*

              A key value pair of attributes of a customer profile.

              * *(string) --*

                * *(string) --*

            * **FoundByItems** *(list) --*

              A list of items used to find a profile returned in a
              SearchProfiles response. An item is a key-value(s) pair
              that matches an attribute in the profile.

              If the optional "AdditionalSearchKeys" parameter was
              included in the SearchProfiles request, the
              "FoundByItems" list should be interpreted based on the
              "LogicalOperator" used in the request:

              * "AND" - The profile included in the response matched
                all of the search keys specified in the request. The
                "FoundByItems" will include all of the key-value(s)
                pairs that were specified in the request (as this is a
                requirement of "AND" search logic).

              * "OR" - The profile included in the response matched at
                least one of the search keys specified in the request.
                The "FoundByItems" will include each of the key-
                value(s) pairs that the profile was found by.

              The "OR" relationship is the default behavior if the
              "LogicalOperator" parameter is not included in the
              SearchProfiles request.

              * *(dict) --*

                A data type pair that consists of a "KeyName" and
                "Values" list that were used to find a profile
                returned in response to a SearchProfiles request.

                * **KeyName** *(string) --*

                  A searchable identifier of a customer profile.

                * **Values** *(list) --*

                  A list of key values.

                  * *(string) --*

            * **PartyTypeString** *(string) --*

              An alternative to PartyType which accepts any string as
              input.

            * **GenderString** *(string) --*

              An alternative to Gender which accepts any string as
              input.

            * **ProfileType** *(string) --*

              The type of the profile.

            * **EngagementPreferences** *(dict) --*

              The customer or account’s engagement preferences.

              * **Phone** *(list) --*

                A list of phone-related contact preferences

                * *(dict) --*

                  Object that defines users contact preference.

                  * **KeyName** *(string) --*

                    A searchable, unique identifier of a customer
                    profile.

                  * **KeyValue** *(string) --*

                    The key value used to look up profile based off
                    the keyName.

                  * **ProfileId** *(string) --*

                    The unique identifier of a customer profile.

                  * **ContactType** *(string) --*

                    The contact type used for engagement. For example:
                    HomePhoneNumber, PersonalEmailAddress.

              * **Email** *(list) --*

                A list of email-related contact preferences

                * *(dict) --*

                  Object that defines users contact preference.

                  * **KeyName** *(string) --*

                    A searchable, unique identifier of a customer
                    profile.

                  * **KeyValue** *(string) --*

                    The key value used to look up profile based off
                    the keyName.

                  * **ProfileId** *(string) --*

                    The unique identifier of a customer profile.

                  * **ContactType** *(string) --*

                    The contact type used for engagement. For example:
                    HomePhoneNumber, PersonalEmailAddress.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / list_segment_definitions


list_segment_definitions
************************

CustomerProfiles.Client.list_segment_definitions(**kwargs)

   Lists all segment definitions under a domain.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_segment_definitions(
          DomainName='string',
          MaxResults=123,
          NextToken='string'
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique identifier of the domain.

      * **MaxResults** (*integer*) -- The maximum number of objects
        returned per page.

      * **NextToken** (*string*) -- The pagination token from the
        previous call.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'NextToken': 'string',
             'Items': [
                 {
                     'SegmentDefinitionName': 'string',
                     'DisplayName': 'string',
                     'Description': 'string',
                     'SegmentDefinitionArn': 'string',
                     'CreatedAt': datetime(2015, 1, 1),
                     'Tags': {
                         'string': 'string'
                     }
                 },
             ]
         }

      **Response Structure**

      * *(dict) --*

        * **NextToken** *(string) --*

          The pagination token from the previous call.

        * **Items** *(list) --*

          List of segment definitions.

          * *(dict) --*

            Object holding the segment definition fields.

            * **SegmentDefinitionName** *(string) --*

              Name of the segment definition.

            * **DisplayName** *(string) --*

              Display name of the segment definition.

            * **Description** *(string) --*

              The description of the segment definition.

            * **SegmentDefinitionArn** *(string) --*

              The arn of the segment definition.

            * **CreatedAt** *(datetime) --*

              When the segment definition was created.

            * **Tags** *(dict) --*

              The tags belonging to the segment definition.

              * *(string) --*

                * *(string) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"
CustomerProfiles / Client / batch_get_calculated_attribute_for_profile


batch_get_calculated_attribute_for_profile
******************************************

CustomerProfiles.Client.batch_get_calculated_attribute_for_profile(**kwargs)

   Fetch the possible attribute values given the attribute name.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.batch_get_calculated_attribute_for_profile(
          CalculatedAttributeName='string',
          DomainName='string',
          ProfileIds=[
              'string',
          ],
          ConditionOverrides={
              'Range': {
                  'Start': 123,
                  'End': 123,
                  'Unit': 'DAYS'
              }
          }
      )

   Parameters:
      * **CalculatedAttributeName** (*string*) --

        **[REQUIRED]**

        The unique name of the calculated attribute.

      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **ProfileIds** (*list*) --

        **[REQUIRED]**

        List of unique identifiers for customer profiles to retrieve.

        * *(string) --*

      * **ConditionOverrides** (*dict*) --

        Overrides the condition block within the original calculated
        attribute definition.

        * **Range** *(dict) --*

          The relative time period over which data is included in the
          aggregation for this override.

          * **Start** *(integer) --* **[REQUIRED]**

            The start time of when to include objects.

          * **End** *(integer) --*

            The end time of when to include objects.

          * **Unit** *(string) --* **[REQUIRED]**

            The unit for start and end.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'Errors': [
                 {
                     'Code': 'string',
                     'Message': 'string',
                     'ProfileId': 'string'
                 },
             ],
             'CalculatedAttributeValues': [
                 {
                     'CalculatedAttributeName': 'string',
                     'DisplayName': 'string',
                     'IsDataPartial': 'string',
                     'ProfileId': 'string',
                     'Value': 'string',
                     'LastObjectTimestamp': datetime(2015, 1, 1)
                 },
             ],
             'ConditionOverrides': {
                 'Range': {
                     'Start': 123,
                     'End': 123,
                     'Unit': 'DAYS'
                 }
             }
         }

      **Response Structure**

      * *(dict) --*

        * **Errors** *(list) --*

          List of errors for calculated attribute values that could
          not be retrieved.

          * *(dict) --*

            Error object describing why a specific profile and
            calculated attribute failed.

            * **Code** *(string) --*

              Status code for why a specific profile and calculated
              attribute failed.

            * **Message** *(string) --*

              Message describing why a specific profile and calculated
              attribute failed.

            * **ProfileId** *(string) --*

              The profile id that failed.

        * **CalculatedAttributeValues** *(list) --*

          List of calculated attribute values retrieved.

          * *(dict) --*

            The object containing the values of a single calculated
            attribute value.

            * **CalculatedAttributeName** *(string) --*

              The unique name of the calculated attribute.

            * **DisplayName** *(string) --*

              The display name of the calculated attribute.

            * **IsDataPartial** *(string) --*

              Indicates whether the calculated attribute's value is
              based on partial data. If the data is partial, it is set
              to true.

            * **ProfileId** *(string) --*

              The profile id belonging to this calculated attribute
              value.

            * **Value** *(string) --*

              The value of the calculated attribute.

            * **LastObjectTimestamp** *(datetime) --*

              The timestamp of the newest object included in the
              calculated attribute calculation.

        * **ConditionOverrides** *(dict) --*

          Overrides the condition block within the original calculated
          attribute definition.

          * **Range** *(dict) --*

            The relative time period over which data is included in
            the aggregation for this override.

            * **Start** *(integer) --*

              The start time of when to include objects.

            * **End** *(integer) --*

              The end time of when to include objects.

            * **Unit** *(string) --*

              The unit for start and end.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / list_domain_layouts


list_domain_layouts
*******************

CustomerProfiles.Client.list_domain_layouts(**kwargs)

   Lists the existing layouts that can be used to view data for a
   specific domain. This API can only be invoked from the Amazon
   Connect admin website.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_domain_layouts(
          DomainName='string',
          NextToken='string',
          MaxResults=123
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **NextToken** (*string*) -- Identifies the next page of
        results to return.

      * **MaxResults** (*integer*) -- The maximum number of objects
        returned per page.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'Items': [
                 {
                     'LayoutDefinitionName': 'string',
                     'Description': 'string',
                     'DisplayName': 'string',
                     'IsDefault': True|False,
                     'LayoutType': 'PROFILE_EXPLORER',
                     'Tags': {
                         'string': 'string'
                     },
                     'CreatedAt': datetime(2015, 1, 1),
                     'LastUpdatedAt': datetime(2015, 1, 1)
                 },
             ],
             'NextToken': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **Items** *(list) --*

          Contains summary information about an EventStream.

          * *(dict) --*

            The layout object that contains LayoutDefinitionName,
            Description, DisplayName, IsDefault, LayoutType, Tags,
            CreatedAt, LastUpdatedAt

            * **LayoutDefinitionName** *(string) --*

              The unique name of the layout.

            * **Description** *(string) --*

              The description of the layout

            * **DisplayName** *(string) --*

              The display name of the layout

            * **IsDefault** *(boolean) --*

              If set to true for a layout, this layout will be used by
              default to view data. If set to false, then layout will
              not be used by default but it can be used to view data
              by explicit selection on UI.

            * **LayoutType** *(string) --*

              The type of layout that can be used to view data under
              customer profiles domain.

            * **Tags** *(dict) --*

              The tags used to organize, track, or control access for
              this resource.

              * *(string) --*

                * *(string) --*

            * **CreatedAt** *(datetime) --*

              The timestamp of when the layout was created.

            * **LastUpdatedAt** *(datetime) --*

              The timestamp of when the layout was most recently
              updated.

        * **NextToken** *(string) --*

          Identifies the next page of results to return.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / update_domain_layout


update_domain_layout
********************

CustomerProfiles.Client.update_domain_layout(**kwargs)

   Updates the layout used to view data for a specific domain. This
   API can only be invoked from the Amazon Connect admin website.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.update_domain_layout(
          DomainName='string',
          LayoutDefinitionName='string',
          Description='string',
          DisplayName='string',
          IsDefault=True|False,
          LayoutType='PROFILE_EXPLORER',
          Layout='string'
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **LayoutDefinitionName** (*string*) --

        **[REQUIRED]**

        The unique name of the layout.

      * **Description** (*string*) -- The description of the layout

      * **DisplayName** (*string*) -- The display name of the layout

      * **IsDefault** (*boolean*) -- If set to true for a layout, this
        layout will be used by default to view data. If set to false,
        then the layout will not be used by default, but it can be
        used to view data by explicitly selecting it in the console.

      * **LayoutType** (*string*) -- The type of layout that can be
        used to view data under a Customer Profiles domain.

      * **Layout** (*string*) -- A customizable layout that can be
        used to view data under a Customer Profiles domain.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'LayoutDefinitionName': 'string',
             'Description': 'string',
             'DisplayName': 'string',
             'IsDefault': True|False,
             'LayoutType': 'PROFILE_EXPLORER',
             'Layout': 'string',
             'Version': 'string',
             'CreatedAt': datetime(2015, 1, 1),
             'LastUpdatedAt': datetime(2015, 1, 1),
             'Tags': {
                 'string': 'string'
             }
         }

      **Response Structure**

      * *(dict) --*

        * **LayoutDefinitionName** *(string) --*

          The unique name of the layout.

        * **Description** *(string) --*

          The description of the layout

        * **DisplayName** *(string) --*

          The display name of the layout

        * **IsDefault** *(boolean) --*

          If set to true for a layout, this layout will be used by
          default to view data. If set to false, then the layout will
          not be used by default, but it can be used to view data by
          explicitly selecting it in the console.

        * **LayoutType** *(string) --*

          The type of layout that can be used to view data under a
          Customer Profiles domain.

        * **Layout** *(string) --*

          A customizable layout that can be used to view data under a
          Customer Profiles domain.

        * **Version** *(string) --*

          The version used to create layout.

        * **CreatedAt** *(datetime) --*

          The timestamp of when the layout was created.

        * **LastUpdatedAt** *(datetime) --*

          The timestamp of when the layout was most recently updated.

        * **Tags** *(dict) --*

          The tags used to organize, track, or control access for this
          resource.

          * *(string) --*

            * *(string) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / delete_segment_definition


delete_segment_definition
*************************

CustomerProfiles.Client.delete_segment_definition(**kwargs)

   Deletes a segment definition from the domain.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.delete_segment_definition(
          DomainName='string',
          SegmentDefinitionName='string'
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **SegmentDefinitionName** (*string*) --

        **[REQUIRED]**

        The unique name of the segment definition.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'Message': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **Message** *(string) --*

          A message that indicates the delete request is done.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"
CustomerProfiles / Client / put_integration


put_integration
***************

CustomerProfiles.Client.put_integration(**kwargs)

   Adds an integration between the service and a third-party service,
   which includes Amazon AppFlow and Amazon Connect.

   An integration can belong to only one domain.

   To add or remove tags on an existing Integration, see TagResource/
   UntagResource.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.put_integration(
          DomainName='string',
          Uri='string',
          ObjectTypeName='string',
          Tags={
              'string': 'string'
          },
          FlowDefinition={
              'Description': 'string',
              'FlowName': 'string',
              'KmsArn': 'string',
              'SourceFlowConfig': {
                  'ConnectorProfileName': 'string',
                  'ConnectorType': 'Salesforce'|'Marketo'|'Zendesk'|'Servicenow'|'S3',
                  'IncrementalPullConfig': {
                      'DatetimeTypeFieldName': 'string'
                  },
                  'SourceConnectorProperties': {
                      'Marketo': {
                          'Object': 'string'
                      },
                      'S3': {
                          'BucketName': 'string',
                          'BucketPrefix': 'string'
                      },
                      'Salesforce': {
                          'Object': 'string',
                          'EnableDynamicFieldUpdate': True|False,
                          'IncludeDeletedRecords': True|False
                      },
                      'ServiceNow': {
                          'Object': 'string'
                      },
                      'Zendesk': {
                          'Object': 'string'
                      }
                  }
              },
              'Tasks': [
                  {
                      'ConnectorOperator': {
                          'Marketo': 'PROJECTION'|'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                          'S3': 'PROJECTION'|'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                          'Salesforce': 'PROJECTION'|'LESS_THAN'|'CONTAINS'|'GREATER_THAN'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                          'ServiceNow': 'PROJECTION'|'CONTAINS'|'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                          'Zendesk': 'PROJECTION'|'GREATER_THAN'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP'
                      },
                      'DestinationField': 'string',
                      'SourceFields': [
                          'string',
                      ],
                      'TaskProperties': {
                          'string': 'string'
                      },
                      'TaskType': 'Arithmetic'|'Filter'|'Map'|'Mask'|'Merge'|'Truncate'|'Validate'
                  },
              ],
              'TriggerConfig': {
                  'TriggerType': 'Scheduled'|'Event'|'OnDemand',
                  'TriggerProperties': {
                      'Scheduled': {
                          'ScheduleExpression': 'string',
                          'DataPullMode': 'Incremental'|'Complete',
                          'ScheduleStartTime': datetime(2015, 1, 1),
                          'ScheduleEndTime': datetime(2015, 1, 1),
                          'Timezone': 'string',
                          'ScheduleOffset': 123,
                          'FirstExecutionFrom': datetime(2015, 1, 1)
                      }
                  }
              }
          },
          ObjectTypeNames={
              'string': 'string'
          },
          RoleArn='string',
          EventTriggerNames=[
              'string',
          ]
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **Uri** (*string*) -- The URI of the S3 bucket or any other
        type of data source.

      * **ObjectTypeName** (*string*) -- The name of the profile
        object type.

      * **Tags** (*dict*) --

        The tags used to organize, track, or control access for this
        resource.

        * *(string) --*

          * *(string) --*

      * **FlowDefinition** (*dict*) --

        The configuration that controls how Customer Profiles
        retrieves data from the source.

        * **Description** *(string) --*

          A description of the flow you want to create.

        * **FlowName** *(string) --* **[REQUIRED]**

          The specified name of the flow. Use underscores (_) or
          hyphens (-) only. Spaces are not allowed.

        * **KmsArn** *(string) --* **[REQUIRED]**

          The Amazon Resource Name of the AWS Key Management Service
          (KMS) key you provide for encryption.

        * **SourceFlowConfig** *(dict) --* **[REQUIRED]**

          The configuration that controls how Customer Profiles
          retrieves data from the source.

          * **ConnectorProfileName** *(string) --*

            The name of the AppFlow connector profile. This name must
            be unique for each connector profile in the AWS account.

          * **ConnectorType** *(string) --* **[REQUIRED]**

            The type of connector, such as Salesforce, Marketo, and so
            on.

          * **IncrementalPullConfig** *(dict) --*

            Defines the configuration for a scheduled incremental data
            pull. If a valid configuration is provided, the fields
            specified in the configuration are used when querying for
            the incremental data pull.

            * **DatetimeTypeFieldName** *(string) --*

              A field that specifies the date time or timestamp field
              as the criteria to use when importing incremental
              records from the source.

          * **SourceConnectorProperties** *(dict) --* **[REQUIRED]**

            Specifies the information that is required to query a
            particular source connector.

            * **Marketo** *(dict) --*

              The properties that are applied when Marketo is being
              used as a source.

              * **Object** *(string) --* **[REQUIRED]**

                The object specified in the Marketo flow source.

            * **S3** *(dict) --*

              The properties that are applied when Amazon S3 is being
              used as the flow source.

              * **BucketName** *(string) --* **[REQUIRED]**

                The Amazon S3 bucket name where the source files are
                stored.

              * **BucketPrefix** *(string) --*

                The object key for the Amazon S3 bucket in which the
                source files are stored.

            * **Salesforce** *(dict) --*

              The properties that are applied when Salesforce is being
              used as a source.

              * **Object** *(string) --* **[REQUIRED]**

                The object specified in the Salesforce flow source.

              * **EnableDynamicFieldUpdate** *(boolean) --*

                The flag that enables dynamic fetching of new
                (recently added) fields in the Salesforce objects
                while running a flow.

              * **IncludeDeletedRecords** *(boolean) --*

                Indicates whether Amazon AppFlow includes deleted
                files in the flow run.

            * **ServiceNow** *(dict) --*

              The properties that are applied when ServiceNow is being
              used as a source.

              * **Object** *(string) --* **[REQUIRED]**

                The object specified in the ServiceNow flow source.

            * **Zendesk** *(dict) --*

              The properties that are applied when using Zendesk as a
              flow source.

              * **Object** *(string) --* **[REQUIRED]**

                The object specified in the Zendesk flow source.

        * **Tasks** *(list) --* **[REQUIRED]**

          A list of tasks that Customer Profiles performs while
          transferring the data in the flow run.

          * *(dict) --*

            A class for modeling different type of tasks. Task
            implementation varies based on the TaskType.

            * **ConnectorOperator** *(dict) --*

              The operation to be performed on the provided source
              fields.

              * **Marketo** *(string) --*

                The operation to be performed on the provided Marketo
                source fields.

              * **S3** *(string) --*

                The operation to be performed on the provided Amazon
                S3 source fields.

              * **Salesforce** *(string) --*

                The operation to be performed on the provided
                Salesforce source fields.

              * **ServiceNow** *(string) --*

                The operation to be performed on the provided
                ServiceNow source fields.

              * **Zendesk** *(string) --*

                The operation to be performed on the provided Zendesk
                source fields.

            * **DestinationField** *(string) --*

              A field in a destination connector, or a field value
              against which Amazon AppFlow validates a source field.

            * **SourceFields** *(list) --* **[REQUIRED]**

              The source fields to which a particular task is applied.

              * *(string) --*

            * **TaskProperties** *(dict) --*

              A map used to store task-related information. The
              service looks for particular information based on the
              TaskType.

              * *(string) --*

                * *(string) --*

            * **TaskType** *(string) --* **[REQUIRED]**

              Specifies the particular task implementation that Amazon
              AppFlow performs.

        * **TriggerConfig** *(dict) --* **[REQUIRED]**

          The trigger settings that determine how and when the flow
          runs.

          * **TriggerType** *(string) --* **[REQUIRED]**

            Specifies the type of flow trigger. It can be OnDemand,
            Scheduled, or Event.

          * **TriggerProperties** *(dict) --*

            Specifies the configuration details of a schedule-
            triggered flow that you define. Currently, these settings
            only apply to the Scheduled trigger type.

            * **Scheduled** *(dict) --*

              Specifies the configuration details of a schedule-
              triggered flow that you define.

              * **ScheduleExpression** *(string) --* **[REQUIRED]**

                The scheduling expression that determines the rate at
                which the schedule will run, for example rate (5
                minutes).

              * **DataPullMode** *(string) --*

                Specifies whether a scheduled flow has an incremental
                data transfer or a complete data transfer for each
                flow run.

              * **ScheduleStartTime** *(datetime) --*

                Specifies the scheduled start time for a scheduled-
                trigger flow.

              * **ScheduleEndTime** *(datetime) --*

                Specifies the scheduled end time for a scheduled-
                trigger flow.

              * **Timezone** *(string) --*

                Specifies the time zone used when referring to the
                date and time of a scheduled-triggered flow, such as
                America/New_York.

              * **ScheduleOffset** *(integer) --*

                Specifies the optional offset that is added to the
                time interval for a schedule-triggered flow.

              * **FirstExecutionFrom** *(datetime) --*

                Specifies the date range for the records to import
                from the connector in the first flow run.

      * **ObjectTypeNames** (*dict*) --

        A map in which each key is an event type from an external
        application such as Segment or Shopify, and each value is an
        "ObjectTypeName" (template) used to ingest the event. It
        supports the following event types: "SegmentIdentify",
        "ShopifyCreateCustomers", "ShopifyUpdateCustomers",
        "ShopifyCreateDraftOrders", "ShopifyUpdateDraftOrders",
        "ShopifyCreateOrders", and "ShopifyUpdatedOrders".

        * *(string) --*

          * *(string) --*

      * **RoleArn** (*string*) -- The Amazon Resource Name (ARN) of
        the IAM role. The Integration uses this role to make Customer
        Profiles requests on your behalf.

      * **EventTriggerNames** (*list*) --

        A list of unique names for active event triggers associated
        with the integration.

        * *(string) --*

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'DomainName': 'string',
             'Uri': 'string',
             'ObjectTypeName': 'string',
             'CreatedAt': datetime(2015, 1, 1),
             'LastUpdatedAt': datetime(2015, 1, 1),
             'Tags': {
                 'string': 'string'
             },
             'ObjectTypeNames': {
                 'string': 'string'
             },
             'WorkflowId': 'string',
             'IsUnstructured': True|False,
             'RoleArn': 'string',
             'EventTriggerNames': [
                 'string',
             ]
         }

      **Response Structure**

      * *(dict) --*

        * **DomainName** *(string) --*

          The unique name of the domain.

        * **Uri** *(string) --*

          The URI of the S3 bucket or any other type of data source.

        * **ObjectTypeName** *(string) --*

          The name of the profile object type.

        * **CreatedAt** *(datetime) --*

          The timestamp of when the domain was created.

        * **LastUpdatedAt** *(datetime) --*

          The timestamp of when the domain was most recently edited.

        * **Tags** *(dict) --*

          The tags used to organize, track, or control access for this
          resource.

          * *(string) --*

            * *(string) --*

        * **ObjectTypeNames** *(dict) --*

          A map in which each key is an event type from an external
          application such as Segment or Shopify, and each value is an
          "ObjectTypeName" (template) used to ingest the event. It
          supports the following event types: "SegmentIdentify",
          "ShopifyCreateCustomers", "ShopifyUpdateCustomers",
          "ShopifyCreateDraftOrders", "ShopifyUpdateDraftOrders",
          "ShopifyCreateOrders", and "ShopifyUpdatedOrders".

          * *(string) --*

            * *(string) --*

        * **WorkflowId** *(string) --*

          Unique identifier for the workflow.

        * **IsUnstructured** *(boolean) --*

          Boolean that shows if the Flow that's associated with the
          Integration is created in Amazon Appflow, or with
          ObjectTypeName equals _unstructured via API/CLI in
          flowDefinition.

        * **RoleArn** *(string) --*

          The Amazon Resource Name (ARN) of the IAM role. The
          Integration uses this role to make Customer Profiles
          requests on your behalf.

        * **EventTriggerNames** *(list) --*

          A list of unique names for active event triggers associated
          with the integration. This list would be empty if no Event
          Trigger is associated with the integration.

          * *(string) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / get_upload_job


get_upload_job
**************

CustomerProfiles.Client.get_upload_job(**kwargs)

   This API retrieves the details of a specific upload job.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.get_upload_job(
          DomainName='string',
          JobId='string'
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain containing the upload job.

      * **JobId** (*string*) --

        **[REQUIRED]**

        The unique identifier of the upload job to retrieve.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'JobId': 'string',
             'DisplayName': 'string',
             'Status': 'CREATED'|'IN_PROGRESS'|'PARTIALLY_SUCCEEDED'|'SUCCEEDED'|'FAILED'|'STOPPED',
             'StatusReason': 'VALIDATION_FAILURE'|'INTERNAL_FAILURE',
             'CreatedAt': datetime(2015, 1, 1),
             'CompletedAt': datetime(2015, 1, 1),
             'Fields': {
                 'string': {
                     'Source': 'string',
                     'Target': 'string',
                     'ContentType': 'STRING'|'NUMBER'|'PHONE_NUMBER'|'EMAIL_ADDRESS'|'NAME'
                 }
             },
             'UniqueKey': 'string',
             'ResultsSummary': {
                 'UpdatedRecords': 123,
                 'CreatedRecords': 123,
                 'FailedRecords': 123
             },
             'DataExpiry': 123
         }

      **Response Structure**

      * *(dict) --*

        * **JobId** *(string) --*

          The unique identifier of the upload job.

        * **DisplayName** *(string) --*

          The unique name of the upload job. Could be a file name to
          identify the upload job.

        * **Status** *(string) --*

          The status describing the status for the upload job. The
          following are Valid Values:

          * **CREATED**: The upload job has been created, but has not
            started processing yet.

          * **IN_PROGRESS**: The upload job is currently in progress,
            ingesting and processing the profile data.

          * **PARTIALLY_SUCCEEDED**: The upload job has successfully
            completed the ingestion and processing of all profile
            data.

          * **SUCCEEDED**: The upload job has successfully completed
            the ingestion and processing of all profile data.

          * **FAILED**: The upload job has failed to complete.

          * **STOPPED**: The upload job has been manually stopped or
            terminated before completion.

        * **StatusReason** *(string) --*

          The reason for the current status of the upload job.
          Possible reasons:

          * **VALIDATION_FAILURE**: The upload job has encountered an
            error or issue and was unable to complete the profile data
            ingestion.

          * **INTERNAL_FAILURE**: Failure caused from service side

        * **CreatedAt** *(datetime) --*

          The timestamp when the upload job was created.

        * **CompletedAt** *(datetime) --*

          The timestamp when the upload job was completed.

        * **Fields** *(dict) --*

          The mapping between CSV Columns and Profile Object
          attributes for the upload job.

          * *(string) --*

            * *(dict) --*

              Represents a field in a ProfileObjectType.

              * **Source** *(string) --*

                A field of a ProfileObject. For example:
                _source.FirstName, where “_source” is a
                ProfileObjectType of a Zendesk user and “FirstName” is
                a field in that ObjectType.

              * **Target** *(string) --*

                The location of the data in the standard ProfileObject
                model. For example: _profile.Address.PostalCode.

              * **ContentType** *(string) --*

                The content type of the field. Used for determining
                equality when searching.

        * **UniqueKey** *(string) --*

          The unique key columns used for de-duping the keys in the
          upload job.

        * **ResultsSummary** *(dict) --*

          The summary of results for the upload job, including the
          number of updated, created, and failed records.

          * **UpdatedRecords** *(integer) --*

            The number of records that were updated during the upload
            job.

          * **CreatedRecords** *(integer) --*

            The number of records that were newly created during the
            upload job.

          * **FailedRecords** *(integer) --*

            The number of records that failed to be processed during
            the upload job.

        * **DataExpiry** *(integer) --*

          The expiry duration for the profiles ingested with the
          upload job.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"
CustomerProfiles / Client / start_upload_job


start_upload_job
****************

CustomerProfiles.Client.start_upload_job(**kwargs)

   This API starts the processing of an upload job to ingest profile
   data.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.start_upload_job(
          DomainName='string',
          JobId='string'
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain containing the upload job to
        start.

      * **JobId** (*string*) --

        **[REQUIRED]**

        The unique identifier of the upload job to start.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {}

      **Response Structure**

      * *(dict) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"
CustomerProfiles / Client / list_event_triggers


list_event_triggers
*******************

CustomerProfiles.Client.list_event_triggers(**kwargs)

   List all Event Triggers under a domain.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_event_triggers(
          DomainName='string',
          NextToken='string',
          MaxResults=123
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **NextToken** (*string*) -- The pagination token to use with
        ListEventTriggers.

      * **MaxResults** (*integer*) -- The maximum number of results to
        return per page.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'Items': [
                 {
                     'ObjectTypeName': 'string',
                     'EventTriggerName': 'string',
                     'Description': 'string',
                     'CreatedAt': datetime(2015, 1, 1),
                     'LastUpdatedAt': datetime(2015, 1, 1),
                     'Tags': {
                         'string': 'string'
                     }
                 },
             ],
             'NextToken': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **Items** *(list) --*

          The list of Event Triggers.

          * *(dict) --*

            The summary of the event trigger.

            * **ObjectTypeName** *(string) --*

              The unique name of the object type.

            * **EventTriggerName** *(string) --*

              The unique name of the event trigger.

            * **Description** *(string) --*

              The description of the event trigger.

            * **CreatedAt** *(datetime) --*

              The timestamp of when the event trigger was created.

            * **LastUpdatedAt** *(datetime) --*

              The timestamp of when the event trigger was most
              recently updated.

            * **Tags** *(dict) --*

              An array of key-value pairs to apply to this resource.

              * *(string) --*

                * *(string) --*

        * **NextToken** *(string) --*

          The pagination token from the previous call to
          ListEventTriggers.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / delete_profile_key


delete_profile_key
******************

CustomerProfiles.Client.delete_profile_key(**kwargs)

   Removes a searchable key from a customer profile.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.delete_profile_key(
          ProfileId='string',
          KeyName='string',
          Values=[
              'string',
          ],
          DomainName='string'
      )

   Parameters:
      * **ProfileId** (*string*) --

        **[REQUIRED]**

        The unique identifier of a customer profile.

      * **KeyName** (*string*) --

        **[REQUIRED]**

        A searchable identifier of a customer profile.

      * **Values** (*list*) --

        **[REQUIRED]**

        A list of key values.

        * *(string) --*

      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'Message': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **Message** *(string) --*

          A message that indicates the delete request is done.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / delete_calculated_attribute_definition


delete_calculated_attribute_definition
**************************************

CustomerProfiles.Client.delete_calculated_attribute_definition(**kwargs)

   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
   recreate it on your own using the
   CreateCalculatedAttributeDefinition API if you want it back.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.delete_calculated_attribute_definition(
          DomainName='string',
          CalculatedAttributeName='string'
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **CalculatedAttributeName** (*string*) --

        **[REQUIRED]**

        The unique name of the calculated attribute.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {}

      **Response Structure**

      * *(dict) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / get_upload_job_path


get_upload_job_path
*******************

CustomerProfiles.Client.get_upload_job_path(**kwargs)

   This API retrieves the pre-signed URL and client token for
   uploading the file associated with the upload job.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.get_upload_job_path(
          DomainName='string',
          JobId='string'
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain containing the upload job.

      * **JobId** (*string*) --

        **[REQUIRED]**

        The unique identifier of the upload job to retrieve the upload
        path for. This is generated from the CreateUploadJob API.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'Url': 'string',
             'ClientToken': 'string',
             'ValidUntil': datetime(2015, 1, 1)
         }

      **Response Structure**

      * *(dict) --*

        * **Url** *(string) --*

          The pre-signed S3 URL for uploading the CSV file associated
          with the upload job.

        * **ClientToken** *(string) --*

          The plaintext data key used to encrypt the upload file.

          To persist to the pre-signed url, use the client token and
          MD5 client token as header. The required headers are as
          follows:

          * x-amz-server-side-encryption-customer-key: Client Token

          * x-amz-server-side-encryption-customer-key-MD5: MD5 Client
            Token

          * x-amz-server-side-encryption-customer-algorithm: AES256

        * **ValidUntil** *(datetime) --*

          The expiry timestamp for the pre-signed URL, after which the
          URL will no longer be valid.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"
CustomerProfiles / Client / delete_domain_layout


delete_domain_layout
********************

CustomerProfiles.Client.delete_domain_layout(**kwargs)

   Deletes the layout used to view data for a specific domain. This
   API can only be invoked from the Amazon Connect admin website.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.delete_domain_layout(
          DomainName='string',
          LayoutDefinitionName='string'
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **LayoutDefinitionName** (*string*) --

        **[REQUIRED]**

        The unique name of the layout.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'Message': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **Message** *(string) --*

          A message that indicates the delete request is done.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / create_profile


create_profile
**************

CustomerProfiles.Client.create_profile(**kwargs)

   Creates a standard profile.

   A standard profile represents the following attributes for a
   customer profile in a domain.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.create_profile(
          DomainName='string',
          AccountNumber='string',
          AdditionalInformation='string',
          PartyType='INDIVIDUAL'|'BUSINESS'|'OTHER',
          BusinessName='string',
          FirstName='string',
          MiddleName='string',
          LastName='string',
          BirthDate='string',
          Gender='MALE'|'FEMALE'|'UNSPECIFIED',
          PhoneNumber='string',
          MobilePhoneNumber='string',
          HomePhoneNumber='string',
          BusinessPhoneNumber='string',
          EmailAddress='string',
          PersonalEmailAddress='string',
          BusinessEmailAddress='string',
          Address={
              'Address1': 'string',
              'Address2': 'string',
              'Address3': 'string',
              'Address4': 'string',
              'City': 'string',
              'County': 'string',
              'State': 'string',
              'Province': 'string',
              'Country': 'string',
              'PostalCode': 'string'
          },
          ShippingAddress={
              'Address1': 'string',
              'Address2': 'string',
              'Address3': 'string',
              'Address4': 'string',
              'City': 'string',
              'County': 'string',
              'State': 'string',
              'Province': 'string',
              'Country': 'string',
              'PostalCode': 'string'
          },
          MailingAddress={
              'Address1': 'string',
              'Address2': 'string',
              'Address3': 'string',
              'Address4': 'string',
              'City': 'string',
              'County': 'string',
              'State': 'string',
              'Province': 'string',
              'Country': 'string',
              'PostalCode': 'string'
          },
          BillingAddress={
              'Address1': 'string',
              'Address2': 'string',
              'Address3': 'string',
              'Address4': 'string',
              'City': 'string',
              'County': 'string',
              'State': 'string',
              'Province': 'string',
              'Country': 'string',
              'PostalCode': 'string'
          },
          Attributes={
              'string': 'string'
          },
          PartyTypeString='string',
          GenderString='string',
          ProfileType='ACCOUNT_PROFILE'|'PROFILE',
          EngagementPreferences={
              'Phone': [
                  {
                      'KeyName': 'string',
                      'KeyValue': 'string',
                      'ProfileId': 'string',
                      'ContactType': 'PhoneNumber'|'MobilePhoneNumber'|'HomePhoneNumber'|'BusinessPhoneNumber'|'EmailAddress'|'PersonalEmailAddress'|'BusinessEmailAddress'
                  },
              ],
              'Email': [
                  {
                      'KeyName': 'string',
                      'KeyValue': 'string',
                      'ProfileId': 'string',
                      'ContactType': 'PhoneNumber'|'MobilePhoneNumber'|'HomePhoneNumber'|'BusinessPhoneNumber'|'EmailAddress'|'PersonalEmailAddress'|'BusinessEmailAddress'
                  },
              ]
          }
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **AccountNumber** (*string*) -- An account number that you
        have assigned to the customer.

      * **AdditionalInformation** (*string*) -- Any additional
        information relevant to the customer’s profile.

      * **PartyType** (*string*) -- The type of profile used to
        describe the customer.

      * **BusinessName** (*string*) -- The name of the customer’s
        business.

      * **FirstName** (*string*) -- The customer’s first name.

      * **MiddleName** (*string*) -- The customer’s middle name.

      * **LastName** (*string*) -- The customer’s last name.

      * **BirthDate** (*string*) -- The customer’s birth date.

      * **Gender** (*string*) -- The gender with which the customer
        identifies.

      * **PhoneNumber** (*string*) -- The customer’s phone number,
        which has not been specified as a mobile, home, or business
        number.

      * **MobilePhoneNumber** (*string*) -- The customer’s mobile
        phone number.

      * **HomePhoneNumber** (*string*) -- The customer’s home phone
        number.

      * **BusinessPhoneNumber** (*string*) -- The customer’s business
        phone number.

      * **EmailAddress** (*string*) -- The customer’s email address,
        which has not been specified as a personal or business
        address.

      * **PersonalEmailAddress** (*string*) -- The customer’s personal
        email address.

      * **BusinessEmailAddress** (*string*) -- The customer’s business
        email address.

      * **Address** (*dict*) --

        A generic address associated with the customer that is not
        mailing, shipping, or billing.

        * **Address1** *(string) --*

          The first line of a customer address.

        * **Address2** *(string) --*

          The second line of a customer address.

        * **Address3** *(string) --*

          The third line of a customer address.

        * **Address4** *(string) --*

          The fourth line of a customer address.

        * **City** *(string) --*

          The city in which a customer lives.

        * **County** *(string) --*

          The county in which a customer lives.

        * **State** *(string) --*

          The state in which a customer lives.

        * **Province** *(string) --*

          The province in which a customer lives.

        * **Country** *(string) --*

          The country in which a customer lives.

        * **PostalCode** *(string) --*

          The postal code of a customer address.

      * **ShippingAddress** (*dict*) --

        The customer’s shipping address.

        * **Address1** *(string) --*

          The first line of a customer address.

        * **Address2** *(string) --*

          The second line of a customer address.

        * **Address3** *(string) --*

          The third line of a customer address.

        * **Address4** *(string) --*

          The fourth line of a customer address.

        * **City** *(string) --*

          The city in which a customer lives.

        * **County** *(string) --*

          The county in which a customer lives.

        * **State** *(string) --*

          The state in which a customer lives.

        * **Province** *(string) --*

          The province in which a customer lives.

        * **Country** *(string) --*

          The country in which a customer lives.

        * **PostalCode** *(string) --*

          The postal code of a customer address.

      * **MailingAddress** (*dict*) --

        The customer’s mailing address.

        * **Address1** *(string) --*

          The first line of a customer address.

        * **Address2** *(string) --*

          The second line of a customer address.

        * **Address3** *(string) --*

          The third line of a customer address.

        * **Address4** *(string) --*

          The fourth line of a customer address.

        * **City** *(string) --*

          The city in which a customer lives.

        * **County** *(string) --*

          The county in which a customer lives.

        * **State** *(string) --*

          The state in which a customer lives.

        * **Province** *(string) --*

          The province in which a customer lives.

        * **Country** *(string) --*

          The country in which a customer lives.

        * **PostalCode** *(string) --*

          The postal code of a customer address.

      * **BillingAddress** (*dict*) --

        The customer’s billing address.

        * **Address1** *(string) --*

          The first line of a customer address.

        * **Address2** *(string) --*

          The second line of a customer address.

        * **Address3** *(string) --*

          The third line of a customer address.

        * **Address4** *(string) --*

          The fourth line of a customer address.

        * **City** *(string) --*

          The city in which a customer lives.

        * **County** *(string) --*

          The county in which a customer lives.

        * **State** *(string) --*

          The state in which a customer lives.

        * **Province** *(string) --*

          The province in which a customer lives.

        * **Country** *(string) --*

          The country in which a customer lives.

        * **PostalCode** *(string) --*

          The postal code of a customer address.

      * **Attributes** (*dict*) --

        A key value pair of attributes of a customer profile.

        * *(string) --*

          * *(string) --*

      * **PartyTypeString** (*string*) -- An alternative to
        "PartyType" which accepts any string as input.

      * **GenderString** (*string*) -- An alternative to "Gender"
        which accepts any string as input.

      * **ProfileType** (*string*) -- The type of the profile.

      * **EngagementPreferences** (*dict*) --

        Object that defines the preferred methods of engagement, per
        channel.

        * **Phone** *(list) --*

          A list of phone-related contact preferences

          * *(dict) --*

            Object that defines users contact preference.

            * **KeyName** *(string) --*

              A searchable, unique identifier of a customer profile.

            * **KeyValue** *(string) --*

              The key value used to look up profile based off the
              keyName.

            * **ProfileId** *(string) --*

              The unique identifier of a customer profile.

            * **ContactType** *(string) --*

              The contact type used for engagement. For example:
              HomePhoneNumber, PersonalEmailAddress.

        * **Email** *(list) --*

          A list of email-related contact preferences

          * *(dict) --*

            Object that defines users contact preference.

            * **KeyName** *(string) --*

              A searchable, unique identifier of a customer profile.

            * **KeyValue** *(string) --*

              The key value used to look up profile based off the
              keyName.

            * **ProfileId** *(string) --*

              The unique identifier of a customer profile.

            * **ContactType** *(string) --*

              The contact type used for engagement. For example:
              HomePhoneNumber, PersonalEmailAddress.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'ProfileId': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **ProfileId** *(string) --*

          The unique identifier of a customer profile.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / close


close
*****

CustomerProfiles.Client.close()

   Closes underlying endpoint connections.
CustomerProfiles / Client / delete_profile


delete_profile
**************

CustomerProfiles.Client.delete_profile(**kwargs)

   Deletes the standard customer profile and all data pertaining to
   the profile.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.delete_profile(
          ProfileId='string',
          DomainName='string'
      )

   Parameters:
      * **ProfileId** (*string*) --

        **[REQUIRED]**

        The unique identifier of a customer profile.

      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'Message': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **Message** *(string) --*

          A message that indicates the delete request is done.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / get_identity_resolution_job


get_identity_resolution_job
***************************

CustomerProfiles.Client.get_identity_resolution_job(**kwargs)

   Returns information about an Identity Resolution Job in a specific
   domain.

   Identity Resolution Jobs are set up using the Amazon Connect admin
   console. For more information, see Use Identity Resolution to
   consolidate similar profiles.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.get_identity_resolution_job(
          DomainName='string',
          JobId='string'
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **JobId** (*string*) --

        **[REQUIRED]**

        The unique identifier of the Identity Resolution Job.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'DomainName': 'string',
             'JobId': 'string',
             'Status': 'PENDING'|'PREPROCESSING'|'FIND_MATCHING'|'MERGING'|'COMPLETED'|'PARTIAL_SUCCESS'|'FAILED',
             'Message': 'string',
             'JobStartTime': datetime(2015, 1, 1),
             'JobEndTime': datetime(2015, 1, 1),
             'LastUpdatedAt': datetime(2015, 1, 1),
             'JobExpirationTime': datetime(2015, 1, 1),
             'AutoMerging': {
                 'Enabled': True|False,
                 'Consolidation': {
                     'MatchingAttributesList': [
                         [
                             'string',
                         ],
                     ]
                 },
                 'ConflictResolution': {
                     'ConflictResolvingModel': 'RECENCY'|'SOURCE',
                     'SourceName': 'string'
                 },
                 'MinAllowedConfidenceScoreForMerging': 123.0
             },
             'ExportingLocation': {
                 'S3Exporting': {
                     'S3BucketName': 'string',
                     'S3KeyName': 'string'
                 }
             },
             'JobStats': {
                 'NumberOfProfilesReviewed': 123,
                 'NumberOfMatchesFound': 123,
                 'NumberOfMergesDone': 123
             }
         }

      **Response Structure**

      * *(dict) --*

        * **DomainName** *(string) --*

          The unique name of the domain.

        * **JobId** *(string) --*

          The unique identifier of the Identity Resolution Job.

        * **Status** *(string) --*

          The status of the Identity Resolution Job.

          * "PENDING": The Identity Resolution Job is scheduled but
            has not started yet. If you turn off the Identity
            Resolution feature in your domain, jobs in the "PENDING"
            state are deleted.

          * "PREPROCESSING": The Identity Resolution Job is loading
            your data.

          * "FIND_MATCHING": The Identity Resolution Job is using the
            machine learning model to identify profiles that belong to
            the same matching group.

          * "MERGING": The Identity Resolution Job is merging
            duplicate profiles.

          * "COMPLETED": The Identity Resolution Job completed
            successfully.

          * "PARTIAL_SUCCESS": There's a system error and not all of
            the data is merged. The Identity Resolution Job writes a
            message indicating the source of the problem.

          * "FAILED": The Identity Resolution Job did not merge any
            data. It writes a message indicating the source of the
            problem.

        * **Message** *(string) --*

          The error messages that are generated when the Identity
          Resolution Job runs.

        * **JobStartTime** *(datetime) --*

          The timestamp of when the Identity Resolution Job was
          started or will be started.

        * **JobEndTime** *(datetime) --*

          The timestamp of when the Identity Resolution Job was
          completed.

        * **LastUpdatedAt** *(datetime) --*

          The timestamp of when the Identity Resolution Job was most
          recently edited.

        * **JobExpirationTime** *(datetime) --*

          The timestamp of when the Identity Resolution Job will
          expire.

        * **AutoMerging** *(dict) --*

          Configuration settings for how to perform the auto-merging
          of profiles.

          * **Enabled** *(boolean) --*

            The flag that enables the auto-merging of duplicate
            profiles.

          * **Consolidation** *(dict) --*

            A list of matching attributes that represent matching
            criteria. If two profiles meet at least one of the
            requirements in the matching attributes list, they will be
            merged.

            * **MatchingAttributesList** *(list) --*

              A list of matching criteria.

              * *(list) --*

                * *(string) --*

          * **ConflictResolution** *(dict) --*

            How the auto-merging process should resolve conflicts
            between different profiles. For example, if Profile A and
            Profile B have the same "FirstName" and "LastName" (and
            that is the matching criteria), which "EmailAddress"
            should be used?

            * **ConflictResolvingModel** *(string) --*

              How the auto-merging process should resolve conflicts
              between different profiles.

              * "RECENCY": Uses the data that was most recently
                updated.

              * "SOURCE": Uses the data from a specific source. For
                example, if a company has been aquired or two
                departments have merged, data from the specified
                source is used. If two duplicate profiles are from the
                same source, then "RECENCY" is used again.

            * **SourceName** *(string) --*

              The "ObjectType" name that is used to resolve profile
              merging conflicts when choosing "SOURCE" as the
              "ConflictResolvingModel".

          * **MinAllowedConfidenceScoreForMerging** *(float) --*

            A number between 0 and 1 that represents the minimum
            confidence score required for profiles within a matching
            group to be merged during the auto-merge process. A higher
            score means higher similarity required to merge profiles.

        * **ExportingLocation** *(dict) --*

          The S3 location where the Identity Resolution Job writes
          result files.

          * **S3Exporting** *(dict) --*

            Information about the S3 location where Identity
            Resolution Jobs write result files.

            * **S3BucketName** *(string) --*

              The name of the S3 bucket name where Identity Resolution
              Jobs write result files.

            * **S3KeyName** *(string) --*

              The S3 key name of the location where Identity
              Resolution Jobs write result files.

        * **JobStats** *(dict) --*

          Statistics about the Identity Resolution Job.

          * **NumberOfProfilesReviewed** *(integer) --*

            The number of profiles reviewed.

          * **NumberOfMatchesFound** *(integer) --*

            The number of matches found.

          * **NumberOfMergesDone** *(integer) --*

            The number of merges completed.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / list_profile_object_type_templates


list_profile_object_type_templates
**********************************

CustomerProfiles.Client.list_profile_object_type_templates(**kwargs)

   Lists all of the template information for object types.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_profile_object_type_templates(
          NextToken='string',
          MaxResults=123
      )

   Parameters:
      * **NextToken** (*string*) -- The pagination token from the
        previous ListObjectTypeTemplates API call.

      * **MaxResults** (*integer*) -- The maximum number of objects
        returned per page.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'Items': [
                 {
                     'TemplateId': 'string',
                     'SourceName': 'string',
                     'SourceObject': 'string'
                 },
             ],
             'NextToken': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **Items** *(list) --*

          The list of ListProfileObjectType template instances.

          * *(dict) --*

            A ProfileObjectTypeTemplate in a list of
            ProfileObjectTypeTemplates.

            * **TemplateId** *(string) --*

              A unique identifier for the object template.

            * **SourceName** *(string) --*

              The name of the source of the object template.

            * **SourceObject** *(string) --*

              The source of the object template.

        * **NextToken** *(string) --*

          The pagination token from the previous
          ListObjectTypeTemplates API call.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / create_integration_workflow


create_integration_workflow
***************************

CustomerProfiles.Client.create_integration_workflow(**kwargs)

   Creates an integration workflow. An integration workflow is an
   async process which ingests historic data and sets up an
   integration for ongoing updates. The supported Amazon AppFlow
   sources are Salesforce, ServiceNow, and Marketo.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.create_integration_workflow(
          DomainName='string',
          WorkflowType='APPFLOW_INTEGRATION',
          IntegrationConfig={
              'AppflowIntegration': {
                  'FlowDefinition': {
                      'Description': 'string',
                      'FlowName': 'string',
                      'KmsArn': 'string',
                      'SourceFlowConfig': {
                          'ConnectorProfileName': 'string',
                          'ConnectorType': 'Salesforce'|'Marketo'|'Zendesk'|'Servicenow'|'S3',
                          'IncrementalPullConfig': {
                              'DatetimeTypeFieldName': 'string'
                          },
                          'SourceConnectorProperties': {
                              'Marketo': {
                                  'Object': 'string'
                              },
                              'S3': {
                                  'BucketName': 'string',
                                  'BucketPrefix': 'string'
                              },
                              'Salesforce': {
                                  'Object': 'string',
                                  'EnableDynamicFieldUpdate': True|False,
                                  'IncludeDeletedRecords': True|False
                              },
                              'ServiceNow': {
                                  'Object': 'string'
                              },
                              'Zendesk': {
                                  'Object': 'string'
                              }
                          }
                      },
                      'Tasks': [
                          {
                              'ConnectorOperator': {
                                  'Marketo': 'PROJECTION'|'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                                  'S3': 'PROJECTION'|'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                                  'Salesforce': 'PROJECTION'|'LESS_THAN'|'CONTAINS'|'GREATER_THAN'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                                  'ServiceNow': 'PROJECTION'|'CONTAINS'|'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                                  'Zendesk': 'PROJECTION'|'GREATER_THAN'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP'
                              },
                              'DestinationField': 'string',
                              'SourceFields': [
                                  'string',
                              ],
                              'TaskProperties': {
                                  'string': 'string'
                              },
                              'TaskType': 'Arithmetic'|'Filter'|'Map'|'Mask'|'Merge'|'Truncate'|'Validate'
                          },
                      ],
                      'TriggerConfig': {
                          'TriggerType': 'Scheduled'|'Event'|'OnDemand',
                          'TriggerProperties': {
                              'Scheduled': {
                                  'ScheduleExpression': 'string',
                                  'DataPullMode': 'Incremental'|'Complete',
                                  'ScheduleStartTime': datetime(2015, 1, 1),
                                  'ScheduleEndTime': datetime(2015, 1, 1),
                                  'Timezone': 'string',
                                  'ScheduleOffset': 123,
                                  'FirstExecutionFrom': datetime(2015, 1, 1)
                              }
                          }
                      }
                  },
                  'Batches': [
                      {
                          'StartTime': datetime(2015, 1, 1),
                          'EndTime': datetime(2015, 1, 1)
                      },
                  ]
              }
          },
          ObjectTypeName='string',
          RoleArn='string',
          Tags={
              'string': 'string'
          }
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **WorkflowType** (*string*) --

        **[REQUIRED]**

        The type of workflow. The only supported value is
        APPFLOW_INTEGRATION.

      * **IntegrationConfig** (*dict*) --

        **[REQUIRED]**

        Configuration data for integration workflow.

        * **AppflowIntegration** *(dict) --*

          Configuration data for "APPFLOW_INTEGRATION" workflow type.

          * **FlowDefinition** *(dict) --* **[REQUIRED]**

            The configurations that control how Customer Profiles
            retrieves data from the source, Amazon AppFlow. Customer
            Profiles uses this information to create an AppFlow flow
            on behalf of customers.

            * **Description** *(string) --*

              A description of the flow you want to create.

            * **FlowName** *(string) --* **[REQUIRED]**

              The specified name of the flow. Use underscores (_) or
              hyphens (-) only. Spaces are not allowed.

            * **KmsArn** *(string) --* **[REQUIRED]**

              The Amazon Resource Name of the AWS Key Management
              Service (KMS) key you provide for encryption.

            * **SourceFlowConfig** *(dict) --* **[REQUIRED]**

              The configuration that controls how Customer Profiles
              retrieves data from the source.

              * **ConnectorProfileName** *(string) --*

                The name of the AppFlow connector profile. This name
                must be unique for each connector profile in the AWS
                account.

              * **ConnectorType** *(string) --* **[REQUIRED]**

                The type of connector, such as Salesforce, Marketo,
                and so on.

              * **IncrementalPullConfig** *(dict) --*

                Defines the configuration for a scheduled incremental
                data pull. If a valid configuration is provided, the
                fields specified in the configuration are used when
                querying for the incremental data pull.

                * **DatetimeTypeFieldName** *(string) --*

                  A field that specifies the date time or timestamp
                  field as the criteria to use when importing
                  incremental records from the source.

              * **SourceConnectorProperties** *(dict) --*
                **[REQUIRED]**

                Specifies the information that is required to query a
                particular source connector.

                * **Marketo** *(dict) --*

                  The properties that are applied when Marketo is
                  being used as a source.

                  * **Object** *(string) --* **[REQUIRED]**

                    The object specified in the Marketo flow source.

                * **S3** *(dict) --*

                  The properties that are applied when Amazon S3 is
                  being used as the flow source.

                  * **BucketName** *(string) --* **[REQUIRED]**

                    The Amazon S3 bucket name where the source files
                    are stored.

                  * **BucketPrefix** *(string) --*

                    The object key for the Amazon S3 bucket in which
                    the source files are stored.

                * **Salesforce** *(dict) --*

                  The properties that are applied when Salesforce is
                  being used as a source.

                  * **Object** *(string) --* **[REQUIRED]**

                    The object specified in the Salesforce flow
                    source.

                  * **EnableDynamicFieldUpdate** *(boolean) --*

                    The flag that enables dynamic fetching of new
                    (recently added) fields in the Salesforce objects
                    while running a flow.

                  * **IncludeDeletedRecords** *(boolean) --*

                    Indicates whether Amazon AppFlow includes deleted
                    files in the flow run.

                * **ServiceNow** *(dict) --*

                  The properties that are applied when ServiceNow is
                  being used as a source.

                  * **Object** *(string) --* **[REQUIRED]**

                    The object specified in the ServiceNow flow
                    source.

                * **Zendesk** *(dict) --*

                  The properties that are applied when using Zendesk
                  as a flow source.

                  * **Object** *(string) --* **[REQUIRED]**

                    The object specified in the Zendesk flow source.

            * **Tasks** *(list) --* **[REQUIRED]**

              A list of tasks that Customer Profiles performs while
              transferring the data in the flow run.

              * *(dict) --*

                A class for modeling different type of tasks. Task
                implementation varies based on the TaskType.

                * **ConnectorOperator** *(dict) --*

                  The operation to be performed on the provided source
                  fields.

                  * **Marketo** *(string) --*

                    The operation to be performed on the provided
                    Marketo source fields.

                  * **S3** *(string) --*

                    The operation to be performed on the provided
                    Amazon S3 source fields.

                  * **Salesforce** *(string) --*

                    The operation to be performed on the provided
                    Salesforce source fields.

                  * **ServiceNow** *(string) --*

                    The operation to be performed on the provided
                    ServiceNow source fields.

                  * **Zendesk** *(string) --*

                    The operation to be performed on the provided
                    Zendesk source fields.

                * **DestinationField** *(string) --*

                  A field in a destination connector, or a field value
                  against which Amazon AppFlow validates a source
                  field.

                * **SourceFields** *(list) --* **[REQUIRED]**

                  The source fields to which a particular task is
                  applied.

                  * *(string) --*

                * **TaskProperties** *(dict) --*

                  A map used to store task-related information. The
                  service looks for particular information based on
                  the TaskType.

                  * *(string) --*

                    * *(string) --*

                * **TaskType** *(string) --* **[REQUIRED]**

                  Specifies the particular task implementation that
                  Amazon AppFlow performs.

            * **TriggerConfig** *(dict) --* **[REQUIRED]**

              The trigger settings that determine how and when the
              flow runs.

              * **TriggerType** *(string) --* **[REQUIRED]**

                Specifies the type of flow trigger. It can be
                OnDemand, Scheduled, or Event.

              * **TriggerProperties** *(dict) --*

                Specifies the configuration details of a schedule-
                triggered flow that you define. Currently, these
                settings only apply to the Scheduled trigger type.

                * **Scheduled** *(dict) --*

                  Specifies the configuration details of a schedule-
                  triggered flow that you define.

                  * **ScheduleExpression** *(string) --*
                    **[REQUIRED]**

                    The scheduling expression that determines the rate
                    at which the schedule will run, for example rate
                    (5 minutes).

                  * **DataPullMode** *(string) --*

                    Specifies whether a scheduled flow has an
                    incremental data transfer or a complete data
                    transfer for each flow run.

                  * **ScheduleStartTime** *(datetime) --*

                    Specifies the scheduled start time for a
                    scheduled-trigger flow.

                  * **ScheduleEndTime** *(datetime) --*

                    Specifies the scheduled end time for a scheduled-
                    trigger flow.

                  * **Timezone** *(string) --*

                    Specifies the time zone used when referring to the
                    date and time of a scheduled-triggered flow, such
                    as America/New_York.

                  * **ScheduleOffset** *(integer) --*

                    Specifies the optional offset that is added to the
                    time interval for a schedule-triggered flow.

                  * **FirstExecutionFrom** *(datetime) --*

                    Specifies the date range for the records to import
                    from the connector in the first flow run.

          * **Batches** *(list) --*

            Batches in workflow of type "APPFLOW_INTEGRATION".

            * *(dict) --*

              Batch defines the boundaries for ingestion for each step
              in "APPFLOW_INTEGRATION" workflow. "APPFLOW_INTEGRATION"
              workflow splits ingestion based on these boundaries.

              * **StartTime** *(datetime) --* **[REQUIRED]**

                Start time of batch to split ingestion.

              * **EndTime** *(datetime) --* **[REQUIRED]**

                End time of batch to split ingestion.

      * **ObjectTypeName** (*string*) --

        **[REQUIRED]**

        The name of the profile object type.

      * **RoleArn** (*string*) --

        **[REQUIRED]**

        The Amazon Resource Name (ARN) of the IAM role. Customer
        Profiles assumes this role to create resources on your behalf
        as part of workflow execution.

      * **Tags** (*dict*) --

        The tags used to organize, track, or control access for this
        resource.

        * *(string) --*

          * *(string) --*

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'WorkflowId': 'string',
             'Message': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **WorkflowId** *(string) --*

          Unique identifier for the workflow.

        * **Message** *(string) --*

          A message indicating create request was received.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / list_workflows


list_workflows
**************

CustomerProfiles.Client.list_workflows(**kwargs)

   Query to list all workflows.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_workflows(
          DomainName='string',
          WorkflowType='APPFLOW_INTEGRATION',
          Status='NOT_STARTED'|'IN_PROGRESS'|'COMPLETE'|'FAILED'|'SPLIT'|'RETRY'|'CANCELLED',
          QueryStartDate=datetime(2015, 1, 1),
          QueryEndDate=datetime(2015, 1, 1),
          NextToken='string',
          MaxResults=123
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **WorkflowType** (*string*) -- The type of workflow. The only
        supported value is APPFLOW_INTEGRATION.

      * **Status** (*string*) -- Status of workflow execution.

      * **QueryStartDate** (*datetime*) -- Retrieve workflows started
        after timestamp.

      * **QueryEndDate** (*datetime*) -- Retrieve workflows ended
        after timestamp.

      * **NextToken** (*string*) -- 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.

      * **MaxResults** (*integer*) -- The maximum number of results to
        return per page.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'Items': [
                 {
                     'WorkflowType': 'APPFLOW_INTEGRATION',
                     'WorkflowId': 'string',
                     'Status': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETE'|'FAILED'|'SPLIT'|'RETRY'|'CANCELLED',
                     'StatusDescription': 'string',
                     'CreatedAt': datetime(2015, 1, 1),
                     'LastUpdatedAt': datetime(2015, 1, 1)
                 },
             ],
             'NextToken': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **Items** *(list) --*

          List containing workflow details.

          * *(dict) --*

            A workflow in list of workflows.

            * **WorkflowType** *(string) --*

              The type of workflow. The only supported value is
              APPFLOW_INTEGRATION.

            * **WorkflowId** *(string) --*

              Unique identifier for the workflow.

            * **Status** *(string) --*

              Status of workflow execution.

            * **StatusDescription** *(string) --*

              Description for workflow execution status.

            * **CreatedAt** *(datetime) --*

              Creation timestamp for workflow.

            * **LastUpdatedAt** *(datetime) --*

              Last updated timestamp for workflow.

        * **NextToken** *(string) --*

          If there are additional results, this is the token for the
          next set of results.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / update_profile


update_profile
**************

CustomerProfiles.Client.update_profile(**kwargs)

   Updates the properties of a profile. The ProfileId is required for
   updating a customer profile.

   When calling the UpdateProfile API, specifying an empty string
   value means that any existing value will be removed. Not specifying
   a string value means that any value already there will be kept.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.update_profile(
          DomainName='string',
          ProfileId='string',
          AdditionalInformation='string',
          AccountNumber='string',
          PartyType='INDIVIDUAL'|'BUSINESS'|'OTHER',
          BusinessName='string',
          FirstName='string',
          MiddleName='string',
          LastName='string',
          BirthDate='string',
          Gender='MALE'|'FEMALE'|'UNSPECIFIED',
          PhoneNumber='string',
          MobilePhoneNumber='string',
          HomePhoneNumber='string',
          BusinessPhoneNumber='string',
          EmailAddress='string',
          PersonalEmailAddress='string',
          BusinessEmailAddress='string',
          Address={
              'Address1': 'string',
              'Address2': 'string',
              'Address3': 'string',
              'Address4': 'string',
              'City': 'string',
              'County': 'string',
              'State': 'string',
              'Province': 'string',
              'Country': 'string',
              'PostalCode': 'string'
          },
          ShippingAddress={
              'Address1': 'string',
              'Address2': 'string',
              'Address3': 'string',
              'Address4': 'string',
              'City': 'string',
              'County': 'string',
              'State': 'string',
              'Province': 'string',
              'Country': 'string',
              'PostalCode': 'string'
          },
          MailingAddress={
              'Address1': 'string',
              'Address2': 'string',
              'Address3': 'string',
              'Address4': 'string',
              'City': 'string',
              'County': 'string',
              'State': 'string',
              'Province': 'string',
              'Country': 'string',
              'PostalCode': 'string'
          },
          BillingAddress={
              'Address1': 'string',
              'Address2': 'string',
              'Address3': 'string',
              'Address4': 'string',
              'City': 'string',
              'County': 'string',
              'State': 'string',
              'Province': 'string',
              'Country': 'string',
              'PostalCode': 'string'
          },
          Attributes={
              'string': 'string'
          },
          PartyTypeString='string',
          GenderString='string',
          ProfileType='ACCOUNT_PROFILE'|'PROFILE',
          EngagementPreferences={
              'Phone': [
                  {
                      'KeyName': 'string',
                      'KeyValue': 'string',
                      'ProfileId': 'string',
                      'ContactType': 'PhoneNumber'|'MobilePhoneNumber'|'HomePhoneNumber'|'BusinessPhoneNumber'|'EmailAddress'|'PersonalEmailAddress'|'BusinessEmailAddress'
                  },
              ],
              'Email': [
                  {
                      'KeyName': 'string',
                      'KeyValue': 'string',
                      'ProfileId': 'string',
                      'ContactType': 'PhoneNumber'|'MobilePhoneNumber'|'HomePhoneNumber'|'BusinessPhoneNumber'|'EmailAddress'|'PersonalEmailAddress'|'BusinessEmailAddress'
                  },
              ]
          }
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **ProfileId** (*string*) --

        **[REQUIRED]**

        The unique identifier of a customer profile.

      * **AdditionalInformation** (*string*) -- Any additional
        information relevant to the customer’s profile.

      * **AccountNumber** (*string*) -- An account number that you
        have assigned to the customer.

      * **PartyType** (*string*) -- The type of profile used to
        describe the customer.

      * **BusinessName** (*string*) -- The name of the customer’s
        business.

      * **FirstName** (*string*) -- The customer’s first name.

      * **MiddleName** (*string*) -- The customer’s middle name.

      * **LastName** (*string*) -- The customer’s last name.

      * **BirthDate** (*string*) -- The customer’s birth date.

      * **Gender** (*string*) -- The gender with which the customer
        identifies.

      * **PhoneNumber** (*string*) -- The customer’s phone number,
        which has not been specified as a mobile, home, or business
        number.

      * **MobilePhoneNumber** (*string*) -- The customer’s mobile
        phone number.

      * **HomePhoneNumber** (*string*) -- The customer’s home phone
        number.

      * **BusinessPhoneNumber** (*string*) -- The customer’s business
        phone number.

      * **EmailAddress** (*string*) -- The customer’s email address,
        which has not been specified as a personal or business
        address.

      * **PersonalEmailAddress** (*string*) -- The customer’s personal
        email address.

      * **BusinessEmailAddress** (*string*) -- The customer’s business
        email address.

      * **Address** (*dict*) --

        A generic address associated with the customer that is not
        mailing, shipping, or billing.

        * **Address1** *(string) --*

          The first line of a customer address.

        * **Address2** *(string) --*

          The second line of a customer address.

        * **Address3** *(string) --*

          The third line of a customer address.

        * **Address4** *(string) --*

          The fourth line of a customer address.

        * **City** *(string) --*

          The city in which a customer lives.

        * **County** *(string) --*

          The county in which a customer lives.

        * **State** *(string) --*

          The state in which a customer lives.

        * **Province** *(string) --*

          The province in which a customer lives.

        * **Country** *(string) --*

          The country in which a customer lives.

        * **PostalCode** *(string) --*

          The postal code of a customer address.

      * **ShippingAddress** (*dict*) --

        The customer’s shipping address.

        * **Address1** *(string) --*

          The first line of a customer address.

        * **Address2** *(string) --*

          The second line of a customer address.

        * **Address3** *(string) --*

          The third line of a customer address.

        * **Address4** *(string) --*

          The fourth line of a customer address.

        * **City** *(string) --*

          The city in which a customer lives.

        * **County** *(string) --*

          The county in which a customer lives.

        * **State** *(string) --*

          The state in which a customer lives.

        * **Province** *(string) --*

          The province in which a customer lives.

        * **Country** *(string) --*

          The country in which a customer lives.

        * **PostalCode** *(string) --*

          The postal code of a customer address.

      * **MailingAddress** (*dict*) --

        The customer’s mailing address.

        * **Address1** *(string) --*

          The first line of a customer address.

        * **Address2** *(string) --*

          The second line of a customer address.

        * **Address3** *(string) --*

          The third line of a customer address.

        * **Address4** *(string) --*

          The fourth line of a customer address.

        * **City** *(string) --*

          The city in which a customer lives.

        * **County** *(string) --*

          The county in which a customer lives.

        * **State** *(string) --*

          The state in which a customer lives.

        * **Province** *(string) --*

          The province in which a customer lives.

        * **Country** *(string) --*

          The country in which a customer lives.

        * **PostalCode** *(string) --*

          The postal code of a customer address.

      * **BillingAddress** (*dict*) --

        The customer’s billing address.

        * **Address1** *(string) --*

          The first line of a customer address.

        * **Address2** *(string) --*

          The second line of a customer address.

        * **Address3** *(string) --*

          The third line of a customer address.

        * **Address4** *(string) --*

          The fourth line of a customer address.

        * **City** *(string) --*

          The city in which a customer lives.

        * **County** *(string) --*

          The county in which a customer lives.

        * **State** *(string) --*

          The state in which a customer lives.

        * **Province** *(string) --*

          The province in which a customer lives.

        * **Country** *(string) --*

          The country in which a customer lives.

        * **PostalCode** *(string) --*

          The postal code of a customer address.

      * **Attributes** (*dict*) --

        A key value pair of attributes of a customer profile.

        * *(string) --*

          * *(string) --*

      * **PartyTypeString** (*string*) -- An alternative to
        "PartyType" which accepts any string as input.

      * **GenderString** (*string*) -- An alternative to "Gender"
        which accepts any string as input.

      * **ProfileType** (*string*) -- Determines the type of the
        profile.

      * **EngagementPreferences** (*dict*) --

        Object that defines users preferred methods of engagement.

        * **Phone** *(list) --*

          A list of phone-related contact preferences

          * *(dict) --*

            Object that defines users contact preference.

            * **KeyName** *(string) --*

              A searchable, unique identifier of a customer profile.

            * **KeyValue** *(string) --*

              The key value used to look up profile based off the
              keyName.

            * **ProfileId** *(string) --*

              The unique identifier of a customer profile.

            * **ContactType** *(string) --*

              The contact type used for engagement. For example:
              HomePhoneNumber, PersonalEmailAddress.

        * **Email** *(list) --*

          A list of email-related contact preferences

          * *(dict) --*

            Object that defines users contact preference.

            * **KeyName** *(string) --*

              A searchable, unique identifier of a customer profile.

            * **KeyValue** *(string) --*

              The key value used to look up profile based off the
              keyName.

            * **ProfileId** *(string) --*

              The unique identifier of a customer profile.

            * **ContactType** *(string) --*

              The contact type used for engagement. For example:
              HomePhoneNumber, PersonalEmailAddress.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'ProfileId': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **ProfileId** *(string) --*

          The unique identifier of a customer profile.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / detect_profile_object_type


detect_profile_object_type
**************************

CustomerProfiles.Client.detect_profile_object_type(**kwargs)

   The process of detecting profile object type mapping by using given
   objects.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.detect_profile_object_type(
          Objects=[
              'string',
          ],
          DomainName='string'
      )

   Parameters:
      * **Objects** (*list*) --

        **[REQUIRED]**

        A string that is serialized from a JSON object.

        * *(string) --*

      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'DetectedProfileObjectTypes': [
                 {
                     'SourceLastUpdatedTimestampFormat': 'string',
                     'Fields': {
                         'string': {
                             'Source': 'string',
                             'Target': 'string',
                             'ContentType': 'STRING'|'NUMBER'|'PHONE_NUMBER'|'EMAIL_ADDRESS'|'NAME'
                         }
                     },
                     'Keys': {
                         'string': [
                             {
                                 'StandardIdentifiers': [
                                     'PROFILE'|'ASSET'|'CASE'|'ORDER'|'COMMUNICATION_RECORD'|'AIR_PREFERENCE'|'HOTEL_PREFERENCE'|'AIR_BOOKING'|'AIR_SEGMENT'|'HOTEL_RESERVATION'|'HOTEL_STAY_REVENUE'|'LOYALTY'|'LOYALTY_TRANSACTION'|'LOYALTY_PROMOTION'|'UNIQUE'|'SECONDARY'|'LOOKUP_ONLY'|'NEW_ONLY',
                                 ],
                                 'FieldNames': [
                                     'string',
                                 ]
                             },
                         ]
                     }
                 },
             ]
         }

      **Response Structure**

      * *(dict) --*

        * **DetectedProfileObjectTypes** *(list) --*

          Detected "ProfileObjectType" mappings from given objects. A
          maximum of one mapping is supported.

          * *(dict) --*

            Contains "ProfileObjectType" mapping information from the
            model.

            * **SourceLastUpdatedTimestampFormat** *(string) --*

              The format of "sourceLastUpdatedTimestamp" that was
              detected in fields.

            * **Fields** *(dict) --*

              A map of the name and the "ObjectType" field.

              * *(string) --*

                * *(dict) --*

                  Represents a field in a ProfileObjectType.

                  * **Source** *(string) --*

                    A field of a ProfileObject. For example:
                    _source.FirstName, where “_source” is a
                    ProfileObjectType of a Zendesk user and
                    “FirstName” is a field in that ObjectType.

                  * **Target** *(string) --*

                    The location of the data in the standard
                    ProfileObject model. For example:
                    _profile.Address.PostalCode.

                  * **ContentType** *(string) --*

                    The content type of the field. Used for
                    determining equality when searching.

            * **Keys** *(dict) --*

              A list of unique keys that can be used to map data to a
              profile.

              * *(string) --*

                * *(list) --*

                  * *(dict) --*

                    An object that defines the Key element of a
                    ProfileObject. A Key is a special element that can
                    be used to search for a customer profile.

                    * **StandardIdentifiers** *(list) --*

                      The types of keys that a ProfileObject can have.
                      Each ProfileObject can have only 1 UNIQUE key
                      but multiple PROFILE keys. PROFILE, ASSET, CASE,
                      or ORDER means that this key can be used to tie
                      an object to a PROFILE, ASSET, CASE, or ORDER
                      respectively. UNIQUE means that it can be used
                      to uniquely identify an object. If a key a is
                      marked as SECONDARY, it will be used to search
                      for profiles after all other PROFILE keys have
                      been searched. A LOOKUP_ONLY key is only used to
                      match a profile but is not persisted to be used
                      for searching of the profile. A NEW_ONLY key is
                      only used if the profile does not already exist
                      before the object is ingested, otherwise it is
                      only used for matching objects to profiles.

                      * *(string) --*

                    * **FieldNames** *(list) --*

                      The reference for the key name of the fields
                      map.

                      * *(string) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / create_segment_definition


create_segment_definition
*************************

CustomerProfiles.Client.create_segment_definition(**kwargs)

   Creates a segment definition associated to the given domain.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.create_segment_definition(
          DomainName='string',
          SegmentDefinitionName='string',
          DisplayName='string',
          Description='string',
          SegmentGroups={
              'Groups': [
                  {
                      'Dimensions': [
                          {
                              'ProfileAttributes': {
                                  'AccountNumber': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'AdditionalInformation': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'FirstName': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'LastName': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'MiddleName': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'GenderString': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'PartyTypeString': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'BirthDate': {
                                      'DimensionType': 'BEFORE'|'AFTER'|'BETWEEN'|'NOT_BETWEEN'|'ON',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'PhoneNumber': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'BusinessName': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'BusinessPhoneNumber': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'HomePhoneNumber': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'MobilePhoneNumber': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'EmailAddress': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'PersonalEmailAddress': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'BusinessEmailAddress': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                      'Values': [
                                          'string',
                                      ]
                                  },
                                  'Address': {
                                      'City': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'Country': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'County': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'PostalCode': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'Province': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'State': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      }
                                  },
                                  'ShippingAddress': {
                                      'City': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'Country': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'County': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'PostalCode': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'Province': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'State': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      }
                                  },
                                  'MailingAddress': {
                                      'City': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'Country': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'County': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'PostalCode': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'Province': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'State': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      }
                                  },
                                  'BillingAddress': {
                                      'City': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'Country': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'County': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'PostalCode': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'Province': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      },
                                      'State': {
                                          'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
                                          'Values': [
                                              'string',
                                          ]
                                      }
                                  },
                                  'Attributes': {
                                      'string': {
                                          'DimensionType': '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': [
                                              'string',
                                          ]
                                      }
                                  },
                                  'ProfileType': {
                                      'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                      'Values': [
                                          'ACCOUNT_PROFILE'|'PROFILE',
                                      ]
                                  }
                              },
                              'CalculatedAttributes': {
                                  'string': {
                                      'DimensionType': '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': [
                                          'string',
                                      ],
                                      'ConditionOverrides': {
                                          'Range': {
                                              'Start': 123,
                                              'End': 123,
                                              'Unit': 'DAYS'
                                          }
                                      }
                                  }
                              }
                          },
                      ],
                      'SourceSegments': [
                          {
                              'SegmentDefinitionName': 'string'
                          },
                      ],
                      'SourceType': 'ALL'|'ANY'|'NONE',
                      'Type': 'ALL'|'ANY'|'NONE'
                  },
              ],
              'Include': 'ALL'|'ANY'|'NONE'
          },
          Tags={
              'string': 'string'
          }
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **SegmentDefinitionName** (*string*) --

        **[REQUIRED]**

        The unique name of the segment definition.

      * **DisplayName** (*string*) --

        **[REQUIRED]**

        The display name of the segment definition.

      * **Description** (*string*) -- The description of the segment
        definition.

      * **SegmentGroups** (*dict*) --

        **[REQUIRED]**

        Specifies the base segments and dimensions for a segment
        definition along with their respective relationship.

        * **Groups** *(list) --*

          Holds the list of groups within the segment definition.

          * *(dict) --*

            Contains dimensions that determine what to segment on.

            * **Dimensions** *(list) --*

              Defines the attributes to segment on.

              * *(dict) --*

                Object that holds what profile and calculated
                attributes to segment on.

                Note:

                  This is a Tagged Union structure. Only one of the
                  following top level keys can be set:
                  "ProfileAttributes", "CalculatedAttributes".

                * **ProfileAttributes** *(dict) --*

                  Object that holds the profile attributes to segment
                  on.

                  * **AccountNumber** *(dict) --*

                    A field to describe values to segment on within
                    account number.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment on.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **AdditionalInformation** *(dict) --*

                    A field to describe values to segment on within
                    additional information.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment with.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **FirstName** *(dict) --*

                    A field to describe values to segment on within
                    first name.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment on.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **LastName** *(dict) --*

                    A field to describe values to segment on within
                    last name.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment on.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **MiddleName** *(dict) --*

                    A field to describe values to segment on within
                    middle name.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment on.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **GenderString** *(dict) --*

                    A field to describe values to segment on within
                    genderString.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment on.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **PartyTypeString** *(dict) --*

                    A field to describe values to segment on within
                    partyTypeString.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment on.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **BirthDate** *(dict) --*

                    A field to describe values to segment on within
                    birthDate.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment with.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **PhoneNumber** *(dict) --*

                    A field to describe values to segment on within
                    phone number.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment on.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **BusinessName** *(dict) --*

                    A field to describe values to segment on within
                    business name.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment on.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **BusinessPhoneNumber** *(dict) --*

                    A field to describe values to segment on within
                    business phone number.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment on.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **HomePhoneNumber** *(dict) --*

                    A field to describe values to segment on within
                    home phone number.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment on.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **MobilePhoneNumber** *(dict) --*

                    A field to describe values to segment on within
                    mobile phone number.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment on.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **EmailAddress** *(dict) --*

                    A field to describe values to segment on within
                    email address.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment on.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **PersonalEmailAddress** *(dict) --*

                    A field to describe values to segment on within
                    personal email address.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment on.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **BusinessEmailAddress** *(dict) --*

                    A field to describe values to segment on within
                    business email address.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment on.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                  * **Address** *(dict) --*

                    A field to describe values to segment on within
                    address.

                    * **City** *(dict) --*

                      The city belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **Country** *(dict) --*

                      The country belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **County** *(dict) --*

                      The county belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **PostalCode** *(dict) --*

                      The postal code belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **Province** *(dict) --*

                      The province belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **State** *(dict) --*

                      The state belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                  * **ShippingAddress** *(dict) --*

                    A field to describe values to segment on within
                    shipping address.

                    * **City** *(dict) --*

                      The city belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **Country** *(dict) --*

                      The country belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **County** *(dict) --*

                      The county belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **PostalCode** *(dict) --*

                      The postal code belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **Province** *(dict) --*

                      The province belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **State** *(dict) --*

                      The state belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                  * **MailingAddress** *(dict) --*

                    A field to describe values to segment on within
                    mailing address.

                    * **City** *(dict) --*

                      The city belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **Country** *(dict) --*

                      The country belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **County** *(dict) --*

                      The county belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **PostalCode** *(dict) --*

                      The postal code belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **Province** *(dict) --*

                      The province belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **State** *(dict) --*

                      The state belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                  * **BillingAddress** *(dict) --*

                    A field to describe values to segment on within
                    billing address.

                    * **City** *(dict) --*

                      The city belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **Country** *(dict) --*

                      The country belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **County** *(dict) --*

                      The county belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **PostalCode** *(dict) --*

                      The postal code belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **Province** *(dict) --*

                      The province belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                    * **State** *(dict) --*

                      The state belonging to the address.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment on.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

                  * **Attributes** *(dict) --*

                    A field to describe values to segment on within
                    attributes.

                    * *(string) --*

                      * *(dict) --*

                        Object that segments on various Customer
                        Profile's fields.

                        * **DimensionType** *(string) --*
                          **[REQUIRED]**

                          The action to segment with.

                        * **Values** *(list) --* **[REQUIRED]**

                          The values to apply the DimensionType on.

                          * *(string) --*

                  * **ProfileType** *(dict) --*

                    A field to describe values to segment on within
                    profile type.

                    * **DimensionType** *(string) --* **[REQUIRED]**

                      The action to segment on.

                    * **Values** *(list) --* **[REQUIRED]**

                      The values to apply the DimensionType on.

                      * *(string) --*

                * **CalculatedAttributes** *(dict) --*

                  Object that holds the calculated attributes to
                  segment on.

                  * *(string) --*

                    * *(dict) --*

                      Object that segments on Customer Profile's
                      Calculated Attributes.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to segment with.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType with.

                        * *(string) --*

                      * **ConditionOverrides** *(dict) --*

                        Applies the given condition over the initial
                        Calculated Attribute's definition.

                        * **Range** *(dict) --*

                          The relative time period over which data is
                          included in the aggregation for this
                          override.

                          * **Start** *(integer) --* **[REQUIRED]**

                            The start time of when to include objects.

                          * **End** *(integer) --*

                            The end time of when to include objects.

                          * **Unit** *(string) --* **[REQUIRED]**

                            The unit for start and end.

            * **SourceSegments** *(list) --*

              Defines the starting source of data.

              * *(dict) --*

                The source segments to build off of.

                * **SegmentDefinitionName** *(string) --*

                  The unique name of the segment definition.

            * **SourceType** *(string) --*

              Defines how to interact with the source data.

            * **Type** *(string) --*

              Defines how to interact with the profiles found in the
              current filtering.

        * **Include** *(string) --*

          Defines whether to include or exclude the profiles that fit
          the segment criteria.

      * **Tags** (*dict*) --

        The tags used to organize, track, or control access for this
        resource.

        * *(string) --*

          * *(string) --*

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'SegmentDefinitionName': 'string',
             'DisplayName': 'string',
             'Description': 'string',
             'CreatedAt': datetime(2015, 1, 1),
             'SegmentDefinitionArn': 'string',
             'Tags': {
                 'string': 'string'
             }
         }

      **Response Structure**

      * *(dict) --*

        * **SegmentDefinitionName** *(string) --*

          The name of the segment definition.

        * **DisplayName** *(string) --*

          The display name of the segment definition.

        * **Description** *(string) --*

          The description of the segment definition.

        * **CreatedAt** *(datetime) --*

          The timestamp of when the segment definition was created.

        * **SegmentDefinitionArn** *(string) --*

          The arn of the segment definition.

        * **Tags** *(dict) --*

          The tags used to organize, track, or control access for this
          resource.

          * *(string) --*

            * *(string) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"
CustomerProfiles / Client / get_event_stream


get_event_stream
****************

CustomerProfiles.Client.get_event_stream(**kwargs)

   Returns information about the specified event stream in a specific
   domain.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.get_event_stream(
          DomainName='string',
          EventStreamName='string'
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **EventStreamName** (*string*) --

        **[REQUIRED]**

        The name of the event stream provided during create
        operations.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'DomainName': 'string',
             'EventStreamArn': 'string',
             'CreatedAt': datetime(2015, 1, 1),
             'State': 'RUNNING'|'STOPPED',
             'StoppedSince': datetime(2015, 1, 1),
             'DestinationDetails': {
                 'Uri': 'string',
                 'Status': 'HEALTHY'|'UNHEALTHY',
                 'UnhealthySince': datetime(2015, 1, 1),
                 'Message': 'string'
             },
             'Tags': {
                 'string': 'string'
             }
         }

      **Response Structure**

      * *(dict) --*

        * **DomainName** *(string) --*

          The unique name of the domain.

        * **EventStreamArn** *(string) --*

          A unique identifier for the event stream.

        * **CreatedAt** *(datetime) --*

          The timestamp of when the export was created.

        * **State** *(string) --*

          The operational state of destination stream for export.

        * **StoppedSince** *(datetime) --*

          The timestamp when the "State" changed to "STOPPED".

        * **DestinationDetails** *(dict) --*

          Details regarding the Kinesis stream.

          * **Uri** *(string) --*

            The StreamARN of the destination to deliver profile events
            to. For example, arn:aws:kinesis:region:account-id:stream
            /stream-name.

          * **Status** *(string) --*

            The status of enabling the Kinesis stream as a destination
            for export.

          * **UnhealthySince** *(datetime) --*

            The timestamp when the status last changed to "UNHEALHY".

          * **Message** *(string) --*

            The human-readable string that corresponds to the error or
            success while enabling the streaming destination.

        * **Tags** *(dict) --*

          The tags used to organize, track, or control access for this
          resource.

          * *(string) --*

            * *(string) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / stop_upload_job


stop_upload_job
***************

CustomerProfiles.Client.stop_upload_job(**kwargs)

   This API stops the processing of an upload job.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.stop_upload_job(
          DomainName='string',
          JobId='string'
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain containing the upload job to
        stop.

      * **JobId** (*string*) --

        **[REQUIRED]**

        The unique identifier of the upload job to stop.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {}

      **Response Structure**

      * *(dict) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"
CustomerProfiles / Client / create_upload_job


create_upload_job
*****************

CustomerProfiles.Client.create_upload_job(**kwargs)

   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.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.create_upload_job(
          DomainName='string',
          DisplayName='string',
          Fields={
              'string': {
                  'Source': 'string',
                  'Target': 'string',
                  'ContentType': 'STRING'|'NUMBER'|'PHONE_NUMBER'|'EMAIL_ADDRESS'|'NAME'
              }
          },
          UniqueKey='string',
          DataExpiry=123
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain. Domain should be exists for the
        upload job to be created.

      * **DisplayName** (*string*) --

        **[REQUIRED]**

        The unique name of the upload job. Could be a file name to
        identify the upload job.

      * **Fields** (*dict*) --

        **[REQUIRED]**

        The mapping between CSV Columns and Profile Object attributes.
        A map of the name and ObjectType field.

        * *(string) --*

          * *(dict) --*

            Represents a field in a ProfileObjectType.

            * **Source** *(string) --*

              A field of a ProfileObject. For example:
              _source.FirstName, where “_source” is a
              ProfileObjectType of a Zendesk user and “FirstName” is a
              field in that ObjectType.

            * **Target** *(string) --*

              The location of the data in the standard ProfileObject
              model. For example: _profile.Address.PostalCode.

            * **ContentType** *(string) --*

              The content type of the field. Used for determining
              equality when searching.

      * **UniqueKey** (*string*) --

        **[REQUIRED]**

        The unique key columns for de-duping the profiles used to map
        data to the profile.

      * **DataExpiry** (*integer*) -- The expiry duration for the
        profiles ingested with the job. If not provided, the system
        default of 2 weeks is used.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'JobId': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **JobId** *(string) --*

          The unique identifier for the created upload job.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"
CustomerProfiles / Client / get_profile_object_type


get_profile_object_type
***********************

CustomerProfiles.Client.get_profile_object_type(**kwargs)

   Returns the object types for a specific domain.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.get_profile_object_type(
          DomainName='string',
          ObjectTypeName='string'
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **ObjectTypeName** (*string*) --

        **[REQUIRED]**

        The name of the profile object type.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'ObjectTypeName': 'string',
             'Description': 'string',
             'TemplateId': 'string',
             'ExpirationDays': 123,
             'EncryptionKey': 'string',
             'AllowProfileCreation': True|False,
             'SourceLastUpdatedTimestampFormat': 'string',
             'MaxAvailableProfileObjectCount': 123,
             'MaxProfileObjectCount': 123,
             'Fields': {
                 'string': {
                     'Source': 'string',
                     'Target': 'string',
                     'ContentType': 'STRING'|'NUMBER'|'PHONE_NUMBER'|'EMAIL_ADDRESS'|'NAME'
                 }
             },
             'Keys': {
                 'string': [
                     {
                         'StandardIdentifiers': [
                             'PROFILE'|'ASSET'|'CASE'|'ORDER'|'COMMUNICATION_RECORD'|'AIR_PREFERENCE'|'HOTEL_PREFERENCE'|'AIR_BOOKING'|'AIR_SEGMENT'|'HOTEL_RESERVATION'|'HOTEL_STAY_REVENUE'|'LOYALTY'|'LOYALTY_TRANSACTION'|'LOYALTY_PROMOTION'|'UNIQUE'|'SECONDARY'|'LOOKUP_ONLY'|'NEW_ONLY',
                         ],
                         'FieldNames': [
                             'string',
                         ]
                     },
                 ]
             },
             'CreatedAt': datetime(2015, 1, 1),
             'LastUpdatedAt': datetime(2015, 1, 1),
             'Tags': {
                 'string': 'string'
             }
         }

      **Response Structure**

      * *(dict) --*

        * **ObjectTypeName** *(string) --*

          The name of the profile object type.

        * **Description** *(string) --*

          The description of the profile object type.

        * **TemplateId** *(string) --*

          A unique identifier for the object template.

        * **ExpirationDays** *(integer) --*

          The number of days until the data in the object expires.

        * **EncryptionKey** *(string) --*

          The customer-provided key to encrypt the profile object that
          will be created in this profile object type.

        * **AllowProfileCreation** *(boolean) --*

          Indicates whether a profile should be created when data is
          received if one doesn’t exist for an object of this type.
          The default is "FALSE". If the AllowProfileCreation flag is
          set to "FALSE", then the service tries to fetch a standard
          profile and associate this object with the profile. If it is
          set to "TRUE", and if no match is found, then the service
          creates a new standard profile.

        * **SourceLastUpdatedTimestampFormat** *(string) --*

          The format of your "sourceLastUpdatedTimestamp" that was
          previously set up.

        * **MaxAvailableProfileObjectCount** *(integer) --*

          The amount of provisioned profile object max count
          available.

        * **MaxProfileObjectCount** *(integer) --*

          The amount of profile object max count assigned to the
          object type.

        * **Fields** *(dict) --*

          A map of the name and ObjectType field.

          * *(string) --*

            * *(dict) --*

              Represents a field in a ProfileObjectType.

              * **Source** *(string) --*

                A field of a ProfileObject. For example:
                _source.FirstName, where “_source” is a
                ProfileObjectType of a Zendesk user and “FirstName” is
                a field in that ObjectType.

              * **Target** *(string) --*

                The location of the data in the standard ProfileObject
                model. For example: _profile.Address.PostalCode.

              * **ContentType** *(string) --*

                The content type of the field. Used for determining
                equality when searching.

        * **Keys** *(dict) --*

          A list of unique keys that can be used to map data to the
          profile.

          * *(string) --*

            * *(list) --*

              * *(dict) --*

                An object that defines the Key element of a
                ProfileObject. A Key is a special element that can be
                used to search for a customer profile.

                * **StandardIdentifiers** *(list) --*

                  The types of keys that a ProfileObject can have.
                  Each ProfileObject can have only 1 UNIQUE key but
                  multiple PROFILE keys. PROFILE, ASSET, CASE, or
                  ORDER means that this key can be used to tie an
                  object to a PROFILE, ASSET, CASE, or ORDER
                  respectively. UNIQUE means that it can be used to
                  uniquely identify an object. If a key a is marked as
                  SECONDARY, it will be used to search for profiles
                  after all other PROFILE keys have been searched. A
                  LOOKUP_ONLY key is only used to match a profile but
                  is not persisted to be used for searching of the
                  profile. A NEW_ONLY key is only used if the profile
                  does not already exist before the object is
                  ingested, otherwise it is only used for matching
                  objects to profiles.

                  * *(string) --*

                * **FieldNames** *(list) --*

                  The reference for the key name of the fields map.

                  * *(string) --*

        * **CreatedAt** *(datetime) --*

          The timestamp of when the domain was created.

        * **LastUpdatedAt** *(datetime) --*

          The timestamp of when the domain was most recently edited.

        * **Tags** *(dict) --*

          The tags used to organize, track, or control access for this
          resource.

          * *(string) --*

            * *(string) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / get_segment_membership


get_segment_membership
**********************

CustomerProfiles.Client.get_segment_membership(**kwargs)

   Determines if the given profiles are within a segment.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.get_segment_membership(
          DomainName='string',
          SegmentDefinitionName='string',
          ProfileIds=[
              'string',
          ]
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **SegmentDefinitionName** (*string*) --

        **[REQUIRED]**

        The Id of the wanted segment. Needs to be a valid, and
        existing segment Id.

      * **ProfileIds** (*list*) --

        **[REQUIRED]**

        The list of profile IDs to query for.

        * *(string) --*

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'SegmentDefinitionName': 'string',
             'Profiles': [
                 {
                     'ProfileId': 'string',
                     'QueryResult': 'PRESENT'|'ABSENT',
                     'Profile': {
                         'ProfileId': 'string',
                         'AccountNumber': 'string',
                         'AdditionalInformation': 'string',
                         'PartyType': 'INDIVIDUAL'|'BUSINESS'|'OTHER',
                         'BusinessName': 'string',
                         'FirstName': 'string',
                         'MiddleName': 'string',
                         'LastName': 'string',
                         'BirthDate': 'string',
                         'Gender': 'MALE'|'FEMALE'|'UNSPECIFIED',
                         'PhoneNumber': 'string',
                         'MobilePhoneNumber': 'string',
                         'HomePhoneNumber': 'string',
                         'BusinessPhoneNumber': 'string',
                         'EmailAddress': 'string',
                         'PersonalEmailAddress': 'string',
                         'BusinessEmailAddress': 'string',
                         'Address': {
                             'Address1': 'string',
                             'Address2': 'string',
                             'Address3': 'string',
                             'Address4': 'string',
                             'City': 'string',
                             'County': 'string',
                             'State': 'string',
                             'Province': 'string',
                             'Country': 'string',
                             'PostalCode': 'string'
                         },
                         'ShippingAddress': {
                             'Address1': 'string',
                             'Address2': 'string',
                             'Address3': 'string',
                             'Address4': 'string',
                             'City': 'string',
                             'County': 'string',
                             'State': 'string',
                             'Province': 'string',
                             'Country': 'string',
                             'PostalCode': 'string'
                         },
                         'MailingAddress': {
                             'Address1': 'string',
                             'Address2': 'string',
                             'Address3': 'string',
                             'Address4': 'string',
                             'City': 'string',
                             'County': 'string',
                             'State': 'string',
                             'Province': 'string',
                             'Country': 'string',
                             'PostalCode': 'string'
                         },
                         'BillingAddress': {
                             'Address1': 'string',
                             'Address2': 'string',
                             'Address3': 'string',
                             'Address4': 'string',
                             'City': 'string',
                             'County': 'string',
                             'State': 'string',
                             'Province': 'string',
                             'Country': 'string',
                             'PostalCode': 'string'
                         },
                         'Attributes': {
                             'string': 'string'
                         },
                         'FoundByItems': [
                             {
                                 'KeyName': 'string',
                                 'Values': [
                                     'string',
                                 ]
                             },
                         ],
                         'PartyTypeString': 'string',
                         'GenderString': 'string',
                         'ProfileType': 'ACCOUNT_PROFILE'|'PROFILE',
                         'EngagementPreferences': {
                             'Phone': [
                                 {
                                     'KeyName': 'string',
                                     'KeyValue': 'string',
                                     'ProfileId': 'string',
                                     'ContactType': 'PhoneNumber'|'MobilePhoneNumber'|'HomePhoneNumber'|'BusinessPhoneNumber'|'EmailAddress'|'PersonalEmailAddress'|'BusinessEmailAddress'
                                 },
                             ],
                             'Email': [
                                 {
                                     'KeyName': 'string',
                                     'KeyValue': 'string',
                                     'ProfileId': 'string',
                                     'ContactType': 'PhoneNumber'|'MobilePhoneNumber'|'HomePhoneNumber'|'BusinessPhoneNumber'|'EmailAddress'|'PersonalEmailAddress'|'BusinessEmailAddress'
                                 },
                             ]
                         }
                     }
                 },
             ],
             'Failures': [
                 {
                     'ProfileId': 'string',
                     'Message': 'string',
                     'Status': 123
                 },
             ]
         }

      **Response Structure**

      * *(dict) --*

        * **SegmentDefinitionName** *(string) --*

          The unique name of the segment definition.

        * **Profiles** *(list) --*

          An array of maps where each contains a response per profile
          requested.

          * *(dict) --*

            Object that holds the results for membership.

            * **ProfileId** *(string) --*

              The profile id the result belongs to.

            * **QueryResult** *(string) --*

              Describes whether the profile was absent or present in
              the segment.

            * **Profile** *(dict) --*

              The standard profile of a customer.

              * **ProfileId** *(string) --*

                The unique identifier of a customer profile.

              * **AccountNumber** *(string) --*

                An account number that you have assigned to the
                customer.

              * **AdditionalInformation** *(string) --*

                Any additional information relevant to the customer’s
                profile.

              * **PartyType** *(string) --*

                The type of profile used to describe the customer.

              * **BusinessName** *(string) --*

                The name of the customer’s business.

              * **FirstName** *(string) --*

                The customer’s first name.

              * **MiddleName** *(string) --*

                The customer’s middle name.

              * **LastName** *(string) --*

                The customer’s last name.

              * **BirthDate** *(string) --*

                The customer’s birth date.

              * **Gender** *(string) --*

                The gender with which the customer identifies.

              * **PhoneNumber** *(string) --*

                The customer's phone number, which has not been
                specified as a mobile, home, or business number.

              * **MobilePhoneNumber** *(string) --*

                The customer’s mobile phone number.

              * **HomePhoneNumber** *(string) --*

                The customer’s home phone number.

              * **BusinessPhoneNumber** *(string) --*

                The customer’s home phone number.

              * **EmailAddress** *(string) --*

                The customer’s email address, which has not been
                specified as a personal or business address.

              * **PersonalEmailAddress** *(string) --*

                The customer’s personal email address.

              * **BusinessEmailAddress** *(string) --*

                The customer’s business email address.

              * **Address** *(dict) --*

                A generic address associated with the customer that is
                not mailing, shipping, or billing.

                * **Address1** *(string) --*

                  The first line of a customer address.

                * **Address2** *(string) --*

                  The second line of a customer address.

                * **Address3** *(string) --*

                  The third line of a customer address.

                * **Address4** *(string) --*

                  The fourth line of a customer address.

                * **City** *(string) --*

                  The city in which a customer lives.

                * **County** *(string) --*

                  The county in which a customer lives.

                * **State** *(string) --*

                  The state in which a customer lives.

                * **Province** *(string) --*

                  The province in which a customer lives.

                * **Country** *(string) --*

                  The country in which a customer lives.

                * **PostalCode** *(string) --*

                  The postal code of a customer address.

              * **ShippingAddress** *(dict) --*

                The customer’s shipping address.

                * **Address1** *(string) --*

                  The first line of a customer address.

                * **Address2** *(string) --*

                  The second line of a customer address.

                * **Address3** *(string) --*

                  The third line of a customer address.

                * **Address4** *(string) --*

                  The fourth line of a customer address.

                * **City** *(string) --*

                  The city in which a customer lives.

                * **County** *(string) --*

                  The county in which a customer lives.

                * **State** *(string) --*

                  The state in which a customer lives.

                * **Province** *(string) --*

                  The province in which a customer lives.

                * **Country** *(string) --*

                  The country in which a customer lives.

                * **PostalCode** *(string) --*

                  The postal code of a customer address.

              * **MailingAddress** *(dict) --*

                The customer’s mailing address.

                * **Address1** *(string) --*

                  The first line of a customer address.

                * **Address2** *(string) --*

                  The second line of a customer address.

                * **Address3** *(string) --*

                  The third line of a customer address.

                * **Address4** *(string) --*

                  The fourth line of a customer address.

                * **City** *(string) --*

                  The city in which a customer lives.

                * **County** *(string) --*

                  The county in which a customer lives.

                * **State** *(string) --*

                  The state in which a customer lives.

                * **Province** *(string) --*

                  The province in which a customer lives.

                * **Country** *(string) --*

                  The country in which a customer lives.

                * **PostalCode** *(string) --*

                  The postal code of a customer address.

              * **BillingAddress** *(dict) --*

                The customer’s billing address.

                * **Address1** *(string) --*

                  The first line of a customer address.

                * **Address2** *(string) --*

                  The second line of a customer address.

                * **Address3** *(string) --*

                  The third line of a customer address.

                * **Address4** *(string) --*

                  The fourth line of a customer address.

                * **City** *(string) --*

                  The city in which a customer lives.

                * **County** *(string) --*

                  The county in which a customer lives.

                * **State** *(string) --*

                  The state in which a customer lives.

                * **Province** *(string) --*

                  The province in which a customer lives.

                * **Country** *(string) --*

                  The country in which a customer lives.

                * **PostalCode** *(string) --*

                  The postal code of a customer address.

              * **Attributes** *(dict) --*

                A key value pair of attributes of a customer profile.

                * *(string) --*

                  * *(string) --*

              * **FoundByItems** *(list) --*

                A list of items used to find a profile returned in a
                SearchProfiles response. An item is a key-value(s)
                pair that matches an attribute in the profile.

                If the optional "AdditionalSearchKeys" parameter was
                included in the SearchProfiles request, the
                "FoundByItems" list should be interpreted based on the
                "LogicalOperator" used in the request:

                * "AND" - The profile included in the response matched
                  all of the search keys specified in the request. The
                  "FoundByItems" will include all of the key-value(s)
                  pairs that were specified in the request (as this is
                  a requirement of "AND" search logic).

                * "OR" - The profile included in the response matched
                  at least one of the search keys specified in the
                  request. The "FoundByItems" will include each of the
                  key-value(s) pairs that the profile was found by.

                The "OR" relationship is the default behavior if the
                "LogicalOperator" parameter is not included in the
                SearchProfiles request.

                * *(dict) --*

                  A data type pair that consists of a "KeyName" and
                  "Values" list that were used to find a profile
                  returned in response to a SearchProfiles request.

                  * **KeyName** *(string) --*

                    A searchable identifier of a customer profile.

                  * **Values** *(list) --*

                    A list of key values.

                    * *(string) --*

              * **PartyTypeString** *(string) --*

                An alternative to PartyType which accepts any string
                as input.

              * **GenderString** *(string) --*

                An alternative to Gender which accepts any string as
                input.

              * **ProfileType** *(string) --*

                The type of the profile.

              * **EngagementPreferences** *(dict) --*

                The customer or account’s engagement preferences.

                * **Phone** *(list) --*

                  A list of phone-related contact preferences

                  * *(dict) --*

                    Object that defines users contact preference.

                    * **KeyName** *(string) --*

                      A searchable, unique identifier of a customer
                      profile.

                    * **KeyValue** *(string) --*

                      The key value used to look up profile based off
                      the keyName.

                    * **ProfileId** *(string) --*

                      The unique identifier of a customer profile.

                    * **ContactType** *(string) --*

                      The contact type used for engagement. For
                      example: HomePhoneNumber, PersonalEmailAddress.

                * **Email** *(list) --*

                  A list of email-related contact preferences

                  * *(dict) --*

                    Object that defines users contact preference.

                    * **KeyName** *(string) --*

                      A searchable, unique identifier of a customer
                      profile.

                    * **KeyValue** *(string) --*

                      The key value used to look up profile based off
                      the keyName.

                    * **ProfileId** *(string) --*

                      The unique identifier of a customer profile.

                    * **ContactType** *(string) --*

                      The contact type used for engagement. For
                      example: HomePhoneNumber, PersonalEmailAddress.

        * **Failures** *(list) --*

          An array of maps where each contains a response per profile
          failed for the request.

          * *(dict) --*

            Object that holds failures for membership.

            * **ProfileId** *(string) --*

              The profile id the failure belongs to.

            * **Message** *(string) --*

              A message describing the failure.

            * **Status** *(integer) --*

              The status describing the failure.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"
CustomerProfiles / Client / create_event_stream


create_event_stream
*******************

CustomerProfiles.Client.create_event_stream(**kwargs)

   Creates an event stream, which is a subscription to real-time
   events, such as when profiles are created and updated through
   Amazon Connect Customer Profiles.

   Each event stream can be associated with only one Kinesis Data
   Stream destination in the same region and Amazon Web Services
   account as the customer profiles domain

   See also: AWS API Documentation

   **Request Syntax**

      response = client.create_event_stream(
          DomainName='string',
          Uri='string',
          EventStreamName='string',
          Tags={
              'string': 'string'
          }
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **Uri** (*string*) --

        **[REQUIRED]**

        The StreamARN of the destination to deliver profile events to.
        For example, arn:aws:kinesis:region:account-id:stream/stream-
        name

      * **EventStreamName** (*string*) --

        **[REQUIRED]**

        The name of the event stream.

      * **Tags** (*dict*) --

        The tags used to organize, track, or control access for this
        resource.

        * *(string) --*

          * *(string) --*

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'EventStreamArn': 'string',
             'Tags': {
                 'string': 'string'
             }
         }

      **Response Structure**

      * *(dict) --*

        * **EventStreamArn** *(string) --*

          A unique identifier for the event stream.

        * **Tags** *(dict) --*

          The tags used to organize, track, or control access for this
          resource.

          * *(string) --*

            * *(string) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / list_object_type_attributes


list_object_type_attributes
***************************

CustomerProfiles.Client.list_object_type_attributes(**kwargs)

   Fetch the possible attribute values given the attribute name.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_object_type_attributes(
          NextToken='string',
          MaxResults=123,
          DomainName='string',
          ObjectTypeName='string'
      )

   Parameters:
      * **NextToken** (*string*) -- The pagination token from the
        previous call.

      * **MaxResults** (*integer*) -- The maximum number of objects
        returned per page.

      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique identifier of the domain.

      * **ObjectTypeName** (*string*) --

        **[REQUIRED]**

        The name of the profile object type.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'Items': [
                 {
                     'AttributeName': 'string',
                     'LastUpdatedAt': datetime(2015, 1, 1)
                 },
             ],
             'NextToken': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **Items** *(list) --*

          The items returned as part of the response.

          * *(dict) --*

            Item that contains the attribute and when it was last
            updated.

            * **AttributeName** *(string) --*

              Name of the attribute.

            * **LastUpdatedAt** *(datetime) --*

              When the attribute was last updated.

        * **NextToken** *(string) --*

          The pagination token from the previous call.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / tag_resource


tag_resource
************

CustomerProfiles.Client.tag_resource(**kwargs)

   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
   permissions by granting a user permission to access or change only
   resources with certain tag values. In Connect Customer Profiles,
   domains, profile object types, and integrations can be tagged.

   Tags don't have any semantic meaning to AWS and are interpreted
   strictly as strings of characters.

   You can use the TagResource action with a resource that already has
   tags. If you specify a new tag key, this tag is appended to the
   list of tags associated with the resource. If you specify a tag key
   that is already associated with the resource, the new tag value
   that you specify replaces the previous value for that tag.

   You can associate as many as 50 tags with a resource.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.tag_resource(
          resourceArn='string',
          tags={
              'string': 'string'
          }
      )

   Parameters:
      * **resourceArn** (*string*) --

        **[REQUIRED]**

        The ARN of the resource that you're adding tags to.

      * **tags** (*dict*) --

        **[REQUIRED]**

        The tags used to organize, track, or control access for this
        resource.

        * *(string) --*

          * *(string) --*

   Return type:
      dict

   Returns:
      **Response Syntax**

         {}

      **Response Structure**

      * *(dict) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.InternalServerException"

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"
CustomerProfiles / Client / list_identity_resolution_jobs


list_identity_resolution_jobs
*****************************

CustomerProfiles.Client.list_identity_resolution_jobs(**kwargs)

   Lists all of the Identity Resolution Jobs in your domain. The
   response sorts the list by "JobStartTime".

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_identity_resolution_jobs(
          DomainName='string',
          NextToken='string',
          MaxResults=123
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **NextToken** (*string*) -- 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.

      * **MaxResults** (*integer*) -- The maximum number of results to
        return per page.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'IdentityResolutionJobsList': [
                 {
                     'DomainName': 'string',
                     'JobId': 'string',
                     'Status': 'PENDING'|'PREPROCESSING'|'FIND_MATCHING'|'MERGING'|'COMPLETED'|'PARTIAL_SUCCESS'|'FAILED',
                     'JobStartTime': datetime(2015, 1, 1),
                     'JobEndTime': datetime(2015, 1, 1),
                     'JobStats': {
                         'NumberOfProfilesReviewed': 123,
                         'NumberOfMatchesFound': 123,
                         'NumberOfMergesDone': 123
                     },
                     'ExportingLocation': {
                         'S3Exporting': {
                             'S3BucketName': 'string',
                             'S3KeyName': 'string'
                         }
                     },
                     'Message': 'string'
                 },
             ],
             'NextToken': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **IdentityResolutionJobsList** *(list) --*

          A list of Identity Resolution Jobs.

          * *(dict) --*

            Information about the Identity Resolution Job.

            * **DomainName** *(string) --*

              The unique name of the domain.

            * **JobId** *(string) --*

              The unique identifier of the Identity Resolution Job.

            * **Status** *(string) --*

              The status of the Identity Resolution Job.

              * "PENDING": The Identity Resolution Job is scheduled
                but has not started yet. If you turn off the Identity
                Resolution feature in your domain, jobs in the
                "PENDING" state are deleted.

              * "PREPROCESSING": The Identity Resolution Job is
                loading your data.

              * "FIND_MATCHING": The Identity Resolution Job is using
                the machine learning model to identify profiles that
                belong to the same matching group.

              * "MERGING": The Identity Resolution Job is merging
                duplicate profiles.

              * "COMPLETED": The Identity Resolution Job completed
                successfully.

              * "PARTIAL_SUCCESS": There's a system error and not all
                of the data is merged. The Identity Resolution Job
                writes a message indicating the source of the problem.

              * "FAILED": The Identity Resolution Job did not merge
                any data. It writes a message indicating the source of
                the problem.

            * **JobStartTime** *(datetime) --*

              The timestamp of when the job was started or will be
              started.

            * **JobEndTime** *(datetime) --*

              The timestamp of when the job was completed.

            * **JobStats** *(dict) --*

              Statistics about an Identity Resolution Job.

              * **NumberOfProfilesReviewed** *(integer) --*

                The number of profiles reviewed.

              * **NumberOfMatchesFound** *(integer) --*

                The number of matches found.

              * **NumberOfMergesDone** *(integer) --*

                The number of merges completed.

            * **ExportingLocation** *(dict) --*

              The S3 location where the Identity Resolution Job writes
              result files.

              * **S3Exporting** *(dict) --*

                Information about the S3 location where Identity
                Resolution Jobs write result files.

                * **S3BucketName** *(string) --*

                  The name of the S3 bucket name where Identity
                  Resolution Jobs write result files.

                * **S3KeyName** *(string) --*

                  The S3 key name of the location where Identity
                  Resolution Jobs write result files.

            * **Message** *(string) --*

              The error messages that are generated when the Identity
              Resolution Job runs.

        * **NextToken** *(string) --*

          If there are additional results, this is the token for the
          next set of results.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / get_domain_layout


get_domain_layout
*****************

CustomerProfiles.Client.get_domain_layout(**kwargs)

   Gets the layout to view data for a specific domain. This API can
   only be invoked from the Amazon Connect admin website.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.get_domain_layout(
          DomainName='string',
          LayoutDefinitionName='string'
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **LayoutDefinitionName** (*string*) --

        **[REQUIRED]**

        The unique name of the layout.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'LayoutDefinitionName': 'string',
             'Description': 'string',
             'DisplayName': 'string',
             'IsDefault': True|False,
             'LayoutType': 'PROFILE_EXPLORER',
             'Layout': 'string',
             'Version': 'string',
             'CreatedAt': datetime(2015, 1, 1),
             'LastUpdatedAt': datetime(2015, 1, 1),
             'Tags': {
                 'string': 'string'
             }
         }

      **Response Structure**

      * *(dict) --*

        * **LayoutDefinitionName** *(string) --*

          The unique name of the layout.

        * **Description** *(string) --*

          The description of the layout

        * **DisplayName** *(string) --*

          The display name of the layout

        * **IsDefault** *(boolean) --*

          If set to true for a layout, this layout will be used by
          default to view data. If set to false, then the layout will
          not be used by default, but it can be used to view data by
          explicitly selecting it in the console.

        * **LayoutType** *(string) --*

          The type of layout that can be used to view data under a
          Customer Profiles domain.

        * **Layout** *(string) --*

          A customizable layout that can be used to view data under a
          Customer Profiles domain.

        * **Version** *(string) --*

          The version used to create layout.

        * **CreatedAt** *(datetime) --*

          The timestamp of when the layout was created.

        * **LastUpdatedAt** *(datetime) --*

          The timestamp of when the layout was most recently updated.

        * **Tags** *(dict) --*

          The tags used to organize, track, or control access for this
          resource.

          * *(string) --*

            * *(string) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / create_calculated_attribute_definition


create_calculated_attribute_definition
**************************************

CustomerProfiles.Client.create_calculated_attribute_definition(**kwargs)

   Creates a new calculated attribute definition. After creation, new
   object data ingested into Customer Profiles will be included in the
   calculated attribute, which can be retrieved for a profile using
   the GetCalculatedAttributeForProfile API. Defining a calculated
   attribute makes it available for all profiles within a domain. Each
   calculated attribute can only reference one "ObjectType" and at
   most, two fields from that "ObjectType".

   See also: AWS API Documentation

   **Request Syntax**

      response = client.create_calculated_attribute_definition(
          DomainName='string',
          CalculatedAttributeName='string',
          DisplayName='string',
          Description='string',
          AttributeDetails={
              'Attributes': [
                  {
                      'Name': 'string'
                  },
              ],
              'Expression': 'string'
          },
          Conditions={
              'Range': {
                  'Value': 123,
                  'Unit': 'DAYS',
                  'ValueRange': {
                      'Start': 123,
                      'End': 123
                  },
                  'TimestampSource': 'string',
                  'TimestampFormat': 'string'
              },
              'ObjectCount': 123,
              'Threshold': {
                  'Value': 'string',
                  'Operator': 'EQUAL_TO'|'GREATER_THAN'|'LESS_THAN'|'NOT_EQUAL_TO'
              }
          },
          Filter={
              'Include': 'ALL'|'ANY'|'NONE',
              'Groups': [
                  {
                      'Type': 'ALL'|'ANY'|'NONE',
                      'Dimensions': [
                          {
                              'Attributes': {
                                  'string': {
                                      'DimensionType': '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': [
                                          'string',
                                      ]
                                  }
                              }
                          },
                      ]
                  },
              ]
          },
          Statistic='FIRST_OCCURRENCE'|'LAST_OCCURRENCE'|'COUNT'|'SUM'|'MINIMUM'|'MAXIMUM'|'AVERAGE'|'MAX_OCCURRENCE',
          UseHistoricalData=True|False,
          Tags={
              'string': 'string'
          }
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **CalculatedAttributeName** (*string*) --

        **[REQUIRED]**

        The unique name of the calculated attribute.

      * **DisplayName** (*string*) -- The display name of the
        calculated attribute.

      * **Description** (*string*) -- The description of the
        calculated attribute.

      * **AttributeDetails** (*dict*) --

        **[REQUIRED]**

        Mathematical expression and a list of attribute items
        specified in that expression.

        * **Attributes** *(list) --* **[REQUIRED]**

          A list of attribute items specified in the mathematical
          expression.

          * *(dict) --*

            The details of a single attribute item specified in the
            mathematical expression.

            * **Name** *(string) --* **[REQUIRED]**

              The name of an attribute defined in a profile object
              type.

        * **Expression** *(string) --* **[REQUIRED]**

          Mathematical expression that is performed on attribute items
          provided in the attribute list. Each element in the
          expression should follow the structure of
          "{ObjectTypeName.AttributeName}".

      * **Conditions** (*dict*) --

        The conditions including range, object count, and threshold
        for the calculated attribute.

        * **Range** *(dict) --*

          The relative time period over which data is included in the
          aggregation.

          * **Value** *(integer) --*

            The amount of time of the specified unit.

          * **Unit** *(string) --*

            The unit of time.

          * **ValueRange** *(dict) --*

            A structure letting customers specify a relative time
            window over which over which data is included in the
            Calculated Attribute. Use positive numbers to indicate
            that the endpoint is in the past, and negative numbers to
            indicate it is in the future. ValueRange overrides Value.

            * **Start** *(integer) --* **[REQUIRED]**

              The start time of when to include objects. Use positive
              numbers to indicate that the starting point is in the
              past, and negative numbers to indicate it is in the
              future.

            * **End** *(integer) --* **[REQUIRED]**

              The end time of when to include objects. Use positive
              numbers to indicate that the starting point is in the
              past, and negative numbers to indicate it is in the
              future.

          * **TimestampSource** *(string) --*

            An expression specifying the field in your JSON object
            from which the date should be parsed. The expression
            should follow the structure of "{ObjectTypeName.<Location
            of timestamp field in JSON pointer format>}". E.g. if your
            object type is MyType and source JSON is {"generatedAt":
            {"timestamp": "1737587945945"}}, then TimestampSource
            should be "{MyType.generatedAt.timestamp}".

          * **TimestampFormat** *(string) --*

            The format the timestamp field in your JSON object is
            specified. This value should be one of EPOCHMILLI (for
            Unix epoch timestamps with second/millisecond level
            precision) or ISO_8601 (following ISO_8601 format with
            second/millisecond level precision, with an optional
            offset of Z or in the format HH:MM or HHMM.). E.g. if your
            object type is MyType and source JSON is {"generatedAt":
            {"timestamp": "2001-07-04T12:08:56.235-0700"}}, then
            TimestampFormat should be "ISO_8601".

        * **ObjectCount** *(integer) --*

          The number of profile objects used for the calculated
          attribute.

        * **Threshold** *(dict) --*

          The threshold for the calculated attribute.

          * **Value** *(string) --* **[REQUIRED]**

            The value of the threshold.

          * **Operator** *(string) --* **[REQUIRED]**

            The operator of the threshold.

      * **Filter** (*dict*) --

        Defines how to filter incoming objects to include part of the
        Calculated Attribute.

        * **Include** *(string) --* **[REQUIRED]**

          Define whether to include or exclude objects for Calculated
          Attributed calculation that fit the filter groups criteria.

        * **Groups** *(list) --* **[REQUIRED]**

          Holds the list of Filter groups within the Filter
          definition.

          * *(dict) --*

            Object that holds the dimensions to filter on.

            * **Type** *(string) --* **[REQUIRED]**

              The type of logical relationship between the dimensions
              of the Filter group.

            * **Dimensions** *(list) --* **[REQUIRED]**

              Object that holds the attributes to filter on.

              * *(dict) --*

                Contains the map of attribute names to attribute
                dimensions.

                * **Attributes** *(dict) --* **[REQUIRED]**

                  Is the attribute within the FilterDimension map

                  * *(string) --*

                    * *(dict) --*

                      Object that defines how to filter the incoming
                      objects for the calculated attribute.

                      * **DimensionType** *(string) --* **[REQUIRED]**

                        The action to filter with.

                      * **Values** *(list) --* **[REQUIRED]**

                        The values to apply the DimensionType on.

                        * *(string) --*

      * **Statistic** (*string*) --

        **[REQUIRED]**

        The aggregation operation to perform for the calculated
        attribute.

      * **UseHistoricalData** (*boolean*) -- Whether historical data
        ingested before the Calculated Attribute was created should be
        included in calculations.

      * **Tags** (*dict*) --

        The tags used to organize, track, or control access for this
        resource.

        * *(string) --*

          * *(string) --*

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'CalculatedAttributeName': 'string',
             'DisplayName': 'string',
             'Description': 'string',
             'AttributeDetails': {
                 'Attributes': [
                     {
                         'Name': 'string'
                     },
                 ],
                 'Expression': 'string'
             },
             'Conditions': {
                 'Range': {
                     'Value': 123,
                     'Unit': 'DAYS',
                     'ValueRange': {
                         'Start': 123,
                         'End': 123
                     },
                     'TimestampSource': 'string',
                     'TimestampFormat': 'string'
                 },
                 'ObjectCount': 123,
                 'Threshold': {
                     'Value': 'string',
                     'Operator': 'EQUAL_TO'|'GREATER_THAN'|'LESS_THAN'|'NOT_EQUAL_TO'
                 }
             },
             'Filter': {
                 'Include': 'ALL'|'ANY'|'NONE',
                 'Groups': [
                     {
                         'Type': 'ALL'|'ANY'|'NONE',
                         'Dimensions': [
                             {
                                 'Attributes': {
                                     'string': {
                                         'DimensionType': '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': [
                                             'string',
                                         ]
                                     }
                                 }
                             },
                         ]
                     },
                 ]
             },
             'Statistic': 'FIRST_OCCURRENCE'|'LAST_OCCURRENCE'|'COUNT'|'SUM'|'MINIMUM'|'MAXIMUM'|'AVERAGE'|'MAX_OCCURRENCE',
             'CreatedAt': datetime(2015, 1, 1),
             'LastUpdatedAt': datetime(2015, 1, 1),
             'UseHistoricalData': True|False,
             'Status': 'PREPARING'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
             'Readiness': {
                 'ProgressPercentage': 123,
                 'Message': 'string'
             },
             'Tags': {
                 'string': 'string'
             }
         }

      **Response Structure**

      * *(dict) --*

        * **CalculatedAttributeName** *(string) --*

          The unique name of the calculated attribute.

        * **DisplayName** *(string) --*

          The display name of the calculated attribute.

        * **Description** *(string) --*

          The description of the calculated attribute.

        * **AttributeDetails** *(dict) --*

          Mathematical expression and a list of attribute items
          specified in that expression.

          * **Attributes** *(list) --*

            A list of attribute items specified in the mathematical
            expression.

            * *(dict) --*

              The details of a single attribute item specified in the
              mathematical expression.

              * **Name** *(string) --*

                The name of an attribute defined in a profile object
                type.

          * **Expression** *(string) --*

            Mathematical expression that is performed on attribute
            items provided in the attribute list. Each element in the
            expression should follow the structure of
            "{ObjectTypeName.AttributeName}".

        * **Conditions** *(dict) --*

          The conditions including range, object count, and threshold
          for the calculated attribute.

          * **Range** *(dict) --*

            The relative time period over which data is included in
            the aggregation.

            * **Value** *(integer) --*

              The amount of time of the specified unit.

            * **Unit** *(string) --*

              The unit of time.

            * **ValueRange** *(dict) --*

              A structure letting customers specify a relative time
              window over which over which data is included in the
              Calculated Attribute. Use positive numbers to indicate
              that the endpoint is in the past, and negative numbers
              to indicate it is in the future. ValueRange overrides
              Value.

              * **Start** *(integer) --*

                The start time of when to include objects. Use
                positive numbers to indicate that the starting point
                is in the past, and negative numbers to indicate it is
                in the future.

              * **End** *(integer) --*

                The end time of when to include objects. Use positive
                numbers to indicate that the starting point is in the
                past, and negative numbers to indicate it is in the
                future.

            * **TimestampSource** *(string) --*

              An expression specifying the field in your JSON object
              from which the date should be parsed. The expression
              should follow the structure of
              "{ObjectTypeName.<Location of timestamp field in JSON
              pointer format>}". E.g. if your object type is MyType
              and source JSON is {"generatedAt": {"timestamp":
              "1737587945945"}}, then TimestampSource should be
              "{MyType.generatedAt.timestamp}".

            * **TimestampFormat** *(string) --*

              The format the timestamp field in your JSON object is
              specified. This value should be one of EPOCHMILLI (for
              Unix epoch timestamps with second/millisecond level
              precision) or ISO_8601 (following ISO_8601 format with
              second/millisecond level precision, with an optional
              offset of Z or in the format HH:MM or HHMM.). E.g. if
              your object type is MyType and source JSON is
              {"generatedAt": {"timestamp":
              "2001-07-04T12:08:56.235-0700"}}, then TimestampFormat
              should be "ISO_8601".

          * **ObjectCount** *(integer) --*

            The number of profile objects used for the calculated
            attribute.

          * **Threshold** *(dict) --*

            The threshold for the calculated attribute.

            * **Value** *(string) --*

              The value of the threshold.

            * **Operator** *(string) --*

              The operator of the threshold.

        * **Filter** *(dict) --*

          The filter that was used as part of the request.

          * **Include** *(string) --*

            Define whether to include or exclude objects for
            Calculated Attributed calculation that fit the filter
            groups criteria.

          * **Groups** *(list) --*

            Holds the list of Filter groups within the Filter
            definition.

            * *(dict) --*

              Object that holds the dimensions to filter on.

              * **Type** *(string) --*

                The type of logical relationship between the
                dimensions of the Filter group.

              * **Dimensions** *(list) --*

                Object that holds the attributes to filter on.

                * *(dict) --*

                  Contains the map of attribute names to attribute
                  dimensions.

                  * **Attributes** *(dict) --*

                    Is the attribute within the FilterDimension map

                    * *(string) --*

                      * *(dict) --*

                        Object that defines how to filter the incoming
                        objects for the calculated attribute.

                        * **DimensionType** *(string) --*

                          The action to filter with.

                        * **Values** *(list) --*

                          The values to apply the DimensionType on.

                          * *(string) --*

        * **Statistic** *(string) --*

          The aggregation operation to perform for the calculated
          attribute.

        * **CreatedAt** *(datetime) --*

          The timestamp of when the calculated attribute definition
          was created.

        * **LastUpdatedAt** *(datetime) --*

          The timestamp of when the calculated attribute definition
          was most recently edited.

        * **UseHistoricalData** *(boolean) --*

          Whether historical data ingested before the Calculated
          Attribute was created should be included in calculations.

        * **Status** *(string) --*

          Status of the Calculated Attribute creation (whether all
          historical data has been indexed.)

        * **Readiness** *(dict) --*

          Information indicating if the Calculated Attribute is ready
          for use by confirming all historical data has been processed
          and reflected.

          * **ProgressPercentage** *(integer) --*

            Approximately how far the Calculated Attribute creation is
            from completion.

          * **Message** *(string) --*

            Any customer messaging.

        * **Tags** *(dict) --*

          The tags used to organize, track, or control access for this
          resource.

          * *(string) --*

            * *(string) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / create_event_trigger


create_event_trigger
********************

CustomerProfiles.Client.create_event_trigger(**kwargs)

   Creates an event trigger, which specifies the rules when to perform
   action based on customer's ingested data.

   Each event stream can be associated with only one integration in
   the same region and AWS account as the event stream.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.create_event_trigger(
          DomainName='string',
          EventTriggerName='string',
          ObjectTypeName='string',
          Description='string',
          EventTriggerConditions=[
              {
                  'EventTriggerDimensions': [
                      {
                          'ObjectAttributes': [
                              {
                                  'Source': 'string',
                                  'FieldName': 'string',
                                  'ComparisonOperator': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL'|'LESS_THAN_OR_EQUAL'|'EQUAL'|'BEFORE'|'AFTER'|'ON'|'BETWEEN'|'NOT_BETWEEN',
                                  'Values': [
                                      'string',
                                  ]
                              },
                          ]
                      },
                  ],
                  'LogicalOperator': 'ANY'|'ALL'|'NONE'
              },
          ],
          SegmentFilter='string',
          EventTriggerLimits={
              'EventExpiration': 123,
              'Periods': [
                  {
                      'Unit': 'HOURS'|'DAYS'|'WEEKS'|'MONTHS',
                      'Value': 123,
                      'MaxInvocationsPerProfile': 123,
                      'Unlimited': True|False
                  },
              ]
          },
          Tags={
              'string': 'string'
          }
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **EventTriggerName** (*string*) --

        **[REQUIRED]**

        The unique name of the event trigger.

      * **ObjectTypeName** (*string*) --

        **[REQUIRED]**

        The unique name of the object type.

      * **Description** (*string*) -- The description of the event
        trigger.

      * **EventTriggerConditions** (*list*) --

        **[REQUIRED]**

        A list of conditions that determine when an event should
        trigger the destination.

        * *(dict) --*

          Specifies the circumstances under which the event should
          trigger the destination.

          * **EventTriggerDimensions** *(list) --* **[REQUIRED]**

            A list of dimensions to be evaluated for the event.

            * *(dict) --*

              A specific event dimension to be assessed.

              * **ObjectAttributes** *(list) --* **[REQUIRED]**

                A list of object attributes to be evaluated.

                * *(dict) --*

                  The criteria that a specific object attribute must
                  meet to trigger the destination.

                  * **Source** *(string) --*

                    An attribute contained within a source object.

                  * **FieldName** *(string) --*

                    A field defined within an object type.

                  * **ComparisonOperator** *(string) --*
                    **[REQUIRED]**

                    The operator used to compare an attribute against
                    a list of values.

                  * **Values** *(list) --* **[REQUIRED]**

                    A list of attribute values used for comparison.

                    * *(string) --*

          * **LogicalOperator** *(string) --* **[REQUIRED]**

            The operator used to combine multiple dimensions.

      * **SegmentFilter** (*string*) -- The destination is triggered
        only for profiles that meet the criteria of a segment
        definition.

      * **EventTriggerLimits** (*dict*) --

        Defines limits controlling whether an event triggers the
        destination, based on ingestion latency and the number of
        invocations per profile over specific time periods.

        * **EventExpiration** *(integer) --*

          In milliseconds. Specifies that an event will only trigger
          the destination if it is processed within a certain latency
          period.

        * **Periods** *(list) --*

          A list of time periods during which the limits apply.

          * *(dict) --*

            Defines a limit and the time period during which it is
            enforced.

            * **Unit** *(string) --* **[REQUIRED]**

              The unit of time.

            * **Value** *(integer) --* **[REQUIRED]**

              The amount of time of the specified unit.

            * **MaxInvocationsPerProfile** *(integer) --*

              The maximum allowed number of destination invocations
              per profile.

            * **Unlimited** *(boolean) --*

              If set to true, there is no limit on the number of
              destination invocations per profile. The default is
              false.

      * **Tags** (*dict*) --

        An array of key-value pairs to apply to this resource.

        * *(string) --*

          * *(string) --*

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'EventTriggerName': 'string',
             'ObjectTypeName': 'string',
             'Description': 'string',
             'EventTriggerConditions': [
                 {
                     'EventTriggerDimensions': [
                         {
                             'ObjectAttributes': [
                                 {
                                     'Source': 'string',
                                     'FieldName': 'string',
                                     'ComparisonOperator': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL'|'LESS_THAN_OR_EQUAL'|'EQUAL'|'BEFORE'|'AFTER'|'ON'|'BETWEEN'|'NOT_BETWEEN',
                                     'Values': [
                                         'string',
                                     ]
                                 },
                             ]
                         },
                     ],
                     'LogicalOperator': 'ANY'|'ALL'|'NONE'
                 },
             ],
             'SegmentFilter': 'string',
             'EventTriggerLimits': {
                 'EventExpiration': 123,
                 'Periods': [
                     {
                         'Unit': 'HOURS'|'DAYS'|'WEEKS'|'MONTHS',
                         'Value': 123,
                         'MaxInvocationsPerProfile': 123,
                         'Unlimited': True|False
                     },
                 ]
             },
             'CreatedAt': datetime(2015, 1, 1),
             'LastUpdatedAt': datetime(2015, 1, 1),
             'Tags': {
                 'string': 'string'
             }
         }

      **Response Structure**

      * *(dict) --*

        * **EventTriggerName** *(string) --*

          The unique name of the event trigger.

        * **ObjectTypeName** *(string) --*

          The unique name of the object type.

        * **Description** *(string) --*

          The description of the event trigger.

        * **EventTriggerConditions** *(list) --*

          A list of conditions that determine when an event should
          trigger the destination.

          * *(dict) --*

            Specifies the circumstances under which the event should
            trigger the destination.

            * **EventTriggerDimensions** *(list) --*

              A list of dimensions to be evaluated for the event.

              * *(dict) --*

                A specific event dimension to be assessed.

                * **ObjectAttributes** *(list) --*

                  A list of object attributes to be evaluated.

                  * *(dict) --*

                    The criteria that a specific object attribute must
                    meet to trigger the destination.

                    * **Source** *(string) --*

                      An attribute contained within a source object.

                    * **FieldName** *(string) --*

                      A field defined within an object type.

                    * **ComparisonOperator** *(string) --*

                      The operator used to compare an attribute
                      against a list of values.

                    * **Values** *(list) --*

                      A list of attribute values used for comparison.

                      * *(string) --*

            * **LogicalOperator** *(string) --*

              The operator used to combine multiple dimensions.

        * **SegmentFilter** *(string) --*

          The destination is triggered only for profiles that meet the
          criteria of a segment definition.

        * **EventTriggerLimits** *(dict) --*

          Defines limits controlling whether an event triggers the
          destination, based on ingestion latency and the number of
          invocations per profile over specific time periods.

          * **EventExpiration** *(integer) --*

            In milliseconds. Specifies that an event will only trigger
            the destination if it is processed within a certain
            latency period.

          * **Periods** *(list) --*

            A list of time periods during which the limits apply.

            * *(dict) --*

              Defines a limit and the time period during which it is
              enforced.

              * **Unit** *(string) --*

                The unit of time.

              * **Value** *(integer) --*

                The amount of time of the specified unit.

              * **MaxInvocationsPerProfile** *(integer) --*

                The maximum allowed number of destination invocations
                per profile.

              * **Unlimited** *(boolean) --*

                If set to true, there is no limit on the number of
                destination invocations per profile. The default is
                false.

        * **CreatedAt** *(datetime) --*

          The timestamp of when the event trigger was created.

        * **LastUpdatedAt** *(datetime) --*

          The timestamp of when the event trigger was most recently
          updated.

        * **Tags** *(dict) --*

          An array of key-value pairs to apply to this resource.

          * *(string) --*

            * *(string) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / get_domain


get_domain
**********

CustomerProfiles.Client.get_domain(**kwargs)

   Returns information about a specific domain.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.get_domain(
          DomainName='string'
      )

   Parameters:
      **DomainName** (*string*) --

      **[REQUIRED]**

      The unique name of the domain.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'DomainName': 'string',
             'DefaultExpirationDays': 123,
             'DefaultEncryptionKey': 'string',
             'DeadLetterQueueUrl': 'string',
             'Stats': {
                 'ProfileCount': 123,
                 'MeteringProfileCount': 123,
                 'ObjectCount': 123,
                 'TotalSize': 123
             },
             'Matching': {
                 'Enabled': True|False,
                 'JobSchedule': {
                     'DayOfTheWeek': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
                     'Time': 'string'
                 },
                 'AutoMerging': {
                     'Enabled': True|False,
                     'Consolidation': {
                         'MatchingAttributesList': [
                             [
                                 'string',
                             ],
                         ]
                     },
                     'ConflictResolution': {
                         'ConflictResolvingModel': 'RECENCY'|'SOURCE',
                         'SourceName': 'string'
                     },
                     'MinAllowedConfidenceScoreForMerging': 123.0
                 },
                 'ExportingConfig': {
                     'S3Exporting': {
                         'S3BucketName': 'string',
                         'S3KeyName': 'string'
                     }
                 }
             },
             'RuleBasedMatching': {
                 'Enabled': True|False,
                 'MatchingRules': [
                     {
                         'Rule': [
                             'string',
                         ]
                     },
                 ],
                 'Status': 'PENDING'|'IN_PROGRESS'|'ACTIVE',
                 'MaxAllowedRuleLevelForMerging': 123,
                 'MaxAllowedRuleLevelForMatching': 123,
                 'AttributeTypesSelector': {
                     'AttributeMatchingModel': 'ONE_TO_ONE'|'MANY_TO_MANY',
                     'Address': [
                         'string',
                     ],
                     'PhoneNumber': [
                         'string',
                     ],
                     'EmailAddress': [
                         'string',
                     ]
                 },
                 'ConflictResolution': {
                     'ConflictResolvingModel': 'RECENCY'|'SOURCE',
                     'SourceName': 'string'
                 },
                 'ExportingConfig': {
                     'S3Exporting': {
                         'S3BucketName': 'string',
                         'S3KeyName': 'string'
                     }
                 }
             },
             'CreatedAt': datetime(2015, 1, 1),
             'LastUpdatedAt': datetime(2015, 1, 1),
             'Tags': {
                 'string': 'string'
             }
         }

      **Response Structure**

      * *(dict) --*

        * **DomainName** *(string) --*

          The unique name of the domain.

        * **DefaultExpirationDays** *(integer) --*

          The default number of days until the data within the domain
          expires.

        * **DefaultEncryptionKey** *(string) --*

          The default encryption key, which is an AWS managed key, is
          used when no specific type of encryption key is specified.
          It is used to encrypt all data before it is placed in
          permanent or semi-permanent storage.

        * **DeadLetterQueueUrl** *(string) --*

          The URL of the SQS dead letter queue, which is used for
          reporting errors associated with ingesting data from third
          party applications.

        * **Stats** *(dict) --*

          Usage-specific statistics about the domain.

          * **ProfileCount** *(integer) --*

            The total number of profiles currently in the domain.

          * **MeteringProfileCount** *(integer) --*

            The number of profiles that you are currently paying for
            in the domain. If you have more than 100 objects
            associated with a single profile, that profile counts as
            two profiles. If you have more than 200 objects, that
            profile counts as three, and so on.

          * **ObjectCount** *(integer) --*

            The total number of objects in domain.

          * **TotalSize** *(integer) --*

            The total size, in bytes, of all objects in the domain.

        * **Matching** *(dict) --*

          The process of matching duplicate profiles. If "Matching" =
          "true", Amazon Connect Customer Profiles starts a weekly
          batch process called Identity Resolution Job. If you do not
          specify a date and time for Identity Resolution Job to run,
          by default it runs every Saturday at 12AM UTC to detect
          duplicate profiles in your domains.

          After the Identity Resolution Job completes, use the
          GetMatches API to return and review the results. Or, if you
          have configured "ExportingConfig" in the "MatchingRequest",
          you can download the results from S3.

          * **Enabled** *(boolean) --*

            The flag that enables the matching process of duplicate
            profiles.

          * **JobSchedule** *(dict) --*

            The day and time when do you want to start the Identity
            Resolution Job every week.

            * **DayOfTheWeek** *(string) --*

              The day when the Identity Resolution Job should run
              every week.

            * **Time** *(string) --*

              The time when the Identity Resolution Job should run
              every week.

          * **AutoMerging** *(dict) --*

            Configuration information about the auto-merging process.

            * **Enabled** *(boolean) --*

              The flag that enables the auto-merging of duplicate
              profiles.

            * **Consolidation** *(dict) --*

              A list of matching attributes that represent matching
              criteria. If two profiles meet at least one of the
              requirements in the matching attributes list, they will
              be merged.

              * **MatchingAttributesList** *(list) --*

                A list of matching criteria.

                * *(list) --*

                  * *(string) --*

            * **ConflictResolution** *(dict) --*

              How the auto-merging process should resolve conflicts
              between different profiles. For example, if Profile A
              and Profile B have the same "FirstName" and "LastName"
              (and that is the matching criteria), which
              "EmailAddress" should be used?

              * **ConflictResolvingModel** *(string) --*

                How the auto-merging process should resolve conflicts
                between different profiles.

                * "RECENCY": Uses the data that was most recently
                  updated.

                * "SOURCE": Uses the data from a specific source. For
                  example, if a company has been aquired or two
                  departments have merged, data from the specified
                  source is used. If two duplicate profiles are from
                  the same source, then "RECENCY" is used again.

              * **SourceName** *(string) --*

                The "ObjectType" name that is used to resolve profile
                merging conflicts when choosing "SOURCE" as the
                "ConflictResolvingModel".

            * **MinAllowedConfidenceScoreForMerging** *(float) --*

              A number between 0 and 1 that represents the minimum
              confidence score required for profiles within a matching
              group to be merged during the auto-merge process. A
              higher score means higher similarity required to merge
              profiles.

          * **ExportingConfig** *(dict) --*

            Configuration information for exporting Identity
            Resolution results, for example, to an S3 bucket.

            * **S3Exporting** *(dict) --*

              The S3 location where Identity Resolution Jobs write
              result files.

              * **S3BucketName** *(string) --*

                The name of the S3 bucket where Identity Resolution
                Jobs write result files.

              * **S3KeyName** *(string) --*

                The S3 key name of the location where Identity
                Resolution Jobs write result files.

        * **RuleBasedMatching** *(dict) --*

          The process of matching duplicate profiles using the Rule-
          Based matching. If "RuleBasedMatching" = true, Amazon
          Connect Customer Profiles will start to match and merge your
          profiles according to your configuration in the
          "RuleBasedMatchingRequest". You can use the
          "ListRuleBasedMatches" and "GetSimilarProfiles" API to
          return and review the results. Also, if you have configured
          "ExportingConfig" in the "RuleBasedMatchingRequest", you can
          download the results from S3.

          * **Enabled** *(boolean) --*

            The flag that enables the rule-based matching process of
            duplicate profiles.

          * **MatchingRules** *(list) --*

            Configures how the rule-based matching process should
            match profiles. You can have up to 15 "MatchingRule" in
            the "MatchingRules".

            * *(dict) --*

              Specifies how does the rule-based matching process
              should match profiles. You can choose from the following
              attributes to build the matching Rule:

              * AccountNumber

              * Address.Address

              * Address.City

              * Address.Country

              * Address.County

              * Address.PostalCode

              * Address.State

              * Address.Province

              * BirthDate

              * BusinessName

              * EmailAddress

              * FirstName

              * Gender

              * LastName

              * MiddleName

              * PhoneNumber

              * Any customized profile attributes that start with the
                "Attributes"

              * **Rule** *(list) --*

                A single rule level of the "MatchRules". Configures
                how the rule-based matching process should match
                profiles.

                * *(string) --*

          * **Status** *(string) --*

            PENDING

            * The first status after configuration a rule-based
              matching rule. If it is an existing domain, the rule-
              based Identity Resolution waits one hour before creating
              the matching rule. If it is a new domain, the system
              will skip the "PENDING" stage.

            IN_PROGRESS

            * The system is creating the rule-based matching rule.
              Under this status, the system is evaluating the existing
              data and you can no longer change the Rule-based
              matching configuration.

            ACTIVE

            * The rule is ready to use. You can change the rule a day
              after the status is in "ACTIVE".

          * **MaxAllowedRuleLevelForMerging** *(integer) --*

            MatchingRule

          * **MaxAllowedRuleLevelForMatching** *(integer) --*

            Indicates the maximum allowed rule level.

          * **AttributeTypesSelector** *(dict) --*

            Configures information about the "AttributeTypesSelector"
            where the rule-based identity resolution uses to match
            profiles.

            * **AttributeMatchingModel** *(string) --*

              Configures the "AttributeMatchingModel", you can either
              choose "ONE_TO_ONE" or "MANY_TO_MANY".

            * **Address** *(list) --*

              The "Address" type. You can choose from "Address",
              "BusinessAddress", "MaillingAddress", and
              "ShippingAddress".

              You only can use the Address type in the "MatchingRule".
              For example, if you want to match profile based on
              "BusinessAddress.City" or "MaillingAddress.City", you
              need to choose the "BusinessAddress" and the
              "MaillingAddress" to represent the Address type and
              specify the "Address.City" on the matching rule.

              * *(string) --*

            * **PhoneNumber** *(list) --*

              The "PhoneNumber" type. You can choose from
              "PhoneNumber", "HomePhoneNumber", and
              "MobilePhoneNumber".

              You only can use the "PhoneNumber" type in the
              "MatchingRule". For example, if you want to match a
              profile based on "Phone" or "HomePhone", you need to
              choose the "Phone" and the "HomePhone" to represent the
              "PhoneNumber" type and only specify the "PhoneNumber" on
              the matching rule.

              * *(string) --*

            * **EmailAddress** *(list) --*

              The "Email" type. You can choose from "EmailAddress",
              "BusinessEmailAddress" and "PersonalEmailAddress".

              You only can use the "EmailAddress" type in the
              "MatchingRule". For example, if you want to match
              profile based on "PersonalEmailAddress" or
              "BusinessEmailAddress", you need to choose the
              "PersonalEmailAddress" and the "BusinessEmailAddress" to
              represent the "EmailAddress" type and only specify the
              "EmailAddress" on the matching rule.

              * *(string) --*

          * **ConflictResolution** *(dict) --*

            How the auto-merging process should resolve conflicts
            between different profiles.

            * **ConflictResolvingModel** *(string) --*

              How the auto-merging process should resolve conflicts
              between different profiles.

              * "RECENCY": Uses the data that was most recently
                updated.

              * "SOURCE": Uses the data from a specific source. For
                example, if a company has been aquired or two
                departments have merged, data from the specified
                source is used. If two duplicate profiles are from the
                same source, then "RECENCY" is used again.

            * **SourceName** *(string) --*

              The "ObjectType" name that is used to resolve profile
              merging conflicts when choosing "SOURCE" as the
              "ConflictResolvingModel".

          * **ExportingConfig** *(dict) --*

            Configuration information about the S3 bucket where
            Identity Resolution Jobs writes result files.

            Note:

              You need to give Customer Profiles service principal
              write permission to your S3 bucket. Otherwise, you'll
              get an exception in the API response. For an example
              policy, see Amazon Connect Customer Profiles cross-
              service confused deputy prevention.

            * **S3Exporting** *(dict) --*

              The S3 location where Identity Resolution Jobs write
              result files.

              * **S3BucketName** *(string) --*

                The name of the S3 bucket where Identity Resolution
                Jobs write result files.

              * **S3KeyName** *(string) --*

                The S3 key name of the location where Identity
                Resolution Jobs write result files.

        * **CreatedAt** *(datetime) --*

          The timestamp of when the domain was created.

        * **LastUpdatedAt** *(datetime) --*

          The timestamp of when the domain was most recently edited.

        * **Tags** *(dict) --*

          The tags used to organize, track, or control access for this
          resource.

          * *(string) --*

            * *(string) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / get_calculated_attribute_definition


get_calculated_attribute_definition
***********************************

CustomerProfiles.Client.get_calculated_attribute_definition(**kwargs)

   Provides more information on a calculated attribute definition for
   Customer Profiles.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.get_calculated_attribute_definition(
          DomainName='string',
          CalculatedAttributeName='string'
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **CalculatedAttributeName** (*string*) --

        **[REQUIRED]**

        The unique name of the calculated attribute.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'CalculatedAttributeName': 'string',
             'DisplayName': 'string',
             'Description': 'string',
             'CreatedAt': datetime(2015, 1, 1),
             'LastUpdatedAt': datetime(2015, 1, 1),
             'Statistic': 'FIRST_OCCURRENCE'|'LAST_OCCURRENCE'|'COUNT'|'SUM'|'MINIMUM'|'MAXIMUM'|'AVERAGE'|'MAX_OCCURRENCE',
             'Filter': {
                 'Include': 'ALL'|'ANY'|'NONE',
                 'Groups': [
                     {
                         'Type': 'ALL'|'ANY'|'NONE',
                         'Dimensions': [
                             {
                                 'Attributes': {
                                     'string': {
                                         'DimensionType': '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': [
                                             'string',
                                         ]
                                     }
                                 }
                             },
                         ]
                     },
                 ]
             },
             'Conditions': {
                 'Range': {
                     'Value': 123,
                     'Unit': 'DAYS',
                     'ValueRange': {
                         'Start': 123,
                         'End': 123
                     },
                     'TimestampSource': 'string',
                     'TimestampFormat': 'string'
                 },
                 'ObjectCount': 123,
                 'Threshold': {
                     'Value': 'string',
                     'Operator': 'EQUAL_TO'|'GREATER_THAN'|'LESS_THAN'|'NOT_EQUAL_TO'
                 }
             },
             'AttributeDetails': {
                 'Attributes': [
                     {
                         'Name': 'string'
                     },
                 ],
                 'Expression': 'string'
             },
             'UseHistoricalData': True|False,
             'Status': 'PREPARING'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
             'Readiness': {
                 'ProgressPercentage': 123,
                 'Message': 'string'
             },
             'Tags': {
                 'string': 'string'
             }
         }

      **Response Structure**

      * *(dict) --*

        * **CalculatedAttributeName** *(string) --*

          The unique name of the calculated attribute.

        * **DisplayName** *(string) --*

          The display name of the calculated attribute.

        * **Description** *(string) --*

          The description of the calculated attribute.

        * **CreatedAt** *(datetime) --*

          The timestamp of when the calculated attribute definition
          was created.

        * **LastUpdatedAt** *(datetime) --*

          The timestamp of when the calculated attribute definition
          was most recently edited.

        * **Statistic** *(string) --*

          The aggregation operation to perform for the calculated
          attribute.

        * **Filter** *(dict) --*

          The filter assigned to this calculated attribute definition.

          * **Include** *(string) --*

            Define whether to include or exclude objects for
            Calculated Attributed calculation that fit the filter
            groups criteria.

          * **Groups** *(list) --*

            Holds the list of Filter groups within the Filter
            definition.

            * *(dict) --*

              Object that holds the dimensions to filter on.

              * **Type** *(string) --*

                The type of logical relationship between the
                dimensions of the Filter group.

              * **Dimensions** *(list) --*

                Object that holds the attributes to filter on.

                * *(dict) --*

                  Contains the map of attribute names to attribute
                  dimensions.

                  * **Attributes** *(dict) --*

                    Is the attribute within the FilterDimension map

                    * *(string) --*

                      * *(dict) --*

                        Object that defines how to filter the incoming
                        objects for the calculated attribute.

                        * **DimensionType** *(string) --*

                          The action to filter with.

                        * **Values** *(list) --*

                          The values to apply the DimensionType on.

                          * *(string) --*

        * **Conditions** *(dict) --*

          The conditions including range, object count, and threshold
          for the calculated attribute.

          * **Range** *(dict) --*

            The relative time period over which data is included in
            the aggregation.

            * **Value** *(integer) --*

              The amount of time of the specified unit.

            * **Unit** *(string) --*

              The unit of time.

            * **ValueRange** *(dict) --*

              A structure letting customers specify a relative time
              window over which over which data is included in the
              Calculated Attribute. Use positive numbers to indicate
              that the endpoint is in the past, and negative numbers
              to indicate it is in the future. ValueRange overrides
              Value.

              * **Start** *(integer) --*

                The start time of when to include objects. Use
                positive numbers to indicate that the starting point
                is in the past, and negative numbers to indicate it is
                in the future.

              * **End** *(integer) --*

                The end time of when to include objects. Use positive
                numbers to indicate that the starting point is in the
                past, and negative numbers to indicate it is in the
                future.

            * **TimestampSource** *(string) --*

              An expression specifying the field in your JSON object
              from which the date should be parsed. The expression
              should follow the structure of
              "{ObjectTypeName.<Location of timestamp field in JSON
              pointer format>}". E.g. if your object type is MyType
              and source JSON is {"generatedAt": {"timestamp":
              "1737587945945"}}, then TimestampSource should be
              "{MyType.generatedAt.timestamp}".

            * **TimestampFormat** *(string) --*

              The format the timestamp field in your JSON object is
              specified. This value should be one of EPOCHMILLI (for
              Unix epoch timestamps with second/millisecond level
              precision) or ISO_8601 (following ISO_8601 format with
              second/millisecond level precision, with an optional
              offset of Z or in the format HH:MM or HHMM.). E.g. if
              your object type is MyType and source JSON is
              {"generatedAt": {"timestamp":
              "2001-07-04T12:08:56.235-0700"}}, then TimestampFormat
              should be "ISO_8601".

          * **ObjectCount** *(integer) --*

            The number of profile objects used for the calculated
            attribute.

          * **Threshold** *(dict) --*

            The threshold for the calculated attribute.

            * **Value** *(string) --*

              The value of the threshold.

            * **Operator** *(string) --*

              The operator of the threshold.

        * **AttributeDetails** *(dict) --*

          Mathematical expression and a list of attribute items
          specified in that expression.

          * **Attributes** *(list) --*

            A list of attribute items specified in the mathematical
            expression.

            * *(dict) --*

              The details of a single attribute item specified in the
              mathematical expression.

              * **Name** *(string) --*

                The name of an attribute defined in a profile object
                type.

          * **Expression** *(string) --*

            Mathematical expression that is performed on attribute
            items provided in the attribute list. Each element in the
            expression should follow the structure of
            "{ObjectTypeName.AttributeName}".

        * **UseHistoricalData** *(boolean) --*

          Whether historical data ingested before the Calculated
          Attribute was created should be included in calculations.

        * **Status** *(string) --*

          Status of the Calculated Attribute creation (whether all
          historical data has been indexed).

        * **Readiness** *(dict) --*

          Information indicating if the Calculated Attribute is ready
          for use by confirming all historical data has been processed
          and reflected.

          * **ProgressPercentage** *(integer) --*

            Approximately how far the Calculated Attribute creation is
            from completion.

          * **Message** *(string) --*

            Any customer messaging.

        * **Tags** *(dict) --*

          The tags used to organize, track, or control access for this
          resource.

          * *(string) --*

            * *(string) --*

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"
CustomerProfiles / Client / delete_profile_object_type


delete_profile_object_type
**************************

CustomerProfiles.Client.delete_profile_object_type(**kwargs)

   Removes a ProfileObjectType from a specific domain as well as
   removes all the ProfileObjects of that type. It also disables
   integrations from this specific ProfileObjectType. In addition, it
   scrubs all of the fields of the standard profile that were
   populated from this ProfileObjectType.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.delete_profile_object_type(
          DomainName='string',
          ObjectTypeName='string'
      )

   Parameters:
      * **DomainName** (*string*) --

        **[REQUIRED]**

        The unique name of the domain.

      * **ObjectTypeName** (*string*) --

        **[REQUIRED]**

        The name of the profile object type.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'Message': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **Message** *(string) --*

          A message that indicates the delete request is done.

   **Exceptions**

   * "CustomerProfiles.Client.exceptions.BadRequestException"

   * "CustomerProfiles.Client.exceptions.ResourceNotFoundException"

   * "CustomerProfiles.Client.exceptions.AccessDeniedException"

   * "CustomerProfiles.Client.exceptions.ThrottlingException"

   * "CustomerProfiles.Client.exceptions.InternalServerException"