Schema

A schema is a relation within a collaboration.

analysisRuleTypes

The analysis rule types that are associated with the schema. Currently, only one entry is present.

Type: Array of strings

Valid Values: AGGREGATION | LIST | CUSTOM | ID_MAPPING_TABLE

Required: Yes

collaborationArn

The unique Amazon Resource Name (ARN) for the collaboration that the schema belongs to.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 100.

Pattern: arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+

Required: Yes

collaborationId

The unique ID for the collaboration that the schema belongs to.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

columns

The columns for the relation that this schema represents.

Type: Array of Column objects

Required: Yes

createTime

The time at which the schema was created.

Type: Timestamp

Required: Yes

creatorAccountId

The unique account ID for the AWS account that owns the schema.

Type: String

Length Constraints: Fixed length of 12.

Pattern: \d+

Required: Yes

description

A description for the schema.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*

Required: Yes

name

A name for the schema. The schema relation is referred to by this name when queried by a protected query.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

Pattern: [a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?

Required: Yes

partitionKeys

The partition keys for the dataset underlying this schema.

Type: Array of Column objects

Required: Yes

schemaStatusDetails

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

Type: Array of SchemaStatusDetail objects

Required: Yes

type

The type of schema.

Type: String

Valid Values: TABLE | ID_MAPPING_TABLE

Required: Yes

updateTime

The most recent time at which the schema was updated.

Type: Timestamp

Required: Yes

analysisMethod

The analysis method for the schema.

DIRECT_QUERY allows SQL queries to be run directly on this table.

DIRECT_JOB allows PySpark jobs to be run directly on this table.

MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.

Type: String

Valid Values: DIRECT_QUERY | DIRECT_JOB | MULTIPLE

Required: No

resourceArn

The Amazon Resource Name (ARN) of the schema resource.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 200.

Pattern: arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership\/[\d\w-]+\/(configuredtableassociation|idmappingtable)\/[\d\w-]+

Required: No

schemaTypeProperties

The schema type properties.

Type: SchemaTypeProperties object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

selectedAnalysisMethods

The selected analysis methods for the schema.

Type: Array of strings

Valid Values: DIRECT_QUERY | DIRECT_JOB

Required: No

Schema

Contents

See Also