CleanRoomsService / Client / get_schema

get_schema

CleanRoomsService.Client.get_schema(**kwargs)

Retrieves the schema for a relation within a collaboration.

See also: AWS API Documentation

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'|'CUSTOM',
        ],
        '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',
        'schemaStatusDetails': [
            {
                'status': 'READY'|'NOT_READY',
                'reasons': [
                    {
                        'code': 'ANALYSIS_RULE_MISSING'|'ANALYSIS_TEMPLATES_NOT_CONFIGURED'|'ANALYSIS_PROVIDERS_NOT_CONFIGURED'|'DIFFERENTIAL_PRIVACY_POLICY_NOT_CONFIGURED',
                        'message': 'string'
                    },
                ],
                'analysisRuleType': 'AGGREGATION'|'LIST'|'CUSTOM',
                'configurations': [
                    'DIFFERENTIAL_PRIVACY',
                ]
            },
        ]
    }
}

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 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 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. 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 Amazon Web Services 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.

    • schemaStatusDetails (list) –

      Details about the status of the schema. Currently, only one entry is present.

      • (dict) –

        Information about the schema status.

        A status of READY means that based on the schema analysis rule, queries of the given analysis rule type are properly configured to run queries on this schema.

        • status (string) –

          The status of the schema.

        • reasons (list) –

          The reasons why the schema status is set to its current state.

          • (dict) –

            A reason why the schema status is set to its current value.

            • code (string) –

              The schema status reason code.

            • message (string) –

              An explanation of the schema status reason code.

        • analysisRuleType (string) –

          The analysis rule type for which the schema status has been evaluated.

        • configurations (list) –

          The configuration details of the schema analysis rule for the given type.

          • (string) –

Exceptions

• CleanRoomsService.Client.exceptions.ResourceNotFoundException

• CleanRoomsService.Client.exceptions.InternalServerException

• CleanRoomsService.Client.exceptions.ValidationException

• CleanRoomsService.Client.exceptions.ThrottlingException

• CleanRoomsService.Client.exceptions.AccessDeniedException