batch_get_schema

CleanRoomsService.Client.batch_get_schema(**kwargs)

Retrieves multiple schemas by their identifiers.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_schema(
    collaborationIdentifier='string',
    names=[
        'string',
    ]
)
Parameters
  • collaborationIdentifier (string) --

    [REQUIRED]

    A unique identifier for the collaboration that the schemas belong to. Currently accepts collaboration ID.

  • names (list) --

    [REQUIRED]

    The names for the schema objects to retrieve.>

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'schemas': [
        {
            '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'
        },
    ],
    'errors': [
        {
            'name': 'string',
            'code': 'string',
            'message': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • schemas (list) --

      The retrieved list of schemas.

      • (dict) --

        A schema is a relation within a collaboration.

        • 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 data set 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.

    • errors (list) --

      Error reasons for schemas that could not be retrieved. One error is returned for every schema that could not be retrieved.

      • (dict) --

        An error describing why a schema could not be fetched.

        • name (string) --

          An error name for the error.

        • code (string) --

          An error code for the error.

        • message (string) --

          An error message for the error.

Exceptions

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