CustomerProfiles

Client

class CustomerProfiles.Client

A low-level client representing Amazon Connect Customer Profiles

Welcome to the Amazon Connect Customer Profiles API Reference. This guide provides information about the Amazon Connect Customer Profiles API, including supported operations, data types, parameters, and schemas.

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.

If you're new to Amazon Connect , you might find it helpful to also review the Amazon Connect Administrator Guide .

client = session.create_client('customer-profiles')

These are the available methods:

add_profile_key(**kwargs)

Associates a new key value with a specific profile, such as a Contact Trace Record (CTR) 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.

  • 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

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.
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.

See also: AWS API Documentation

Request Syntax

response = client.create_domain(
    DomainName='string',
    DefaultExpirationDays=123,
    DefaultEncryptionKey='string',
    DeadLetterQueueUrl='string',
    Matching={
        'Enabled': True|False
    },
    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 every Saturday at 12AM UTC to detect duplicate profiles in your domains. After that batch process completes, use the GetMatches API to return and review the results.

    • Enabled (boolean) -- [REQUIRED]

      The flag that enables the matching process of duplicate profiles.

  • 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
    },
    '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 every Saturday at 12AM UTC to detect duplicate profiles in your domains. After that batch process completes, use the GetMatches API to return and review the results.

      • Enabled (boolean) --

        The flag that enables the matching process of duplicate profiles.

    • 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

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'
    }
)
Parameters
  • DomainName (string) --

    [REQUIRED]

    The unique name of the domain.

  • AccountNumber (string) -- A unique account number that you have given 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) --
Return type

dict

Returns

Response Syntax

{
    'ProfileId': 'string'
}

Response Structure

  • (dict) --

    • ProfileId (string) --

      The unique identifier of a customer profile.

Exceptions

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

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

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

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

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

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

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

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
    },
    '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 every Saturday at 12AM UTC to detect duplicate profiles in your domains. After that batch process completes, use the GetMatches API to return and review the results.

      • Enabled (boolean) --

        The flag that enables the matching process of duplicate profiles.

    • 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

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'
    }
}

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) --

Exceptions

get_matches(**kwargs)

This API is in preview release for Amazon Connect and subject to change.

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

Amazon Connect starts a batch process every Saturday at 12AM UTC to identify matching profiles. The results are returned up to seven days after the Saturday run.

Amazon Connect uses the following profile attributes to identify matches:

  • PhoneNumber
  • HomePhoneNumber
  • BusinessPhoneNumber
  • MobilePhoneNumber
  • EmailAddress
  • PersonalEmailAddress
  • BusinessEmailAddress
  • FullName
  • BusinessName

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',
            ]
        },
    ]
}

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) --

Exceptions

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
L{botocore.paginate.Paginator}
Returns
A paginator object.
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,
    'Fields': {
        'string': {
            'Source': 'string',
            'Target': 'string',
            'ContentType': 'STRING'|'NUMBER'|'PHONE_NUMBER'|'EMAIL_ADDRESS'|'NAME'
        }
    },
    'Keys': {
        'string': [
            {
                'StandardIdentifiers': [
                    'PROFILE'|'ASSET'|'CASE'|'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.

    • 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 or CASE means that this key can be used to tie an object to a PROFILE, ASSET or CASE 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

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,
    'Fields': {
        'string': {
            'Source': 'string',
            'Target': 'string',
            'ContentType': 'STRING'|'NUMBER'|'PHONE_NUMBER'|'EMAIL_ADDRESS'|'NAME'
        }
    },
    'Keys': {
        'string': [
            {
                'StandardIdentifiers': [
                    'PROFILE'|'ASSET'|'CASE'|'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.

    • 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 or CASE means that this key can be used to tie an object to a PROFILE, ASSET or CASE 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

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
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
)
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.
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'
            }
        },
    ],
    '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) --
    • NextToken (string) --

      The pagination token from the previous ListAccountIntegrations API call.

Exceptions

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

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
)
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.
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'
            }
        },
    ],
    '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) --
    • NextToken (string) --

      The pagination token from the previous ListIntegrations API call.

Exceptions

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

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),
            '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.

        • 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

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. This filter is only supported for ObjectTypeName _asset and _case.

    • KeyName (string) -- [REQUIRED]

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

    • 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

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

merge_profiles(**kwargs)

This API is in preview release for Amazon Connect and subject to change.

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'
        }
    }
)
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) --
Return type

dict

Returns

Response Syntax

{
    'Message': 'string'
}

Response Structure

  • (dict) --

    • Message (string) --

      A message that indicates the merge request is complete.

Exceptions

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.

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)
                }
            }
        }
    }
)
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) --

    [REQUIRED]

    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.

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'
    }
}

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) --

Exceptions

put_profile_object(**kwargs)

Adds additional objects to customer profiles of a given ObjectType.

When adding a specific profile object, like a Contact Trace Record (CTR), 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 CTRs 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

put_profile_object_type(**kwargs)

Defines a ProfileObjectType.

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,
    Fields={
        'string': {
            'Source': 'string',
            'Target': 'string',
            'ContentType': 'STRING'|'NUMBER'|'PHONE_NUMBER'|'EMAIL_ADDRESS'|'NAME'
        }
    },
    Keys={
        'string': [
            {
                'StandardIdentifiers': [
                    'PROFILE'|'ASSET'|'CASE'|'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.
  • 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.
  • 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 or CASE means that this key can be used to tie an object to a PROFILE, ASSET or CASE 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,
    'Fields': {
        'string': {
            'Source': 'string',
            'Target': 'string',
            'ContentType': 'STRING'|'NUMBER'|'PHONE_NUMBER'|'EMAIL_ADDRESS'|'NAME'
        }
    },
    'Keys': {
        'string': [
            {
                'StandardIdentifiers': [
                    'PROFILE'|'ASSET'|'CASE'|'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.

    • 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 or CASE means that this key can be used to tie an object to a PROFILE, ASSET or CASE 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

search_profiles(**kwargs)

Searches for profiles within a specific domain name using name, phone number, email address, account number, or a custom defined index.

See also: AWS API Documentation

Request Syntax

response = client.search_profiles(
    NextToken='string',
    MaxResults=123,
    DomainName='string',
    KeyName='string',
    Values=[
        'string',
    ]
)
Parameters
  • NextToken (string) -- The pagination token from the previous SearchProfiles API call.
  • MaxResults (integer) -- The maximum number of objects returned per page.
  • 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, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _zendeskUserId, _zendeskExternalId, _serviceNowSystemId.

  • Values (list) --

    [REQUIRED]

    A list of key values.

    • (string) --
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'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Items (list) --

      The list of SearchProfiles instances.

      • (dict) --

        The standard profile of a customer.

        • ProfileId (string) --

          The unique identifier of a customer profile.

        • AccountNumber (string) --

          A unique account number that you have given 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) --
    • NextToken (string) --

      The pagination token from the previous SearchProfiles API call.

Exceptions

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

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

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.

See also: AWS API Documentation

Request Syntax

response = client.update_domain(
    DomainName='string',
    DefaultExpirationDays=123,
    DefaultEncryptionKey='string',
    DeadLetterQueueUrl='string',
    Matching={
        'Enabled': True|False
    },
    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 every Saturday at 12AM UTC to detect duplicate profiles in your domains. After that batch process completes, use the GetMatches API to return and review the results.

    • Enabled (boolean) -- [REQUIRED]

      The flag that enables the matching process of duplicate profiles.

  • 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
    },
    '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 every Saturday at 12AM UTC to detect duplicate profiles in your domains. After that batch process completes, use the GetMatches API to return and review the results.

      • Enabled (boolean) --

        The flag that enables the matching process of duplicate profiles.

    • 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

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'
    }
)
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) -- A unique account number that you have given 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) --
Return type

dict

Returns

Response Syntax

{
    'ProfileId': 'string'
}

Response Structure

  • (dict) --

    • ProfileId (string) --

      The unique identifier of a customer profile.

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class CustomerProfiles.Client.exceptions.AccessDeniedException

You do not have sufficient access to perform this action.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You do not have sufficient access to perform this action.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CustomerProfiles.Client.exceptions.BadRequestException

The input you provided is invalid.

Example

try:
  ...
except client.exceptions.BadRequestException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The input you provided is invalid.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CustomerProfiles.Client.exceptions.InternalServerException

An internal service error occurred.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    An internal service error occurred.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CustomerProfiles.Client.exceptions.ResourceNotFoundException

The requested resource does not exist, or access was denied.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The requested resource does not exist, or access was denied.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CustomerProfiles.Client.exceptions.ThrottlingException

You exceeded the maximum number of requests.

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You exceeded the maximum number of requests.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are: