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

***********************
create_segment_snapshot
***********************



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

  

  Triggers a job to export a segment to a specified destination.

  

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


  **Request Syntax**
  ::

    response = client.create_segment_snapshot(
        DomainName='string',
        SegmentDefinitionName='string',
        DataFormat='CSV'|'JSONL'|'ORC',
        EncryptionKey='string',
        RoleArn='string',
        DestinationUri='string'
    )
    
  :type DomainName: string
  :param DomainName: **[REQUIRED]** 

    The unique name of the domain.

    

  
  :type SegmentDefinitionName: string
  :param SegmentDefinitionName: **[REQUIRED]** 

    The name of the segment definition used in this snapshot request.

    

  
  :type DataFormat: string
  :param DataFormat: **[REQUIRED]** 

    The format in which the segment will be exported.

    

  
  :type EncryptionKey: string
  :param EncryptionKey: 

    The Amazon Resource Name (ARN) of the KMS key used to encrypt the exported segment.

    

  
  :type RoleArn: string
  :param RoleArn: 

    The Amazon Resource Name (ARN) of the IAM role that allows Customer Profiles service principal to assume the role for conducting KMS and S3 operations.

    

  
  :type DestinationUri: string
  :param DestinationUri: 

    The destination to which the segment will be exported. This field must be provided if the request is not submitted from the Amazon Connect Admin Website.

    

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

    
    ::

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

    

    - *(dict) --* 
      

      - **SnapshotId** *(string) --* 

        The unique identifier of the segment snapshot.

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

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

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

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

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

  