get_schema#

CleanRoomsService.Client.get_schema(**kwargs)#

Retrieves the schema for a relation within a collaboration.

Request Syntax

response = client.get_schema(
    collaborationIdentifier='string',
    name='string'
)

Parameters:

collaborationIdentifier (string) –
[REQUIRED]

A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.
name (string) –
[REQUIRED]

The name of the relation to retrieve the schema for.

Return type:

dict

Returns:

Response Syntax

{
    'schema': {
        'columns': [
            {
                'name': 'string',
                'type': 'string'
            },
        ],
        'partitionKeys': [
            {
                'name': 'string',
                'type': 'string'
            },
        ],
        'analysisRuleTypes': [
            'AGGREGATION'|'LIST',
        ],
        'analysisMethod': 'DIRECT_QUERY',
        'creatorAccountId': 'string',
        'name': 'string',
        'collaborationId': 'string',
        'collaborationArn': 'string',
        'description': 'string',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'type': 'TABLE'
    }
}

Response Structure

(dict) –
- schema (dict) –
  
  The entire schema object.
  - columns (list) –
    
    The columns for the relation this schema represents.
    - (dict) –
      
      A column within a schema relation, derived from the underlying AWS Glue table.
      - name (string) –
        
        The name of the column.
      - type (string) –
        
        The type of the column.
  - partitionKeys (list) –
    
    The partition keys for the dataset underlying this schema.
    - (dict) –
      
      A column within a schema relation, derived from the underlying AWS Glue table.
      - name (string) –
        
        The name of the column.
      - type (string) –
        
        The type of the column.
  - analysisRuleTypes (list) –
    
    The analysis rule types associated with the schema. Valued values are LIST and AGGREGATION. Currently, only one entry is present.
    - (string) –
  - analysisMethod (string) –
    
    The analysis method for the schema. The only valid value is currently DIRECT_QUERY.
  - creatorAccountId (string) –
    
    The unique account ID for the AWS account that owns the schema.
  - name (string) –
    
    A name for the schema. The schema relation is referred to by this name when queried by a protected query.
  - 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.
  - description (string) –
    
    A description for the schema.
  - createTime (datetime) –
    
    The time the schema was created.
  - updateTime (datetime) –
    
    The time the schema was last updated.
  - type (string) –
    
    The type of schema. The only valid value is currently TABLE.

Exceptions

CleanRoomsService.Client.exceptions.ResourceNotFoundException
CleanRoomsService.Client.exceptions.InternalServerException
CleanRoomsService.Client.exceptions.ValidationException
CleanRoomsService.Client.exceptions.ThrottlingException
CleanRoomsService.Client.exceptions.AccessDeniedException