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

************************
list_segment_definitions
************************



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

  

  Lists all segment definitions under a domain.

  

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


  **Request Syntax**
  ::

    response = client.list_segment_definitions(
        DomainName='string',
        MaxResults=123,
        NextToken='string'
    )
    
  :type DomainName: string
  :param DomainName: **[REQUIRED]** 

    The unique identifier of the domain.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of objects returned per page.

    

  
  :type NextToken: string
  :param NextToken: 

    The pagination token from the previous call.

    

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

    
    ::

      {
          'NextToken': 'string',
          'Items': [
              {
                  'SegmentDefinitionName': 'string',
                  'DisplayName': 'string',
                  'Description': 'string',
                  'SegmentDefinitionArn': 'string',
                  'CreatedAt': datetime(2015, 1, 1),
                  'Tags': {
                      'string': 'string'
                  },
                  'SegmentType': 'CLASSIC'|'ENHANCED'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The pagination token from the previous call.

        
      

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

        List of segment definitions.

        
        

        - *(dict) --* 

          Object holding the segment definition fields.

          
          

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

            Name of the segment definition.

            
          

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

            Display name of the segment definition.

            
          

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

            The description of the segment definition.

            
          

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

            The arn of the segment definition.

            
          

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

            When the segment definition was created.

            
          

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

            The tags belonging to the segment definition.

            
            

            - *(string) --* 
              

              - *(string) --* 
        
      
          

          - **SegmentType** *(string) --* 

            The segment type.

             

            Classic : Segments created using traditional SegmentGroup structure

             

            Enhanced : Segments created using SQL queries

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

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

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

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

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

  