:doc:`CleanRoomsService <../../cleanrooms>` / Client / list_schemas

************
list_schemas
************



.. py:method:: CleanRoomsService.Client.list_schemas(**kwargs)

  

  Lists the schemas for relations within a collaboration.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListSchemas>`_  


  **Request Syntax**
  ::

    response = client.list_schemas(
        collaborationIdentifier='string',
        schemaType='TABLE'|'ID_MAPPING_TABLE',
        nextToken='string',
        maxResults=123
    )
    
  :type collaborationIdentifier: string
  :param collaborationIdentifier: **[REQUIRED]** 

    A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.

    

  
  :type schemaType: string
  :param schemaType: 

    If present, filter schemas by schema type.

    

  
  :type nextToken: string
  :param nextToken: 

    The pagination token that's used to fetch the next set of results.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.

    

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

    
    ::

      {
          'schemaSummaries': [
              {
                  'name': 'string',
                  'type': 'TABLE'|'ID_MAPPING_TABLE',
                  'creatorAccountId': 'string',
                  'createTime': datetime(2015, 1, 1),
                  'updateTime': datetime(2015, 1, 1),
                  'collaborationId': 'string',
                  'collaborationArn': 'string',
                  'analysisRuleTypes': [
                      'AGGREGATION'|'LIST'|'CUSTOM'|'ID_MAPPING_TABLE',
                  ],
                  'analysisMethod': 'DIRECT_QUERY'|'DIRECT_JOB'|'MULTIPLE',
                  'resourceArn': 'string',
                  'selectedAnalysisMethods': [
                      'DIRECT_QUERY'|'DIRECT_JOB',
                  ]
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **schemaSummaries** *(list) --* 

        The retrieved list of schemas.

        
        

        - *(dict) --* 

          The schema summary for the objects listed by the request.

          
          

          - **name** *(string) --* 

            The name for the schema object.

            
          

          - **type** *(string) --* 

            The type of schema object.

            
          

          - **creatorAccountId** *(string) --* 

            The unique account ID for the Amazon Web Services account that owns the schema.

            
          

          - **createTime** *(datetime) --* 

            The time the schema object was created.

            
          

          - **updateTime** *(datetime) --* 

            The time the schema object was last updated.

            
          

          - **collaborationId** *(string) --* 

            The unique ID for the collaboration that the schema belongs to.

            
          

          - **collaborationArn** *(string) --* 

            The unique ARN for the collaboration that the schema belongs to.

            
          

          - **analysisRuleTypes** *(list) --* 

            The types of analysis rules that are associated with this schema object.

            
            

            - *(string) --* 
        
          

          - **analysisMethod** *(string) --* 

            The analysis method for the associated schema.

             

            ``DIRECT_QUERY`` allows SQL queries to be run directly on this table.

             

            ``DIRECT_JOB`` allows PySpark jobs to be run directly on this table.

             

            ``MULTIPLE`` allows both SQL queries and PySpark jobs to be run directly on this table.

            
          

          - **resourceArn** *(string) --* 

            The Amazon Resource Name (ARN) of the schema summary resource.

            
          

          - **selectedAnalysisMethods** *(list) --* 

            The selected analysis methods for the schema.

            
            

            - *(string) --* 
        
      
    
      

      - **nextToken** *(string) --* 

        The pagination token that's used to fetch the next set of results.

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

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

  
  *   :py:class:`CleanRoomsService.Client.exceptions.ValidationException`

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

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

  