View a markdown version of this page

IntermediateTable - AWS Clean Rooms

IntermediateTable

Contains the details of an intermediate table in AWS Clean Rooms. An intermediate table stores a query definition and its materialized results within a collaboration.

Contents

arn

The Amazon Resource Name (ARN) of the intermediate table.

Type: String

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

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

Required: Yes

collaborationArn

The Amazon Resource Name (ARN) of the collaboration that contains the intermediate table.

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 identifier of the collaboration that contains the intermediate table.

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

createTime

The time the intermediate table was created.

Type: Timestamp

Required: Yes

id

The unique identifier of the intermediate table.

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

membershipArn

The Amazon Resource Name (ARN) of the membership that contains the intermediate table.

Type: String

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

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

Required: Yes

membershipId

The unique identifier of the membership that contains the intermediate table.

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

name

The name of the intermediate table.

Type: String

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

Pattern: (?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*

Required: Yes

populationAnalysisConfiguration

The analysis configuration that defines the query used to populate the intermediate table.

Type: PopulationAnalysisConfiguration object

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

Required: Yes

status

The current status of the intermediate table.

Type: String

Valid Values: CREATED | POPULATE_STARTED | POPULATE_SUCCESS | POPULATE_FAILED | DISALLOWED_BY_DATA_PROVIDER | BASE_TABLE_REMOVED | RETENTION_PERIOD_EXPIRED

Required: Yes

updateTime

The time the intermediate table was last updated.

Type: Timestamp

Required: Yes

analysisRuleTypes

The types of analysis rules associated with the intermediate table.

Type: Array of strings

Valid Values: CUSTOM

Required: No

childResources

The child resources that depend on this intermediate table.

Type: Array of ChildResource objects

Required: No

description

The description of the intermediate table.

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: No

intermediateTableVersion

The details of the currently active version of the intermediate table.

Type: IntermediateTableActiveVersion object

Required: No

kmsKeyArn

The Amazon Resource Name (ARN) of the AWS KMS key used to encrypt the intermediate table data.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws:kms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:key/[a-zA-Z0-9-]+

Required: No

retentionInDays

The number of days that populated data is retained before expiring.

Type: Integer

Required: No

schema

The schema of the intermediate table, containing column definitions. Available after the table has been successfully populated.

Type: IntermediateTableSchema object

Required: No

statusReason

The reason for the current status of the intermediate table.

Type: String

Required: No

tableDependencies

The list of base tables that this intermediate table depends on.

Type: Array of IntermediateTableDependency objects

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: