CleanRoomsService / Client / list_schemas

list_schemas#

CleanRoomsService.Client.list_schemas(**kwargs)#

Lists the schemas for relations within a collaboration.

See also: AWS API Documentation

Request Syntax

response = client.list_schemas(
    collaborationIdentifier='string',
    schemaType='TABLE'|'ID_MAPPING_TABLE',
    nextToken='string',
    maxResults=123
)
Parameters:

  • collaborationIdentifier (string) –

    [REQUIRED]

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

  • schemaType (string) – If present, filter schemas by schema type. The only valid schema type is currently TABLE.

  • nextToken (string) – The token value retrieved from a previous call to access the next page of results.

  • maxResults (integer) – The maximum size of the results that is returned per call.

Return type:

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'
        },
    ],
    '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. The only valid schema type is currently TABLE.

        • 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. The only valid value is currently DIRECT_QUERY.

    • nextToken (string) –

      The token value retrieved from a previous call to access the next page of results.

Exceptions

  • CleanRoomsService.Client.exceptions.ResourceNotFoundException

  • CleanRoomsService.Client.exceptions.InternalServerException

  • CleanRoomsService.Client.exceptions.ValidationException

  • CleanRoomsService.Client.exceptions.ThrottlingException

  • CleanRoomsService.Client.exceptions.AccessDeniedException