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

********************
get_segment_snapshot
********************



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

  

  Retrieve the latest status of a segment snapshot.

  

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


  **Request Syntax**
  ::

    response = client.get_segment_snapshot(
        DomainName='string',
        SegmentDefinitionName='string',
        SnapshotId='string'
    )
    
  :type DomainName: string
  :param DomainName: **[REQUIRED]** 

    The unique identifier of the domain.

    

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

    The unique name of the segment definition.

    

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

    The unique identifier of the segment snapshot.

    

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

    
    ::

      {
          'SnapshotId': 'string',
          'Status': 'COMPLETED'|'IN_PROGRESS'|'FAILED',
          'StatusMessage': 'string',
          'DataFormat': 'CSV'|'JSONL'|'ORC',
          'EncryptionKey': 'string',
          'RoleArn': 'string',
          'DestinationUri': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The unique identifier of the segment snapshot.

        
      

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

        The status of the asynchronous job for exporting the segment snapshot.

        
      

      - **StatusMessage** *(string) --* 

        The status message of the asynchronous job for exporting the segment snapshot.

        
      

      - **DataFormat** *(string) --* 

        The format in which the segment will be exported.

        
      

      - **EncryptionKey** *(string) --* 

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

        
      

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

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

        
      

      - **DestinationUri** *(string) --* 

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

        
  
  **Exceptions**
  
  *   :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`

  