get-intermediate-table¶

Description¶

Retrieves an intermediate table. Returns the full details of the intermediate table, including schema, table dependencies, inherited constraints, child resources, and status. Only the intermediate table owner can call this operation.

Synopsis¶

  get-intermediate-table
--intermediate-table-identifier <value>
--membership-identifier <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--intermediate-table-identifier (string) [required]

The unique identifier of the intermediate table to retrieve.

Constraints:

min: 36

max: 36

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

--membership-identifier (string) [required]

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

Constraints:

min: 36

max: 36

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream
off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

intermediateTable -> (structure)

The intermediate table retrieved.

id -> (string) [required]

The unique identifier of the intermediate table.

Constraints:

min: 36

max: 36

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

arn -> (string) [required]

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

Constraints:

min: 0

max: 256

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

name -> (string) [required]

The name of the intermediate table.

Constraints:

min: 1

max: 100

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

description -> (string)

The description of the intermediate table.

Constraints:

min: 0

max: 255

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

membershipArn -> (string) [required]

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

Constraints:

min: 0

max: 100

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

membershipId -> (string) [required]

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

Constraints:

min: 36

max: 36

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

collaborationArn -> (string) [required]

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

Constraints:

min: 0

max: 100

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

collaborationId -> (string) [required]

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

Constraints:

min: 36

max: 36

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

childResources -> (list)

The child resources that depend on this intermediate table.

(structure)

Contains information about a child resource of a given resource in a collaboration.

resourceId -> (string)

The unique identifier of the child resource.

Constraints:

min: 36

max: 36

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

resourceType -> (string) [required]

The type of the child resource.

Possible values:

INTERMEDIATE_TABLE

resourceName -> (string) [required]

The name of the child resource.

Constraints:

min: 1

max: 100

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

ownerAccountId -> (string) [required]

The Amazon Web Services account ID of the member who owns the child resource.

Constraints:

min: 12

max: 12

pattern: \d+

resourceStatus -> (string)

The current status of the child resource.

Possible values:

CREATED

POPULATE_STARTED

POPULATE_SUCCESS

POPULATE_FAILED

DISALLOWED_BY_DATA_PROVIDER

BASE_TABLE_REMOVED

RETENTION_PERIOD_EXPIRED

createTime -> (timestamp) [required]

The time the intermediate table was created.

updateTime -> (timestamp) [required]

The time the intermediate table was last updated.

status -> (string) [required]

The current status of the intermediate table.

Possible values:

CREATED

POPULATE_STARTED

POPULATE_SUCCESS

POPULATE_FAILED

DISALLOWED_BY_DATA_PROVIDER

BASE_TABLE_REMOVED

RETENTION_PERIOD_EXPIRED

statusReason -> (string)

The reason for the current status of the intermediate table.

kmsKeyArn -> (string)

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

Constraints:

min: 20

max: 2048

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

populationAnalysisConfiguration -> (tagged union structure) [required]

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

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: sqlParameters.

sqlParameters -> (structure)

The SQL parameters for the population analysis, including the query string or analysis template ARN.

queryString -> (string)

The SQL query string used to populate the intermediate table. Maximum length of 500,000 characters.

Constraints:

min: 0

max: 500000

analysisTemplateArn -> (string)

The Amazon Resource Name (ARN) of the analysis template to use for populating the intermediate table.

Constraints:

min: 0

max: 200

pattern: arn:aws[-a-z]*:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/analysistemplate/[\d\w-]+

retentionInDays -> (integer)

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

tableDependencies -> (list)

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

(structure)

Contains information about a base table that an intermediate table depends on.

id -> (string) [required]

The unique identifier of the dependency table.

Constraints:

min: 36

max: 36

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

name -> (string) [required]

The name of the dependency table.

Constraints:

min: 1

max: 100

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

type -> (string) [required]

The type of the dependency table.

Possible values:

TABLE

INTERMEDIATE_TABLE

ID_MAPPING_TABLE

parentType -> (string) [required]

Whether the dependency is direct or indirect. A direct dependency is a table explicitly referenced in the stored query, while an indirect dependency is referenced through another intermediate table.

Possible values:

DIRECT

INDIRECT

creatorAccountId -> (string) [required]

The Amazon Web Services account ID of the member who owns the dependency table.

Constraints:

min: 12

max: 12

pattern: \d+

intermediateTableVersion -> (structure)

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

versionId -> (string) [required]

The unique identifier of the active version.

Constraints:

min: 36

max: 36

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

analysisId -> (string) [required]

The identifier of the protected query that created this version.

Constraints:

min: 36

max: 36

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

analysisType -> (string) [required]

The type of analysis that created this version.

Possible values:

QUERY

kmsKeyArn -> (string)

The Amazon Resource Name (ARN) of the KMS key used to encrypt this version’s data.

Constraints:

min: 20

max: 2048

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

parameters -> (map)

The runtime parameters that were used when populating this version.

key -> (string)

Constraints:

min: 1

max: 100

pattern: [0-9a-zA-Z_]+

value -> (string)

Constraints:

min: 0

max: 1000

inheritedConstraints -> (structure) [required]

The privacy constraints inherited from parent tables at the time this version was populated.

additionalAnalyses -> (structure)

The inherited additional analyses constraint.

value -> (string) [required]

The effective additional analyses setting inherited from parent tables.

Possible values:

ALLOWED

REQUIRED

NOT_ALLOWED

sources -> (list) [required]

The list of parent tables that contribute to this inherited constraint.

(structure)

Contains information about a parent table that contributes an additional analyses constraint.

name -> (string) [required]

The name of the parent table.

Constraints:

min: 1

max: 100

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

id -> (string) [required]

The unique identifier of the parent table.

Constraints:

min: 36

max: 36

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

type -> (string) [required]

The type of the parent table.

Possible values:

TABLE

INTERMEDIATE_TABLE

ID_MAPPING_TABLE

value -> (string) [required]

The additional analyses setting defined on the parent table.

Possible values:

ALLOWED

REQUIRED

NOT_ALLOWED

sourceAccountId -> (string) [required]

The Amazon Web Services account ID of the member who owns the parent table.

Constraints:

min: 12

max: 12

pattern: \d+

allowedAdditionalAnalyses -> (structure)

The inherited allowed additional analyses constraint.

value -> (list) [required]

The effective list of allowed additional analyses inherited from parent tables.

Constraints:

min: 0

max: 25

(string)

Constraints:

min: 0

max: 256

pattern: arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:([\d]{12}|\*):membership\/[\*\d\w-]+\/configuredaudiencemodelassociation\/[\*\d\w-]+$|^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:([0-9]{12}|\*):membership\/[\*\d\w-]+\/configured-model-algorithm-association\/([-a-zA-Z0-9_\/.]+|\*)

sources -> (list) [required]

The list of parent tables that contribute to this inherited constraint.

(structure)

Contains information about a parent table that contributes an allowed additional analyses constraint.

name -> (string) [required]

The name of the parent table.

Constraints:

min: 1

max: 100

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

id -> (string) [required]

The unique identifier of the parent table.

Constraints:

min: 36

max: 36

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

type -> (string) [required]

The type of the parent table.

Possible values:

TABLE

INTERMEDIATE_TABLE

ID_MAPPING_TABLE

value -> (list) [required]

The allowed additional analyses defined on the parent table.

Constraints:

min: 0

max: 25

(string)

Constraints:

min: 0

max: 256

pattern: arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:([\d]{12}|\*):membership\/[\*\d\w-]+\/configuredaudiencemodelassociation\/[\*\d\w-]+$|^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:([0-9]{12}|\*):membership\/[\*\d\w-]+\/configured-model-algorithm-association\/([-a-zA-Z0-9_\/.]+|\*)

sourceAccountId -> (string) [required]

The Amazon Web Services account ID of the member who owns the parent table.

Constraints:

min: 12

max: 12

pattern: \d+

allowedResultReceivers -> (structure)

The inherited allowed result receivers constraint.

value -> (list) [required]

The effective list of Amazon Web Services account IDs allowed to receive results, inherited from parent tables.

(string)

Constraints:

min: 12

max: 12

pattern: \d+

sources -> (list) [required]

The list of parent tables that contribute to this inherited constraint.

(structure)

Contains information about a parent table that contributes an allowed result receivers constraint.

name -> (string) [required]

The name of the parent table.

Constraints:

min: 1

max: 100

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

id -> (string) [required]

The unique identifier of the parent table.

Constraints:

min: 36

max: 36

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

type -> (string) [required]

The type of the parent table.

Possible values:

TABLE

INTERMEDIATE_TABLE

ID_MAPPING_TABLE

value -> (list) [required]

The allowed result receiver account IDs defined on the parent table.

(string)

Constraints:

min: 12

max: 12

pattern: \d+

sourceAccountId -> (string) [required]

The Amazon Web Services account ID of the member who owns the parent table.

Constraints:

min: 12

max: 12

pattern: \d+

disallowedOutputColumns -> (structure)

The inherited disallowed output columns constraint.

value -> (list) [required]

The list of column names that are disallowed from appearing in query output, inherited from parent tables.

(string)

Constraints:

min: 1

max: 127

pattern: [a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?

columnLineage -> (list) [required]

The lineage information that traces each disallowed output column back to its source in a parent table.

(structure)

Contains column lineage information that traces a disallowed output column back to its source in a base table.

column -> (string) [required]

The name of the column in the intermediate table.

Constraints:

min: 1

max: 127

pattern: [a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?

sourceColumn -> (string) [required]

The name of the column in the source table.

Constraints:

min: 1

max: 127

pattern: [a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?

sourceName -> (string) [required]

The name of the source table.

Constraints:

min: 1

max: 100

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

sourceId -> (string) [required]

The unique identifier of the source table.

Constraints:

min: 36

max: 36

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

sourceType -> (string) [required]

The type of the source table.

Possible values:

TABLE

INTERMEDIATE_TABLE

ID_MAPPING_TABLE

sourceAccountId -> (string) [required]

The Amazon Web Services account ID of the owner of the source table.

Constraints:

min: 12

max: 12

pattern: \d+

expirationTime -> (timestamp)

The time when this version expires based on the retention period.

analysisRuleTypes -> (list)

The types of analysis rules associated with the intermediate table.

(string)

Possible values:

CUSTOM

schema -> (structure)

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

columns -> (list) [required]

The list of columns in the intermediate table schema.

(structure)

A column within a schema relation, derived from the underlying table.

name -> (string) [required]

The name of the column.

Constraints:

min: 0

max: 128

pattern: [a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?

type -> (string) [required]

The type of the column.

Constraints:

min: 0

max: 255

pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*

Table of Contents

Feedback

User Guide