---
title: "POST /collaborations/{collaborationIdentifier}/batch-schema"
method: POST
path: "/collaborations/{collaborationIdentifier}/batch-schema"
---

# POST /collaborations/{collaborationIdentifier}/batch-schema

`POST /collaborations/{collaborationIdentifier}/batch-schema`

Retrieves multiple schemas by their identifiers.

## Path parameters

- `collaborationIdentifier` string, required

## Request body

- object
  - `names` TableAlias[], required — The names for the schema objects to retrieve.

## Response `200`

Success

- BatchGetSchemaOutput
  - `schemas` Schema[], required — The retrieved list of schemas.
    - `columns` Column[], required — The columns for the relation that this schema represents.
      - `name` string, required — The name of the column.
      - `type` string, required — The type of the column.
    - `partitionKeys` Column[], required — The partition keys for the dataset underlying this schema.
      - `name` string, required — The name of the column.
      - `type` string, required — The type of the column.
    - `analysisRuleTypes` AnalysisRuleType[], required — The analysis rule types that are associated with the schema. Currently, only one entry is present.
    - `analysisMethod` 'DIRECT_QUERY' | 'DIRECT_JOB' | 'MULTIPLE' — <p>The analysis method for the schema. </p> <p> <code>DIRECT_QUERY</code> allows SQL queries to be run directly on this table.</p> <p> <code>DIRECT_JOB</code> allows PySpark jobs to be run directly on this table.</p> <p> <code>MULTIPLE</code> allows both SQL queries and PySpark jobs to be run directly on this table.</p>
    - `selectedAnalysisMethods` SelectedAnalysisMethod[] — The selected analysis methods for the schema.
    - `creatorAccountId` string, required — The unique account ID for the Amazon Web Services account that owns the schema.
    - `name` string, required — A name for the schema. The schema relation is referred to by this name when queried by a protected query.
    - `collaborationId` string, required — The unique ID for the collaboration that the schema belongs to.
    - `collaborationArn` string, required — The unique Amazon Resource Name (ARN) for the collaboration that the schema belongs to.
    - `description` string, required — A description for the schema.
    - `createTime` string, date-time, required — The time at which the schema was created.
    - `updateTime` string, date-time, required — The most recent time at which the schema was updated.
    - `type` 'TABLE' | 'ID_MAPPING_TABLE' | 'INTERMEDIATE_TABLE', required — The type of schema.
    - `schemaStatusDetails` SchemaStatusDetail[], required — Details about the status of the schema. Currently, only one entry is present.
      - `status` 'READY' | 'NOT_READY', required — The status of the schema, indicating if it is ready to query.
      - `reasons` SchemaStatusReason[] — The reasons why the schema status is set to its current state.
        - `code` 'ANALYSIS_RULE_MISSING' | 'ANALYSIS_TEMPLATES_NOT_CONFIGURED' | 'ANALYSIS_PROVIDERS_NOT_CONFIGURED' | 'DIFFERENTIAL_PRIVACY_POLICY_NOT_CONFIGURED' | 'ID_MAPPING_TABLE_NOT_POPULATED' | 'COLLABORATION_ANALYSIS_RULE_NOT_CONFIGURED' | 'ADDITIONAL_ANALYSES_NOT_CONFIGURED' | 'RESULT_RECEIVERS_NOT_CONFIGURED' | 'ADDITIONAL_ANALYSES_NOT_ALLOWED' | 'RESULT_RECEIVERS_NOT_ALLOWED' | 'ANALYSIS_RULE_TYPES_NOT_COMPATIBLE' | 'INTERMEDIATE_TABLE_NOT_POPULATED' | 'INTERMEDIATE_TABLE_ANALYSIS_RULE_MISSING' | 'INTERMEDIATE_TABLE_BASE_TABLE_REMOVED' | 'INTERMEDIATE_TABLE_INHERITED_CONSTRAINTS_VIOLATED' | 'INTERMEDIATE_TABLE_DISALLOWED_BY_DATA_PROVIDER' | 'INTERMEDIATE_TABLE_RETENTION_PERIOD_EXPIRED', required — The schema status reason code.
        - `message` string, required — An explanation of the schema status reason code.
      - `analysisRuleType` 'AGGREGATION' | 'LIST' | 'CUSTOM' | 'ID_MAPPING_TABLE' — The analysis rule type for which the schema status has been evaluated.
      - `configurations` SchemaConfiguration[] — The configuration details of the schema analysis rule for the given type.
      - `analysisType` 'DIRECT_ANALYSIS' | 'ADDITIONAL_ANALYSIS', required — <p>The type of analysis that can be performed on the schema.</p> <p>A schema can have an <code>analysisType</code> of <code>DIRECT_ANALYSIS</code>, <code>ADDITIONAL_ANALYSIS_FOR_AUDIENCE_GENERATION</code>, or both.</p>
    - `resourceArn` string — The Amazon Resource Name (ARN) of the schema resource.
    - `schemaTypeProperties` object — The schema type properties.
      - `idMappingTable` object — The ID mapping table for the schema type properties.
        - `idMappingTableInputSource` IdMappingTableInputSource[], required — Defines which ID namespace associations are used to create the ID mapping table.
          - `idNamespaceAssociationId` string, required — The unique identifier of the ID namespace association.
          - `type` 'SOURCE' | 'TARGET', required — The type of the input source of the ID mapping table.
        - `idMappingTableId` string — The unique identifier of the ID mapping table.
      - `intermediateTable` object — The schema type properties for an intermediate table.
        - `intermediateTableId` string, required — The unique identifier of the intermediate table.
      - `configuredTableAssociation` object — The schema type properties for a configured table association.
        - `configuredTableAssociationId` string, required — The unique identifier of the configured table association.
  - `errors` BatchGetSchemaError[], required — Error reasons for schemas that could not be retrieved. One error is returned for every schema that could not be retrieved.
    - `name` string, required — An error name for the error.
    - `code` string, required — An error code for the error.
    - `message` string, required — An error message for the error.

## Other responses

- `480` — ResourceNotFoundException
- `481` — InternalServerException
- `482` — ValidationException
- `483` — ThrottlingException
- `484` — AccessDeniedException

---

[API](https://skmtc.net/aws/apis/cleanrooms.md) · [All operations](https://skmtc.net/aws/apis/cleanrooms/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/cleanrooms/versions/17ce59ba806e/schema)