:doc:`VoiceID <../../voice-id>` / Paginator / ListSpeakers

************
ListSpeakers
************



.. py:class:: VoiceID.Paginator.ListSpeakers

  ::

    
    paginator = client.get_paginator('list_speakers')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`VoiceID.Client.list_speakers`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListSpeakers>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          DomainId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type DomainId: string
    :param DomainId: **[REQUIRED]** 

      The identifier of the domain.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

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

      
      ::

        {
            'SpeakerSummaries': [
                {
                    'CreatedAt': datetime(2015, 1, 1),
                    'CustomerSpeakerId': 'string',
                    'DomainId': 'string',
                    'GeneratedSpeakerId': 'string',
                    'LastAccessedAt': datetime(2015, 1, 1),
                    'Status': 'ENROLLED'|'EXPIRED'|'OPTED_OUT'|'PENDING',
                    'UpdatedAt': datetime(2015, 1, 1)
                },
            ]
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **SpeakerSummaries** *(list) --* 

          A list containing details about each speaker in the Amazon Web Services account.

          
          

          - *(dict) --* 

            Contains a summary of information about a speaker.

            
            

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

              A timestamp showing the speaker's creation time.

              
            

            - **CustomerSpeakerId** *(string) --* 

              The client-provided identifier for the speaker.

              
            

            - **DomainId** *(string) --* 

              The identifier of the domain that contains the speaker.

              
            

            - **GeneratedSpeakerId** *(string) --* 

              The service-generated identifier for the speaker.

              
            

            - **LastAccessedAt** *(datetime) --* 

              The timestamp when the speaker was last accessed for enrollment, re-enrollment or a successful authentication. This timestamp is accurate to one hour.

              
            

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

              The current status of the speaker.

              
            

            - **UpdatedAt** *(datetime) --* 

              A timestamp showing the speaker's last update.

              
        
      
    