:doc:`Schemas <../../schemas>` / Paginator / SearchSchemas

*************
SearchSchemas
*************



.. py:class:: Schemas.Paginator.SearchSchemas

  ::

    
    paginator = client.get_paginator('search_schemas')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Schemas.Client.search_schemas`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/schemas-2019-12-02/SearchSchemas>`_    


    **Request Syntax**
    ::

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

      Specifying this limits the results to only schemas that include the provided keywords.

      

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

      The name of the registry.

      

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

      
      ::

        {
            'Schemas': [
                {
                    'RegistryName': 'string',
                    'SchemaArn': 'string',
                    'SchemaName': 'string',
                    'SchemaVersions': [
                        {
                            'CreatedDate': datetime(2015, 1, 1),
                            'SchemaVersion': 'string',
                            'Type': 'OpenApi3'|'JSONSchemaDraft4'
                        },
                    ]
                },
            ]
        }
        
      **Response Structure**

      

      - *(dict) --* 

        200 response

        
        

        - **Schemas** *(list) --* 

          An array of SearchSchemaSummary information.

          
          

          - *(dict) --* 
            

            - **RegistryName** *(string) --* 

              The name of the registry.

              
            

            - **SchemaArn** *(string) --* 

              The ARN of the schema.

              
            

            - **SchemaName** *(string) --* 

              The name of the schema.

              
            

            - **SchemaVersions** *(list) --* 

              An array of schema version summaries.

              
              

              - *(dict) --* 
                

                - **CreatedDate** *(datetime) --* 

                  The date the schema version was created.

                  
                

                - **SchemaVersion** *(string) --* 

                  The version number of the schema

                  
                

                - **Type** *(string) --* 

                  The type of schema.

                  
            
          
        
      
    