:doc:`CustomerProfiles <../../customer-profiles>` / Client / create_profile

**************
create_profile
**************



.. py:method:: CustomerProfiles.Client.create_profile(**kwargs)

  

  Creates a standard profile.

   

  A standard profile represents the following attributes for a customer profile in a domain.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateProfile>`_  


  **Request Syntax**
  ::

    response = client.create_profile(
        DomainName='string',
        AccountNumber='string',
        AdditionalInformation='string',
        PartyType='INDIVIDUAL'|'BUSINESS'|'OTHER',
        BusinessName='string',
        FirstName='string',
        MiddleName='string',
        LastName='string',
        BirthDate='string',
        Gender='MALE'|'FEMALE'|'UNSPECIFIED',
        PhoneNumber='string',
        MobilePhoneNumber='string',
        HomePhoneNumber='string',
        BusinessPhoneNumber='string',
        EmailAddress='string',
        PersonalEmailAddress='string',
        BusinessEmailAddress='string',
        Address={
            'Address1': 'string',
            'Address2': 'string',
            'Address3': 'string',
            'Address4': 'string',
            'City': 'string',
            'County': 'string',
            'State': 'string',
            'Province': 'string',
            'Country': 'string',
            'PostalCode': 'string'
        },
        ShippingAddress={
            'Address1': 'string',
            'Address2': 'string',
            'Address3': 'string',
            'Address4': 'string',
            'City': 'string',
            'County': 'string',
            'State': 'string',
            'Province': 'string',
            'Country': 'string',
            'PostalCode': 'string'
        },
        MailingAddress={
            'Address1': 'string',
            'Address2': 'string',
            'Address3': 'string',
            'Address4': 'string',
            'City': 'string',
            'County': 'string',
            'State': 'string',
            'Province': 'string',
            'Country': 'string',
            'PostalCode': 'string'
        },
        BillingAddress={
            'Address1': 'string',
            'Address2': 'string',
            'Address3': 'string',
            'Address4': 'string',
            'City': 'string',
            'County': 'string',
            'State': 'string',
            'Province': 'string',
            'Country': 'string',
            'PostalCode': 'string'
        },
        Attributes={
            'string': 'string'
        },
        PartyTypeString='string',
        GenderString='string',
        ProfileType='ACCOUNT_PROFILE'|'PROFILE',
        EngagementPreferences={
            'Phone': [
                {
                    'KeyName': 'string',
                    'KeyValue': 'string',
                    'ProfileId': 'string',
                    'ContactType': 'PhoneNumber'|'MobilePhoneNumber'|'HomePhoneNumber'|'BusinessPhoneNumber'|'EmailAddress'|'PersonalEmailAddress'|'BusinessEmailAddress'
                },
            ],
            'Email': [
                {
                    'KeyName': 'string',
                    'KeyValue': 'string',
                    'ProfileId': 'string',
                    'ContactType': 'PhoneNumber'|'MobilePhoneNumber'|'HomePhoneNumber'|'BusinessPhoneNumber'|'EmailAddress'|'PersonalEmailAddress'|'BusinessEmailAddress'
                },
            ]
        }
    )
    
  :type DomainName: string
  :param DomainName: **[REQUIRED]** 

    The unique name of the domain.

    

  
  :type AccountNumber: string
  :param AccountNumber: 

    An account number that you have assigned to the customer.

    

  
  :type AdditionalInformation: string
  :param AdditionalInformation: 

    Any additional information relevant to the customer’s profile.

    

  
  :type PartyType: string
  :param PartyType: 

    The type of profile used to describe the customer.

    

  
  :type BusinessName: string
  :param BusinessName: 

    The name of the customer’s business.

    

  
  :type FirstName: string
  :param FirstName: 

    The customer’s first name.

    

  
  :type MiddleName: string
  :param MiddleName: 

    The customer’s middle name.

    

  
  :type LastName: string
  :param LastName: 

    The customer’s last name.

    

  
  :type BirthDate: string
  :param BirthDate: 

    The customer’s birth date.

    

  
  :type Gender: string
  :param Gender: 

    The gender with which the customer identifies.

    

  
  :type PhoneNumber: string
  :param PhoneNumber: 

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

    

  
  :type MobilePhoneNumber: string
  :param MobilePhoneNumber: 

    The customer’s mobile phone number.

    

  
  :type HomePhoneNumber: string
  :param HomePhoneNumber: 

    The customer’s home phone number.

    

  
  :type BusinessPhoneNumber: string
  :param BusinessPhoneNumber: 

    The customer’s business phone number.

    

  
  :type EmailAddress: string
  :param EmailAddress: 

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

    

  
  :type PersonalEmailAddress: string
  :param PersonalEmailAddress: 

    The customer’s personal email address.

    

  
  :type BusinessEmailAddress: string
  :param BusinessEmailAddress: 

    The customer’s business email address.

    

  
  :type Address: dict
  :param Address: 

    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.

      

    
  
  :type ShippingAddress: dict
  :param ShippingAddress: 

    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.

      

    
  
  :type MailingAddress: dict
  :param MailingAddress: 

    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.

      

    
  
  :type BillingAddress: dict
  :param BillingAddress: 

    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.

      

    
  
  :type Attributes: dict
  :param Attributes: 

    A key value pair of attributes of a customer profile.

    

  
    - *(string) --* 

    
      - *(string) --* 

      


  :type PartyTypeString: string
  :param PartyTypeString: 

    An alternative to ``PartyType`` which accepts any string as input.

    

  
  :type GenderString: string
  :param GenderString: 

    An alternative to ``Gender`` which accepts any string as input.

    

  
  :type ProfileType: string
  :param ProfileType: 

    The type of the profile.

    

  
  :type EngagementPreferences: dict
  :param EngagementPreferences: 

    Object that defines the preferred methods of engagement, per channel.

    

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

      A list of phone-related contact preferences

      

    
      - *(dict) --* 

        Object that defines users contact preference.

        

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

          A searchable, unique identifier of a customer profile.

          

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

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

          

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

          The unique identifier of a customer profile.

          

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

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

          

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

      A list of email-related contact preferences

      

    
      - *(dict) --* 

        Object that defines users contact preference.

        

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

          A searchable, unique identifier of a customer profile.

          

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

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

          

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

          The unique identifier of a customer profile.

          

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

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

          

        
      
  
  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'ProfileId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The unique identifier of a customer profile.

        
  
  **Exceptions**
  
  *   :py:class:`CustomerProfiles.Client.exceptions.BadRequestException`

  
  *   :py:class:`CustomerProfiles.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`CustomerProfiles.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`CustomerProfiles.Client.exceptions.ThrottlingException`

  
  *   :py:class:`CustomerProfiles.Client.exceptions.InternalServerException`

  