2026/11/18 - AWS Clean Rooms Service - 9 updated api methods
Changes Adds support for populating intermediate tables with results from PySpark analysis templates.
{'populationAnalysisConfiguration': {'jobParameters': {'analysisTemplateArn': 'string'}}}
Response {'intermediateTable': {'intermediateTableVersion': {'analysisType': {'JOB'}},
'populationAnalysisConfiguration': {'jobParameters': {'analysisTemplateArn': 'string'}}}}
Creates an intermediate table in a membership. The intermediate table is owned by the member with the CAN_QUERY ability. To populate the table with results, use PopulateIntermediateTable.
See also: AWS API Documentation
Request Syntax
client.create_intermediate_table(
membershipIdentifier='string',
name='string',
description='string',
populationAnalysisConfiguration={
'sqlParameters': {
'queryString': 'string',
'analysisTemplateArn': 'string'
},
'jobParameters': {
'analysisTemplateArn': 'string'
}
},
kmsKeyArn='string',
retentionInDays=123,
tags={
'string': 'string'
}
)
string
[REQUIRED]
The unique identifier of the membership where the intermediate table is created.
string
[REQUIRED]
The display name for the intermediate table.
string
A description of the intermediate table.
dict
[REQUIRED]
The configuration that defines the analysis used to populate the intermediate table.
sqlParameters (dict) --
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.
analysisTemplateArn (string) --
The Amazon Resource Name (ARN) of the analysis template to use for populating the intermediate table.
jobParameters (dict) --
Specifies the PySpark job parameters for the population analysis. Use jobParameters instead of sqlParameters when you populate the intermediate table with results from a PySpark job.
analysisTemplateArn (string) -- [REQUIRED]
Specifies the ARN of the PySpark analysis template that populates the intermediate table. Provide this ARN in jobParameters when you populate the intermediate table with results from a PySpark job.
string
The Amazon Resource Name (ARN) of the customer-managed KMS key used to encrypt the intermediate table data.
integer
The number of days to retain populated data versions.
dict
An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
(string) --
(string) --
dict
Response Syntax
{
'intermediateTable': {
'id': 'string',
'arn': 'string',
'name': 'string',
'description': 'string',
'membershipArn': 'string',
'membershipId': 'string',
'collaborationArn': 'string',
'collaborationId': 'string',
'childResources': [
{
'resourceId': 'string',
'resourceType': 'INTERMEDIATE_TABLE',
'resourceName': 'string',
'ownerAccountId': 'string',
'resourceStatus': 'CREATED'|'POPULATE_STARTED'|'POPULATE_SUCCESS'|'POPULATE_FAILED'|'DISALLOWED_BY_DATA_PROVIDER'|'BASE_TABLE_REMOVED'|'RETENTION_PERIOD_EXPIRED'
},
],
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'status': 'CREATED'|'POPULATE_STARTED'|'POPULATE_SUCCESS'|'POPULATE_FAILED'|'DISALLOWED_BY_DATA_PROVIDER'|'BASE_TABLE_REMOVED'|'RETENTION_PERIOD_EXPIRED',
'statusReason': 'string',
'kmsKeyArn': 'string',
'populationAnalysisConfiguration': {
'sqlParameters': {
'queryString': 'string',
'analysisTemplateArn': 'string'
},
'jobParameters': {
'analysisTemplateArn': 'string'
}
},
'retentionInDays': 123,
'tableDependencies': [
{
'id': 'string',
'name': 'string',
'type': 'TABLE'|'INTERMEDIATE_TABLE'|'ID_MAPPING_TABLE',
'parentType': 'DIRECT'|'INDIRECT',
'creatorAccountId': 'string'
},
],
'intermediateTableVersion': {
'versionId': 'string',
'analysisId': 'string',
'analysisType': 'QUERY'|'JOB',
'kmsKeyArn': 'string',
'parameters': {
'string': 'string'
},
'inheritedConstraints': {
'additionalAnalyses': {
'value': 'ALLOWED'|'REQUIRED'|'NOT_ALLOWED',
'sources': [
{
'name': 'string',
'id': 'string',
'type': 'TABLE'|'INTERMEDIATE_TABLE'|'ID_MAPPING_TABLE',
'value': 'ALLOWED'|'REQUIRED'|'NOT_ALLOWED',
'sourceAccountId': 'string'
},
]
},
'allowedAdditionalAnalyses': {
'value': [
'string',
],
'sources': [
{
'name': 'string',
'id': 'string',
'type': 'TABLE'|'INTERMEDIATE_TABLE'|'ID_MAPPING_TABLE',
'value': [
'string',
],
'sourceAccountId': 'string'
},
]
},
'allowedResultReceivers': {
'value': [
'string',
],
'sources': [
{
'name': 'string',
'id': 'string',
'type': 'TABLE'|'INTERMEDIATE_TABLE'|'ID_MAPPING_TABLE',
'value': [
'string',
],
'sourceAccountId': 'string'
},
]
},
'disallowedOutputColumns': {
'value': [
'string',
],
'columnLineage': [
{
'column': 'string',
'sourceColumn': 'string',
'sourceName': 'string',
'sourceId': 'string',
'sourceType': 'TABLE'|'INTERMEDIATE_TABLE'|'ID_MAPPING_TABLE',
'sourceAccountId': 'string'
},
]
}
},
'expirationTime': datetime(2015, 1, 1)
},
'analysisRuleTypes': [
'CUSTOM',
],
'schema': {
'columns': [
{
'name': 'string',
'type': 'string'
},
]
}
}
}
Response Structure
(dict) --
intermediateTable (dict) --
The intermediate table that was created.
id (string) --
The unique identifier of the intermediate table.
arn (string) --
The Amazon Resource Name (ARN) of the intermediate table.
name (string) --
The name of the intermediate table.
description (string) --
The description of the intermediate table.
membershipArn (string) --
The Amazon Resource Name (ARN) of the membership that contains the intermediate table.
membershipId (string) --
The unique identifier of the membership that contains the intermediate table.
collaborationArn (string) --
The Amazon Resource Name (ARN) of the collaboration that contains the intermediate table.
collaborationId (string) --
The unique identifier of the collaboration that contains the intermediate table.
childResources (list) --
The child resources that depend on this intermediate table.
(dict) --
Contains information about a child resource of a given resource in a collaboration.
resourceId (string) --
The unique identifier of the child resource.
resourceType (string) --
The type of the child resource.
resourceName (string) --
The name of the child resource.
ownerAccountId (string) --
The Amazon Web Services account ID of the member who owns the child resource.
resourceStatus (string) --
The current status of the child resource.
createTime (datetime) --
The time the intermediate table was created.
updateTime (datetime) --
The time the intermediate table was last updated.
status (string) --
The current status of the intermediate table.
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.
populationAnalysisConfiguration (dict) --
The analysis configuration that defines the query used to populate the intermediate table.
sqlParameters (dict) --
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.
analysisTemplateArn (string) --
The Amazon Resource Name (ARN) of the analysis template to use for populating the intermediate table.
jobParameters (dict) --
Specifies the PySpark job parameters for the population analysis. Use jobParameters instead of sqlParameters when you populate the intermediate table with results from a PySpark job.
analysisTemplateArn (string) --
Specifies the ARN of the PySpark analysis template that populates the intermediate table. Provide this ARN in jobParameters when you populate the intermediate table with results from a PySpark job.
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.
(dict) --
Contains information about a base table that an intermediate table depends on.
id (string) --
The unique identifier of the dependency table.
name (string) --
The name of the dependency table.
type (string) --
The type of the dependency table.
parentType (string) --
The type of dependency, either direct or indirect. A direct dependency is a table explicitly referenced in the stored query. An indirect dependency is a table referenced through another intermediate table.
creatorAccountId (string) --
The Amazon Web Services account ID of the member who owns the dependency table.
intermediateTableVersion (dict) --
The details of the currently active version of the intermediate table.
versionId (string) --
The unique identifier of the active version.
analysisId (string) --
The identifier of the protected query that created this version.
analysisType (string) --
The type of analysis that created this version.
kmsKeyArn (string) --
The Amazon Resource Name (ARN) of the KMS key used to encrypt this version's data.
parameters (dict) --
The runtime parameters that were used when populating this version.
(string) --
(string) --
inheritedConstraints (dict) --
The privacy constraints inherited from parent tables at the time this version was populated.
additionalAnalyses (dict) --
The inherited additional analyses constraint.
value (string) --
The effective additional analyses setting inherited from parent tables.
sources (list) --
The list of parent tables that contribute to this inherited constraint.
(dict) --
Contains information about a parent table that contributes an additional analyses constraint.
name (string) --
The name of the parent table.
id (string) --
The unique identifier of the parent table.
type (string) --
The type of the parent table.
value (string) --
The additional analyses setting defined on the parent table.
sourceAccountId (string) --
The Amazon Web Services account ID of the member who owns the parent table.
allowedAdditionalAnalyses (dict) --
The inherited allowed additional analyses constraint.
value (list) --
The effective list of allowed additional analyses inherited from parent tables.
(string) --
sources (list) --
The list of parent tables that contribute to this inherited constraint.
(dict) --
Contains information about a parent table that contributes an allowed additional analyses constraint.
name (string) --
The name of the parent table.
id (string) --
The unique identifier of the parent table.
type (string) --
The type of the parent table.
value (list) --
The allowed additional analyses defined on the parent table.
(string) --
sourceAccountId (string) --
The Amazon Web Services account ID of the member who owns the parent table.
allowedResultReceivers (dict) --
The inherited allowed result receivers constraint.
value (list) --
The effective list of Amazon Web Services account IDs allowed to receive results, inherited from parent tables.
(string) --
sources (list) --
The list of parent tables that contribute to this inherited constraint.
(dict) --
Contains information about a parent table that contributes an allowed result receivers constraint.
name (string) --
The name of the parent table.
id (string) --
The unique identifier of the parent table.
type (string) --
The type of the parent table.
value (list) --
The allowed result receiver account IDs defined on the parent table.
(string) --
sourceAccountId (string) --
The Amazon Web Services account ID of the member who owns the parent table.
disallowedOutputColumns (dict) --
The inherited disallowed output columns constraint.
value (list) --
The list of column names that are disallowed from appearing in query output, inherited from parent tables.
(string) --
columnLineage (list) --
The lineage information that traces each disallowed output column back to its source in a parent table.
(dict) --
Contains column lineage information that traces a disallowed output column back to its source in a base table.
column (string) --
The name of the column in the intermediate table.
sourceColumn (string) --
The name of the column in the source table.
sourceName (string) --
The name of the source table.
sourceId (string) --
The unique identifier of the source table.
sourceType (string) --
The type of the source table.
sourceAccountId (string) --
The Amazon Web Services account ID of the owner of the source table.
expirationTime (datetime) --
The time when this version expires based on the retention period.
analysisRuleTypes (list) --
The types of analysis rules associated with the intermediate table.
(string) --
schema (dict) --
The schema of the intermediate table, containing column definitions. Available after the table has been successfully populated.
columns (list) --
The list of columns in the intermediate table schema.
(dict) --
A column within a schema relation, derived from the underlying table.
name (string) --
The name of the column.
type (string) --
The type of the column.
{'intermediateTable': {'intermediateTableVersion': {'analysisType': {'JOB'}},
'populationAnalysisConfiguration': {'jobParameters': {'analysisTemplateArn': 'string'}}}}
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.
See also: AWS API Documentation
Request Syntax
client.get_intermediate_table(
intermediateTableIdentifier='string',
membershipIdentifier='string'
)
string
[REQUIRED]
The unique identifier of the intermediate table to retrieve.
string
[REQUIRED]
The unique identifier of the membership that contains the intermediate table.
dict
Response Syntax
{
'intermediateTable': {
'id': 'string',
'arn': 'string',
'name': 'string',
'description': 'string',
'membershipArn': 'string',
'membershipId': 'string',
'collaborationArn': 'string',
'collaborationId': 'string',
'childResources': [
{
'resourceId': 'string',
'resourceType': 'INTERMEDIATE_TABLE',
'resourceName': 'string',
'ownerAccountId': 'string',
'resourceStatus': 'CREATED'|'POPULATE_STARTED'|'POPULATE_SUCCESS'|'POPULATE_FAILED'|'DISALLOWED_BY_DATA_PROVIDER'|'BASE_TABLE_REMOVED'|'RETENTION_PERIOD_EXPIRED'
},
],
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'status': 'CREATED'|'POPULATE_STARTED'|'POPULATE_SUCCESS'|'POPULATE_FAILED'|'DISALLOWED_BY_DATA_PROVIDER'|'BASE_TABLE_REMOVED'|'RETENTION_PERIOD_EXPIRED',
'statusReason': 'string',
'kmsKeyArn': 'string',
'populationAnalysisConfiguration': {
'sqlParameters': {
'queryString': 'string',
'analysisTemplateArn': 'string'
},
'jobParameters': {
'analysisTemplateArn': 'string'
}
},
'retentionInDays': 123,
'tableDependencies': [
{
'id': 'string',
'name': 'string',
'type': 'TABLE'|'INTERMEDIATE_TABLE'|'ID_MAPPING_TABLE',
'parentType': 'DIRECT'|'INDIRECT',
'creatorAccountId': 'string'
},
],
'intermediateTableVersion': {
'versionId': 'string',
'analysisId': 'string',
'analysisType': 'QUERY'|'JOB',
'kmsKeyArn': 'string',
'parameters': {
'string': 'string'
},
'inheritedConstraints': {
'additionalAnalyses': {
'value': 'ALLOWED'|'REQUIRED'|'NOT_ALLOWED',
'sources': [
{
'name': 'string',
'id': 'string',
'type': 'TABLE'|'INTERMEDIATE_TABLE'|'ID_MAPPING_TABLE',
'value': 'ALLOWED'|'REQUIRED'|'NOT_ALLOWED',
'sourceAccountId': 'string'
},
]
},
'allowedAdditionalAnalyses': {
'value': [
'string',
],
'sources': [
{
'name': 'string',
'id': 'string',
'type': 'TABLE'|'INTERMEDIATE_TABLE'|'ID_MAPPING_TABLE',
'value': [
'string',
],
'sourceAccountId': 'string'
},
]
},
'allowedResultReceivers': {
'value': [
'string',
],
'sources': [
{
'name': 'string',
'id': 'string',
'type': 'TABLE'|'INTERMEDIATE_TABLE'|'ID_MAPPING_TABLE',
'value': [
'string',
],
'sourceAccountId': 'string'
},
]
},
'disallowedOutputColumns': {
'value': [
'string',
],
'columnLineage': [
{
'column': 'string',
'sourceColumn': 'string',
'sourceName': 'string',
'sourceId': 'string',
'sourceType': 'TABLE'|'INTERMEDIATE_TABLE'|'ID_MAPPING_TABLE',
'sourceAccountId': 'string'
},
]
}
},
'expirationTime': datetime(2015, 1, 1)
},
'analysisRuleTypes': [
'CUSTOM',
],
'schema': {
'columns': [
{
'name': 'string',
'type': 'string'
},
]
}
}
}
Response Structure
(dict) --
intermediateTable (dict) --
The intermediate table retrieved.
id (string) --
The unique identifier of the intermediate table.
arn (string) --
The Amazon Resource Name (ARN) of the intermediate table.
name (string) --
The name of the intermediate table.
description (string) --
The description of the intermediate table.
membershipArn (string) --
The Amazon Resource Name (ARN) of the membership that contains the intermediate table.
membershipId (string) --
The unique identifier of the membership that contains the intermediate table.
collaborationArn (string) --
The Amazon Resource Name (ARN) of the collaboration that contains the intermediate table.
collaborationId (string) --
The unique identifier of the collaboration that contains the intermediate table.
childResources (list) --
The child resources that depend on this intermediate table.
(dict) --
Contains information about a child resource of a given resource in a collaboration.
resourceId (string) --
The unique identifier of the child resource.
resourceType (string) --
The type of the child resource.
resourceName (string) --
The name of the child resource.
ownerAccountId (string) --
The Amazon Web Services account ID of the member who owns the child resource.
resourceStatus (string) --
The current status of the child resource.
createTime (datetime) --
The time the intermediate table was created.
updateTime (datetime) --
The time the intermediate table was last updated.
status (string) --
The current status of the intermediate table.
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.
populationAnalysisConfiguration (dict) --
The analysis configuration that defines the query used to populate the intermediate table.
sqlParameters (dict) --
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.
analysisTemplateArn (string) --
The Amazon Resource Name (ARN) of the analysis template to use for populating the intermediate table.
jobParameters (dict) --
Specifies the PySpark job parameters for the population analysis. Use jobParameters instead of sqlParameters when you populate the intermediate table with results from a PySpark job.
analysisTemplateArn (string) --
Specifies the ARN of the PySpark analysis template that populates the intermediate table. Provide this ARN in jobParameters when you populate the intermediate table with results from a PySpark job.
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.
(dict) --
Contains information about a base table that an intermediate table depends on.
id (string) --
The unique identifier of the dependency table.
name (string) --
The name of the dependency table.
type (string) --
The type of the dependency table.
parentType (string) --
The type of dependency, either direct or indirect. A direct dependency is a table explicitly referenced in the stored query. An indirect dependency is a table referenced through another intermediate table.
creatorAccountId (string) --
The Amazon Web Services account ID of the member who owns the dependency table.
intermediateTableVersion (dict) --
The details of the currently active version of the intermediate table.
versionId (string) --
The unique identifier of the active version.
analysisId (string) --
The identifier of the protected query that created this version.
analysisType (string) --
The type of analysis that created this version.
kmsKeyArn (string) --
The Amazon Resource Name (ARN) of the KMS key used to encrypt this version's data.
parameters (dict) --
The runtime parameters that were used when populating this version.
(string) --
(string) --
inheritedConstraints (dict) --
The privacy constraints inherited from parent tables at the time this version was populated.
additionalAnalyses (dict) --
The inherited additional analyses constraint.
value (string) --
The effective additional analyses setting inherited from parent tables.
sources (list) --
The list of parent tables that contribute to this inherited constraint.
(dict) --
Contains information about a parent table that contributes an additional analyses constraint.
name (string) --
The name of the parent table.
id (string) --
The unique identifier of the parent table.
type (string) --
The type of the parent table.
value (string) --
The additional analyses setting defined on the parent table.
sourceAccountId (string) --
The Amazon Web Services account ID of the member who owns the parent table.
allowedAdditionalAnalyses (dict) --
The inherited allowed additional analyses constraint.
value (list) --
The effective list of allowed additional analyses inherited from parent tables.
(string) --
sources (list) --
The list of parent tables that contribute to this inherited constraint.
(dict) --
Contains information about a parent table that contributes an allowed additional analyses constraint.
name (string) --
The name of the parent table.
id (string) --
The unique identifier of the parent table.
type (string) --
The type of the parent table.
value (list) --
The allowed additional analyses defined on the parent table.
(string) --
sourceAccountId (string) --
The Amazon Web Services account ID of the member who owns the parent table.
allowedResultReceivers (dict) --
The inherited allowed result receivers constraint.
value (list) --
The effective list of Amazon Web Services account IDs allowed to receive results, inherited from parent tables.
(string) --
sources (list) --
The list of parent tables that contribute to this inherited constraint.
(dict) --
Contains information about a parent table that contributes an allowed result receivers constraint.
name (string) --
The name of the parent table.
id (string) --
The unique identifier of the parent table.
type (string) --
The type of the parent table.
value (list) --
The allowed result receiver account IDs defined on the parent table.
(string) --
sourceAccountId (string) --
The Amazon Web Services account ID of the member who owns the parent table.
disallowedOutputColumns (dict) --
The inherited disallowed output columns constraint.
value (list) --
The list of column names that are disallowed from appearing in query output, inherited from parent tables.
(string) --
columnLineage (list) --
The lineage information that traces each disallowed output column back to its source in a parent table.
(dict) --
Contains column lineage information that traces a disallowed output column back to its source in a base table.
column (string) --
The name of the column in the intermediate table.
sourceColumn (string) --
The name of the column in the source table.
sourceName (string) --
The name of the source table.
sourceId (string) --
The unique identifier of the source table.
sourceType (string) --
The type of the source table.
sourceAccountId (string) --
The Amazon Web Services account ID of the owner of the source table.
expirationTime (datetime) --
The time when this version expires based on the retention period.
analysisRuleTypes (list) --
The types of analysis rules associated with the intermediate table.
(string) --
schema (dict) --
The schema of the intermediate table, containing column definitions. Available after the table has been successfully populated.
columns (list) --
The list of columns in the intermediate table schema.
(dict) --
A column within a schema relation, derived from the underlying table.
name (string) --
The name of the column.
type (string) --
The type of the column.
{'protectedJob': {'resultConfiguration': {'outputConfiguration': {'intermediateTable': {'arn': 'string',
'id': 'string',
'name': 'string'}}}}}
Returns job processing metadata.
See also: AWS API Documentation
Request Syntax
client.get_protected_job(
membershipIdentifier='string',
protectedJobIdentifier='string'
)
string
[REQUIRED]
The identifier for a membership in a protected job instance.
string
[REQUIRED]
The identifier for the protected job instance.
dict
Response Syntax
{
'protectedJob': {
'id': 'string',
'membershipId': 'string',
'membershipArn': 'string',
'createTime': datetime(2015, 1, 1),
'jobParameters': {
'analysisTemplateArn': 'string',
'parameters': {
'string': 'string'
}
},
'status': 'SUBMITTED'|'STARTED'|'CANCELLED'|'CANCELLING'|'FAILED'|'SUCCESS',
'resultConfiguration': {
'outputConfiguration': {
's3': {
'bucket': 'string',
'keyPrefix': 'string'
},
'member': {
'accountId': 'string'
},
'intermediateTable': {
'id': 'string',
'arn': 'string',
'name': 'string'
}
}
},
'statistics': {
'totalDurationInMillis': 123,
'billedResourceUtilization': {
'units': 123.0
}
},
'result': {
'output': {
's3': {
'location': 'string'
},
'memberList': [
{
'accountId': 'string'
},
]
}
},
'error': {
'message': 'string',
'code': 'string',
'retry': {
'retryable': True|False
}
},
'computeConfiguration': {
'worker': {
'type': 'CR.1X'|'CR.4X',
'number': 123,
'properties': {
'spark': {
'string': 'string'
}
}
}
},
'jobComputePayerAccountId': 'string'
}
}
Response Structure
(dict) --
protectedJob (dict) --
The protected job metadata.
id (string) --
The identifier for a protected job instance.
membershipId (string) --
he identifier for the membership.
membershipArn (string) --
The ARN of the membership.
createTime (datetime) --
The creation time of the protected job.
jobParameters (dict) --
The job parameters for the protected job.
analysisTemplateArn (string) --
The ARN of the analysis template.
parameters (dict) --
Runtime configuration values passed to the PySpark analysis script. Parameter names and types must match those defined in the analysis template.
(string) --
(string) --
status (string) --
The status of the protected job.
resultConfiguration (dict) --
Contains any details needed to write the job results.
outputConfiguration (dict) --
The output configuration.
s3 (dict) --
If present, the output for a protected job with an S3 output type.
bucket (string) --
The S3 bucket for job output.
keyPrefix (string) --
The S3 prefix to unload the protected job results.
member (dict) --
The member output configuration for a protected job.
accountId (string) --
The account ID.
intermediateTable (dict) --
Specifies the intermediate table that the protected job populated, identified by its ID, Amazon Resource Name (ARN), and name. This field is present when the protected job was triggered by a PopulateIntermediateTable operation.
id (string) --
The unique identifier of the intermediate table.
arn (string) --
The Amazon Resource Name (ARN) of the intermediate table.
name (string) --
The name of the intermediate table.
statistics (dict) --
The statistics of the protected job.
totalDurationInMillis (integer) --
The duration of the protected job, from creation until job completion, in milliseconds.
billedResourceUtilization (dict) --
The billed resource utilization for the protected job.
units (float) --
The number of Clean Rooms Processing Unit (CRPU) hours that have been billed.
result (dict) --
The result of the protected job.
output (dict) --
The output of the protected job.
s3 (dict) --
If present, the output for a protected job with an S3 output type.
location (string) --
The S3 location for the protected job output.
memberList (list) --
The list of member Amazon Web Services account(s) that received the results of the job.
(dict) --
Details about the member who received the job result.
accountId (string) --
The Amazon Web Services account ID of the member in the collaboration who can receive results from analyses.
error (dict) --
The error from the protected job.
message (string) --
A description of why the protected job failed.
code (string) --
A code that identifies the category of the failure. Valid values are:
MALFORMED_SCRIPT – The job script or its execution environment is not valid (code, imports, entry point, virtual environment, or dependencies).
RESOURCE_NOT_FOUND – A referenced resource doesn't exist.
INVALID_RESOURCE – A referenced resource exists, but you can't use it because its configuration, state, or data is not valid.
RESOURCE_ACCESS_DENIED – A required permission is missing for a data source or resource.
INSUFFICIENT_COMPUTE – The job exceeded the available compute (memory, disk, or time).
TRANSIENT_ERROR – A temporary condition caused the failure, such as throttling or a network interruption.
INTERNAL_ERROR – Clean Rooms encountered an unexpected error. If the error persists, contact AWS Support.
UNKNOWN_ERROR – The failure couldn't be classified.
For more information about error codes, see https://docs.aws.amazon.com/clean-rooms/latest/userguide/error-codes.html in the Clean Rooms User Guide.
retry (dict) --
Contains information about whether running the same protected job again might succeed.
retryable (boolean) --
Specifies whether running the same request again might succeed. true means that the failure was transient. false means that running the same request again is not expected to succeed.
computeConfiguration (dict) --
The compute configuration for the protected job.
worker (dict) --
The worker configuration for the compute environment.
type (string) --
The worker compute configuration type.
number (integer) --
The number of workers for a PySpark job.
properties (dict) --
The configuration properties for the worker compute environment. These properties allow you to customize the compute settings for your Clean Rooms workloads.
spark (dict) --
The Spark configuration properties for SQL and PySpark workloads. This map contains key-value pairs that configure Apache Spark settings to optimize performance for your data processing jobs. You can specify up to 50 Spark properties, with each key being 1-200 characters and each value being 0-500 characters. These properties allow you to adjust compute capacity for large datasets and complex workloads.
(string) --
(string) --
jobComputePayerAccountId (string) --
The account ID of the member that pays for the job compute costs.
{'intermediateTableVersionSummaries': {'analysisType': {'JOB'}}}
Lists the version history of an intermediate table. Each call to PopulateIntermediateTable creates a new version. We recommend using pagination to ensure that the operation returns quickly and successfully.
See also: AWS API Documentation
Request Syntax
client.list_intermediate_table_versions(
membershipIdentifier='string',
intermediateTableIdentifier='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The unique identifier of the membership that contains the intermediate table.
string
[REQUIRED]
The unique identifier of the intermediate table for which to list versions.
string
The pagination token that's used to fetch the next set of results.
integer
The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.
dict
Response Syntax
{
'intermediateTableVersionSummaries': [
{
'versionId': 'string',
'tableId': 'string',
'createTime': datetime(2015, 1, 1),
'analysisId': 'string',
'status': 'POPULATE_STARTED'|'POPULATE_SUCCESS'|'POPULATE_FAILED'|'RETENTION_PERIOD_EXPIRED',
'analysisType': 'QUERY'|'JOB',
'kmsKeyArn': 'string',
'expirationTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
intermediateTableVersionSummaries (list) --
The list of intermediate table version summaries.
(dict) --
Contains summary information about a version of an intermediate table.
versionId (string) --
The unique identifier of the version.
tableId (string) --
The unique identifier of the intermediate table that this version belongs to.
createTime (datetime) --
The time the version was created.
analysisId (string) --
The identifier of the protected query that created this version.
status (string) --
The status of the version.
analysisType (string) --
The type of analysis that created this version.
kmsKeyArn (string) --
The Amazon Resource Name (ARN) of the KMS key used to encrypt this version's data.
expirationTime (datetime) --
The time when this version expires based on the retention period.
nextToken (string) --
The pagination token that's used to fetch the next set of results.
{'protectedJobs': {'intermediateTableConfiguration': {'arn': 'string',
'id': 'string',
'name': 'string'}}}
Lists protected jobs, sorted by most recent job.
See also: AWS API Documentation
Request Syntax
client.list_protected_jobs(
membershipIdentifier='string',
status='SUBMITTED'|'STARTED'|'CANCELLED'|'CANCELLING'|'FAILED'|'SUCCESS',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The identifier for the membership in the collaboration.
string
A filter on the status of the protected job.
string
The pagination token that's used to fetch the next set of results.
integer
The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.
dict
Response Syntax
{
'nextToken': 'string',
'protectedJobs': [
{
'id': 'string',
'membershipId': 'string',
'membershipArn': 'string',
'createTime': datetime(2015, 1, 1),
'status': 'SUBMITTED'|'STARTED'|'CANCELLED'|'CANCELLING'|'FAILED'|'SUCCESS',
'receiverConfigurations': [
{
'analysisType': 'DIRECT_ANALYSIS',
'configurationDetails': {
'directAnalysisConfigurationDetails': {
'receiverAccountIds': [
'string',
]
}
}
},
],
'jobComputePayerAccountId': 'string',
'intermediateTableConfiguration': {
'id': 'string',
'arn': 'string',
'name': 'string'
}
},
]
}
Response Structure
(dict) --
nextToken (string) --
The pagination token that's used to fetch the next set of results.
protectedJobs (list) --
A list of protected job summaries.
(dict) --
The protected job summary for the objects listed by the request.
id (string) --
The ID of the protected job.
membershipId (string) --
The unique ID for the membership that initiated the protected job.
membershipArn (string) --
The unique ARN for the membership that initiated the protected job.
createTime (datetime) --
The time the protected job was created.
status (string) --
The status of the protected job.
receiverConfigurations (list) --
The receiver configurations for the protected job.
(dict) --
The protected job receiver configuration.
analysisType (string) --
The analysis type for the protected job receiver configuration.
configurationDetails (dict) --
The configuration details for the protected job receiver.
directAnalysisConfigurationDetails (dict) --
The details needed to configure the direct analysis.
receiverAccountIds (list) --
The receiver account IDs.
(string) --
jobComputePayerAccountId (string) --
The account ID of the member that pays for the job compute costs.
intermediateTableConfiguration (dict) --
The intermediate table that the protected job populated. This field is present when the protected job was triggered by a PopulateIntermediateTable operation.
id (string) --
The unique identifier of the intermediate table.
arn (string) --
The Amazon Resource Name (ARN) of the intermediate table.
name (string) --
The name of the intermediate table.
{'computeConfiguration': {'jobComputeConfiguration': {'worker': {'number': 'integer',
'properties': {'spark': {'string': 'string'}},
'type': 'CR.1X '
'| '
'CR.4X'}}}}
Response {'analysisType': {'JOB'}}
Runs the stored query of an intermediate table and makes the results available for querying. Each call creates a new version. Use GetProtectedQuery with the returned analysis ID to track progress. Only the intermediate table owner can call this operation.
See also: AWS API Documentation
Request Syntax
client.populate_intermediate_table(
intermediateTableIdentifier='string',
membershipIdentifier='string',
parameters={
'string': 'string'
},
computeConfiguration={
'queryComputeConfiguration': {
'type': 'CR.1X'|'CR.4X'|'CR.8X',
'number': 123,
'properties': {
'spark': {
'string': 'string'
}
}
},
'jobComputeConfiguration': {
'worker': {
'type': 'CR.1X'|'CR.4X',
'number': 123,
'properties': {
'spark': {
'string': 'string'
}
}
}
}
},
analysisPayerAccountId='string'
)
string
[REQUIRED]
The unique identifier of the intermediate table to populate.
string
[REQUIRED]
The unique identifier of the membership that contains the intermediate table.
dict
The runtime parameter values that override the defaults in the stored query.
(string) --
(string) --
dict
The compute configuration for the population query execution.
queryComputeConfiguration (dict) --
The configuration of the compute resources for workers running an analysis with the Clean Rooms SQL analytics engine.
type (string) --
The worker compute configuration type.
number (integer) --
The number of workers.
SQL queries support a minimum value of 2 and a maximum value of 400.
PySpark jobs support a minimum value of 4 and a maximum value of 128.
properties (dict) --
The configuration properties for the worker compute environment. These properties allow you to customize the compute settings for your Clean Rooms workloads.
spark (dict) --
The Spark configuration properties for SQL and PySpark workloads. This map contains key-value pairs that configure Apache Spark settings to optimize performance for your data processing jobs. You can specify up to 50 Spark properties, with each key being 1-200 characters and each value being 0-500 characters. These properties allow you to adjust compute capacity for large datasets and complex workloads.
(string) --
(string) --
jobComputeConfiguration (dict) --
Specifies the compute configuration for the PySpark job that populates the intermediate table.
worker (dict) --
The worker configuration for the compute environment.
type (string) -- [REQUIRED]
The worker compute configuration type.
number (integer) -- [REQUIRED]
The number of workers for a PySpark job.
properties (dict) --
The configuration properties for the worker compute environment. These properties allow you to customize the compute settings for your Clean Rooms workloads.
spark (dict) --
The Spark configuration properties for SQL and PySpark workloads. This map contains key-value pairs that configure Apache Spark settings to optimize performance for your data processing jobs. You can specify up to 50 Spark properties, with each key being 1-200 characters and each value being 0-500 characters. These properties allow you to adjust compute capacity for large datasets and complex workloads.
(string) --
(string) --
string
The account ID of the member that pays for the analysis compute costs.
dict
Response Syntax
{
'analysisId': 'string',
'analysisType': 'QUERY'|'JOB',
'versionId': 'string'
}
Response Structure
(dict) --
analysisId (string) --
The identifier for the protected query execution that populated the intermediate table.
analysisType (string) --
The type of analysis performed to populate the intermediate table.
versionId (string) --
The unique identifier of the version created by this population operation.
{'protectedJob': {'resultConfiguration': {'outputConfiguration': {'intermediateTable': {'arn': 'string',
'id': 'string',
'name': 'string'}}}}}
Creates a protected job that is started by Clean Rooms.
See also: AWS API Documentation
Request Syntax
client.start_protected_job(
type='PYSPARK',
membershipIdentifier='string',
jobParameters={
'analysisTemplateArn': 'string',
'parameters': {
'string': 'string'
}
},
resultConfiguration={
'outputConfiguration': {
'member': {
'accountId': 'string'
}
}
},
computeConfiguration={
'worker': {
'type': 'CR.1X'|'CR.4X',
'number': 123,
'properties': {
'spark': {
'string': 'string'
}
}
}
},
jobComputePayerAccountId='string'
)
string
[REQUIRED]
The type of protected job to start.
string
[REQUIRED]
A unique identifier for the membership to run this job against. Currently accepts a membership ID.
dict
[REQUIRED]
The job parameters.
analysisTemplateArn (string) -- [REQUIRED]
The ARN of the analysis template.
parameters (dict) --
Runtime configuration values passed to the PySpark analysis script. Parameter names and types must match those defined in the analysis template.
(string) --
(string) --
dict
The details needed to write the job results.
outputConfiguration (dict) -- [REQUIRED]
The output configuration for a protected job result.
member (dict) --
The member of the protected job output configuration input.
accountId (string) -- [REQUIRED]
The account ID.
dict
The compute configuration for the protected job.
worker (dict) --
The worker configuration for the compute environment.
type (string) -- [REQUIRED]
The worker compute configuration type.
number (integer) -- [REQUIRED]
The number of workers for a PySpark job.
properties (dict) --
The configuration properties for the worker compute environment. These properties allow you to customize the compute settings for your Clean Rooms workloads.
spark (dict) --
The Spark configuration properties for SQL and PySpark workloads. This map contains key-value pairs that configure Apache Spark settings to optimize performance for your data processing jobs. You can specify up to 50 Spark properties, with each key being 1-200 characters and each value being 0-500 characters. These properties allow you to adjust compute capacity for large datasets and complex workloads.
(string) --
(string) --
string
The account ID of the member that pays for the job compute costs.
dict
Response Syntax
{
'protectedJob': {
'id': 'string',
'membershipId': 'string',
'membershipArn': 'string',
'createTime': datetime(2015, 1, 1),
'jobParameters': {
'analysisTemplateArn': 'string',
'parameters': {
'string': 'string'
}
},
'status': 'SUBMITTED'|'STARTED'|'CANCELLED'|'CANCELLING'|'FAILED'|'SUCCESS',
'resultConfiguration': {
'outputConfiguration': {
's3': {
'bucket': 'string',
'keyPrefix': 'string'
},
'member': {
'accountId': 'string'
},
'intermediateTable': {
'id': 'string',
'arn': 'string',
'name': 'string'
}
}
},
'statistics': {
'totalDurationInMillis': 123,
'billedResourceUtilization': {
'units': 123.0
}
},
'result': {
'output': {
's3': {
'location': 'string'
},
'memberList': [
{
'accountId': 'string'
},
]
}
},
'error': {
'message': 'string',
'code': 'string',
'retry': {
'retryable': True|False
}
},
'computeConfiguration': {
'worker': {
'type': 'CR.1X'|'CR.4X',
'number': 123,
'properties': {
'spark': {
'string': 'string'
}
}
}
},
'jobComputePayerAccountId': 'string'
}
}
Response Structure
(dict) --
protectedJob (dict) --
The protected job.
id (string) --
The identifier for a protected job instance.
membershipId (string) --
he identifier for the membership.
membershipArn (string) --
The ARN of the membership.
createTime (datetime) --
The creation time of the protected job.
jobParameters (dict) --
The job parameters for the protected job.
analysisTemplateArn (string) --
The ARN of the analysis template.
parameters (dict) --
Runtime configuration values passed to the PySpark analysis script. Parameter names and types must match those defined in the analysis template.
(string) --
(string) --
status (string) --
The status of the protected job.
resultConfiguration (dict) --
Contains any details needed to write the job results.
outputConfiguration (dict) --
The output configuration.
s3 (dict) --
If present, the output for a protected job with an S3 output type.
bucket (string) --
The S3 bucket for job output.
keyPrefix (string) --
The S3 prefix to unload the protected job results.
member (dict) --
The member output configuration for a protected job.
accountId (string) --
The account ID.
intermediateTable (dict) --
Specifies the intermediate table that the protected job populated, identified by its ID, Amazon Resource Name (ARN), and name. This field is present when the protected job was triggered by a PopulateIntermediateTable operation.
id (string) --
The unique identifier of the intermediate table.
arn (string) --
The Amazon Resource Name (ARN) of the intermediate table.
name (string) --
The name of the intermediate table.
statistics (dict) --
The statistics of the protected job.
totalDurationInMillis (integer) --
The duration of the protected job, from creation until job completion, in milliseconds.
billedResourceUtilization (dict) --
The billed resource utilization for the protected job.
units (float) --
The number of Clean Rooms Processing Unit (CRPU) hours that have been billed.
result (dict) --
The result of the protected job.
output (dict) --
The output of the protected job.
s3 (dict) --
If present, the output for a protected job with an S3 output type.
location (string) --
The S3 location for the protected job output.
memberList (list) --
The list of member Amazon Web Services account(s) that received the results of the job.
(dict) --
Details about the member who received the job result.
accountId (string) --
The Amazon Web Services account ID of the member in the collaboration who can receive results from analyses.
error (dict) --
The error from the protected job.
message (string) --
A description of why the protected job failed.
code (string) --
A code that identifies the category of the failure. Valid values are:
MALFORMED_SCRIPT – The job script or its execution environment is not valid (code, imports, entry point, virtual environment, or dependencies).
RESOURCE_NOT_FOUND – A referenced resource doesn't exist.
INVALID_RESOURCE – A referenced resource exists, but you can't use it because its configuration, state, or data is not valid.
RESOURCE_ACCESS_DENIED – A required permission is missing for a data source or resource.
INSUFFICIENT_COMPUTE – The job exceeded the available compute (memory, disk, or time).
TRANSIENT_ERROR – A temporary condition caused the failure, such as throttling or a network interruption.
INTERNAL_ERROR – Clean Rooms encountered an unexpected error. If the error persists, contact AWS Support.
UNKNOWN_ERROR – The failure couldn't be classified.
For more information about error codes, see https://docs.aws.amazon.com/clean-rooms/latest/userguide/error-codes.html in the Clean Rooms User Guide.
retry (dict) --
Contains information about whether running the same protected job again might succeed.
retryable (boolean) --
Specifies whether running the same request again might succeed. true means that the failure was transient. false means that running the same request again is not expected to succeed.
computeConfiguration (dict) --
The compute configuration for the protected job.
worker (dict) --
The worker configuration for the compute environment.
type (string) --
The worker compute configuration type.
number (integer) --
The number of workers for a PySpark job.
properties (dict) --
The configuration properties for the worker compute environment. These properties allow you to customize the compute settings for your Clean Rooms workloads.
spark (dict) --
The Spark configuration properties for SQL and PySpark workloads. This map contains key-value pairs that configure Apache Spark settings to optimize performance for your data processing jobs. You can specify up to 50 Spark properties, with each key being 1-200 characters and each value being 0-500 characters. These properties allow you to adjust compute capacity for large datasets and complex workloads.
(string) --
(string) --
jobComputePayerAccountId (string) --
The account ID of the member that pays for the job compute costs.
{'intermediateTable': {'intermediateTableVersion': {'analysisType': {'JOB'}},
'populationAnalysisConfiguration': {'jobParameters': {'analysisTemplateArn': 'string'}}}}
Updates an intermediate table. You can update the description, KMS key ARN, and column types of existing columns. Only the intermediate table owner can call this operation.
See also: AWS API Documentation
Request Syntax
client.update_intermediate_table(
intermediateTableIdentifier='string',
membershipIdentifier='string',
description='string',
kmsKeyArn='string',
columns=[
{
'name': 'string',
'type': 'string'
},
]
)
string
[REQUIRED]
The unique identifier of the intermediate table to update.
string
[REQUIRED]
The unique identifier of the membership that contains the intermediate table.
string
A new description for the intermediate table.
string
The Amazon Resource Name (ARN) of the customer-managed KMS key to use for encrypting future population data.
list
The list of columns with updated type definitions. Only the type of existing columns can be updated.
(dict) --
Contains the name and type of a column in an intermediate table.
name (string) -- [REQUIRED]
The name of the column.
type (string) -- [REQUIRED]
The data type of the column.
dict
Response Syntax
{
'intermediateTable': {
'id': 'string',
'arn': 'string',
'name': 'string',
'description': 'string',
'membershipArn': 'string',
'membershipId': 'string',
'collaborationArn': 'string',
'collaborationId': 'string',
'childResources': [
{
'resourceId': 'string',
'resourceType': 'INTERMEDIATE_TABLE',
'resourceName': 'string',
'ownerAccountId': 'string',
'resourceStatus': 'CREATED'|'POPULATE_STARTED'|'POPULATE_SUCCESS'|'POPULATE_FAILED'|'DISALLOWED_BY_DATA_PROVIDER'|'BASE_TABLE_REMOVED'|'RETENTION_PERIOD_EXPIRED'
},
],
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'status': 'CREATED'|'POPULATE_STARTED'|'POPULATE_SUCCESS'|'POPULATE_FAILED'|'DISALLOWED_BY_DATA_PROVIDER'|'BASE_TABLE_REMOVED'|'RETENTION_PERIOD_EXPIRED',
'statusReason': 'string',
'kmsKeyArn': 'string',
'populationAnalysisConfiguration': {
'sqlParameters': {
'queryString': 'string',
'analysisTemplateArn': 'string'
},
'jobParameters': {
'analysisTemplateArn': 'string'
}
},
'retentionInDays': 123,
'tableDependencies': [
{
'id': 'string',
'name': 'string',
'type': 'TABLE'|'INTERMEDIATE_TABLE'|'ID_MAPPING_TABLE',
'parentType': 'DIRECT'|'INDIRECT',
'creatorAccountId': 'string'
},
],
'intermediateTableVersion': {
'versionId': 'string',
'analysisId': 'string',
'analysisType': 'QUERY'|'JOB',
'kmsKeyArn': 'string',
'parameters': {
'string': 'string'
},
'inheritedConstraints': {
'additionalAnalyses': {
'value': 'ALLOWED'|'REQUIRED'|'NOT_ALLOWED',
'sources': [
{
'name': 'string',
'id': 'string',
'type': 'TABLE'|'INTERMEDIATE_TABLE'|'ID_MAPPING_TABLE',
'value': 'ALLOWED'|'REQUIRED'|'NOT_ALLOWED',
'sourceAccountId': 'string'
},
]
},
'allowedAdditionalAnalyses': {
'value': [
'string',
],
'sources': [
{
'name': 'string',
'id': 'string',
'type': 'TABLE'|'INTERMEDIATE_TABLE'|'ID_MAPPING_TABLE',
'value': [
'string',
],
'sourceAccountId': 'string'
},
]
},
'allowedResultReceivers': {
'value': [
'string',
],
'sources': [
{
'name': 'string',
'id': 'string',
'type': 'TABLE'|'INTERMEDIATE_TABLE'|'ID_MAPPING_TABLE',
'value': [
'string',
],
'sourceAccountId': 'string'
},
]
},
'disallowedOutputColumns': {
'value': [
'string',
],
'columnLineage': [
{
'column': 'string',
'sourceColumn': 'string',
'sourceName': 'string',
'sourceId': 'string',
'sourceType': 'TABLE'|'INTERMEDIATE_TABLE'|'ID_MAPPING_TABLE',
'sourceAccountId': 'string'
},
]
}
},
'expirationTime': datetime(2015, 1, 1)
},
'analysisRuleTypes': [
'CUSTOM',
],
'schema': {
'columns': [
{
'name': 'string',
'type': 'string'
},
]
}
}
}
Response Structure
(dict) --
intermediateTable (dict) --
The updated intermediate table.
id (string) --
The unique identifier of the intermediate table.
arn (string) --
The Amazon Resource Name (ARN) of the intermediate table.
name (string) --
The name of the intermediate table.
description (string) --
The description of the intermediate table.
membershipArn (string) --
The Amazon Resource Name (ARN) of the membership that contains the intermediate table.
membershipId (string) --
The unique identifier of the membership that contains the intermediate table.
collaborationArn (string) --
The Amazon Resource Name (ARN) of the collaboration that contains the intermediate table.
collaborationId (string) --
The unique identifier of the collaboration that contains the intermediate table.
childResources (list) --
The child resources that depend on this intermediate table.
(dict) --
Contains information about a child resource of a given resource in a collaboration.
resourceId (string) --
The unique identifier of the child resource.
resourceType (string) --
The type of the child resource.
resourceName (string) --
The name of the child resource.
ownerAccountId (string) --
The Amazon Web Services account ID of the member who owns the child resource.
resourceStatus (string) --
The current status of the child resource.
createTime (datetime) --
The time the intermediate table was created.
updateTime (datetime) --
The time the intermediate table was last updated.
status (string) --
The current status of the intermediate table.
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.
populationAnalysisConfiguration (dict) --
The analysis configuration that defines the query used to populate the intermediate table.
sqlParameters (dict) --
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.
analysisTemplateArn (string) --
The Amazon Resource Name (ARN) of the analysis template to use for populating the intermediate table.
jobParameters (dict) --
Specifies the PySpark job parameters for the population analysis. Use jobParameters instead of sqlParameters when you populate the intermediate table with results from a PySpark job.
analysisTemplateArn (string) --
Specifies the ARN of the PySpark analysis template that populates the intermediate table. Provide this ARN in jobParameters when you populate the intermediate table with results from a PySpark job.
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.
(dict) --
Contains information about a base table that an intermediate table depends on.
id (string) --
The unique identifier of the dependency table.
name (string) --
The name of the dependency table.
type (string) --
The type of the dependency table.
parentType (string) --
The type of dependency, either direct or indirect. A direct dependency is a table explicitly referenced in the stored query. An indirect dependency is a table referenced through another intermediate table.
creatorAccountId (string) --
The Amazon Web Services account ID of the member who owns the dependency table.
intermediateTableVersion (dict) --
The details of the currently active version of the intermediate table.
versionId (string) --
The unique identifier of the active version.
analysisId (string) --
The identifier of the protected query that created this version.
analysisType (string) --
The type of analysis that created this version.
kmsKeyArn (string) --
The Amazon Resource Name (ARN) of the KMS key used to encrypt this version's data.
parameters (dict) --
The runtime parameters that were used when populating this version.
(string) --
(string) --
inheritedConstraints (dict) --
The privacy constraints inherited from parent tables at the time this version was populated.
additionalAnalyses (dict) --
The inherited additional analyses constraint.
value (string) --
The effective additional analyses setting inherited from parent tables.
sources (list) --
The list of parent tables that contribute to this inherited constraint.
(dict) --
Contains information about a parent table that contributes an additional analyses constraint.
name (string) --
The name of the parent table.
id (string) --
The unique identifier of the parent table.
type (string) --
The type of the parent table.
value (string) --
The additional analyses setting defined on the parent table.
sourceAccountId (string) --
The Amazon Web Services account ID of the member who owns the parent table.
allowedAdditionalAnalyses (dict) --
The inherited allowed additional analyses constraint.
value (list) --
The effective list of allowed additional analyses inherited from parent tables.
(string) --
sources (list) --
The list of parent tables that contribute to this inherited constraint.
(dict) --
Contains information about a parent table that contributes an allowed additional analyses constraint.
name (string) --
The name of the parent table.
id (string) --
The unique identifier of the parent table.
type (string) --
The type of the parent table.
value (list) --
The allowed additional analyses defined on the parent table.
(string) --
sourceAccountId (string) --
The Amazon Web Services account ID of the member who owns the parent table.
allowedResultReceivers (dict) --
The inherited allowed result receivers constraint.
value (list) --
The effective list of Amazon Web Services account IDs allowed to receive results, inherited from parent tables.
(string) --
sources (list) --
The list of parent tables that contribute to this inherited constraint.
(dict) --
Contains information about a parent table that contributes an allowed result receivers constraint.
name (string) --
The name of the parent table.
id (string) --
The unique identifier of the parent table.
type (string) --
The type of the parent table.
value (list) --
The allowed result receiver account IDs defined on the parent table.
(string) --
sourceAccountId (string) --
The Amazon Web Services account ID of the member who owns the parent table.
disallowedOutputColumns (dict) --
The inherited disallowed output columns constraint.
value (list) --
The list of column names that are disallowed from appearing in query output, inherited from parent tables.
(string) --
columnLineage (list) --
The lineage information that traces each disallowed output column back to its source in a parent table.
(dict) --
Contains column lineage information that traces a disallowed output column back to its source in a base table.
column (string) --
The name of the column in the intermediate table.
sourceColumn (string) --
The name of the column in the source table.
sourceName (string) --
The name of the source table.
sourceId (string) --
The unique identifier of the source table.
sourceType (string) --
The type of the source table.
sourceAccountId (string) --
The Amazon Web Services account ID of the owner of the source table.
expirationTime (datetime) --
The time when this version expires based on the retention period.
analysisRuleTypes (list) --
The types of analysis rules associated with the intermediate table.
(string) --
schema (dict) --
The schema of the intermediate table, containing column definitions. Available after the table has been successfully populated.
columns (list) --
The list of columns in the intermediate table schema.
(dict) --
A column within a schema relation, derived from the underlying table.
name (string) --
The name of the column.
type (string) --
The type of the column.
{'protectedJob': {'resultConfiguration': {'outputConfiguration': {'intermediateTable': {'arn': 'string',
'id': 'string',
'name': 'string'}}}}}
Updates the processing of a currently running job.
See also: AWS API Documentation
Request Syntax
client.update_protected_job(
membershipIdentifier='string',
protectedJobIdentifier='string',
targetStatus='CANCELLED'
)
string
[REQUIRED]
The identifier for a member of a protected job instance.
string
[REQUIRED]
The identifier of the protected job to update.
string
[REQUIRED]
The target status of a protected job. Used to update the execution status of a currently running job.
dict
Response Syntax
{
'protectedJob': {
'id': 'string',
'membershipId': 'string',
'membershipArn': 'string',
'createTime': datetime(2015, 1, 1),
'jobParameters': {
'analysisTemplateArn': 'string',
'parameters': {
'string': 'string'
}
},
'status': 'SUBMITTED'|'STARTED'|'CANCELLED'|'CANCELLING'|'FAILED'|'SUCCESS',
'resultConfiguration': {
'outputConfiguration': {
's3': {
'bucket': 'string',
'keyPrefix': 'string'
},
'member': {
'accountId': 'string'
},
'intermediateTable': {
'id': 'string',
'arn': 'string',
'name': 'string'
}
}
},
'statistics': {
'totalDurationInMillis': 123,
'billedResourceUtilization': {
'units': 123.0
}
},
'result': {
'output': {
's3': {
'location': 'string'
},
'memberList': [
{
'accountId': 'string'
},
]
}
},
'error': {
'message': 'string',
'code': 'string',
'retry': {
'retryable': True|False
}
},
'computeConfiguration': {
'worker': {
'type': 'CR.1X'|'CR.4X',
'number': 123,
'properties': {
'spark': {
'string': 'string'
}
}
}
},
'jobComputePayerAccountId': 'string'
}
}
Response Structure
(dict) --
protectedJob (dict) --
The protected job output.
id (string) --
The identifier for a protected job instance.
membershipId (string) --
he identifier for the membership.
membershipArn (string) --
The ARN of the membership.
createTime (datetime) --
The creation time of the protected job.
jobParameters (dict) --
The job parameters for the protected job.
analysisTemplateArn (string) --
The ARN of the analysis template.
parameters (dict) --
Runtime configuration values passed to the PySpark analysis script. Parameter names and types must match those defined in the analysis template.
(string) --
(string) --
status (string) --
The status of the protected job.
resultConfiguration (dict) --
Contains any details needed to write the job results.
outputConfiguration (dict) --
The output configuration.
s3 (dict) --
If present, the output for a protected job with an S3 output type.
bucket (string) --
The S3 bucket for job output.
keyPrefix (string) --
The S3 prefix to unload the protected job results.
member (dict) --
The member output configuration for a protected job.
accountId (string) --
The account ID.
intermediateTable (dict) --
Specifies the intermediate table that the protected job populated, identified by its ID, Amazon Resource Name (ARN), and name. This field is present when the protected job was triggered by a PopulateIntermediateTable operation.
id (string) --
The unique identifier of the intermediate table.
arn (string) --
The Amazon Resource Name (ARN) of the intermediate table.
name (string) --
The name of the intermediate table.
statistics (dict) --
The statistics of the protected job.
totalDurationInMillis (integer) --
The duration of the protected job, from creation until job completion, in milliseconds.
billedResourceUtilization (dict) --
The billed resource utilization for the protected job.
units (float) --
The number of Clean Rooms Processing Unit (CRPU) hours that have been billed.
result (dict) --
The result of the protected job.
output (dict) --
The output of the protected job.
s3 (dict) --
If present, the output for a protected job with an S3 output type.
location (string) --
The S3 location for the protected job output.
memberList (list) --
The list of member Amazon Web Services account(s) that received the results of the job.
(dict) --
Details about the member who received the job result.
accountId (string) --
The Amazon Web Services account ID of the member in the collaboration who can receive results from analyses.
error (dict) --
The error from the protected job.
message (string) --
A description of why the protected job failed.
code (string) --
A code that identifies the category of the failure. Valid values are:
MALFORMED_SCRIPT – The job script or its execution environment is not valid (code, imports, entry point, virtual environment, or dependencies).
RESOURCE_NOT_FOUND – A referenced resource doesn't exist.
INVALID_RESOURCE – A referenced resource exists, but you can't use it because its configuration, state, or data is not valid.
RESOURCE_ACCESS_DENIED – A required permission is missing for a data source or resource.
INSUFFICIENT_COMPUTE – The job exceeded the available compute (memory, disk, or time).
TRANSIENT_ERROR – A temporary condition caused the failure, such as throttling or a network interruption.
INTERNAL_ERROR – Clean Rooms encountered an unexpected error. If the error persists, contact AWS Support.
UNKNOWN_ERROR – The failure couldn't be classified.
For more information about error codes, see https://docs.aws.amazon.com/clean-rooms/latest/userguide/error-codes.html in the Clean Rooms User Guide.
retry (dict) --
Contains information about whether running the same protected job again might succeed.
retryable (boolean) --
Specifies whether running the same request again might succeed. true means that the failure was transient. false means that running the same request again is not expected to succeed.
computeConfiguration (dict) --
The compute configuration for the protected job.
worker (dict) --
The worker configuration for the compute environment.
type (string) --
The worker compute configuration type.
number (integer) --
The number of workers for a PySpark job.
properties (dict) --
The configuration properties for the worker compute environment. These properties allow you to customize the compute settings for your Clean Rooms workloads.
spark (dict) --
The Spark configuration properties for SQL and PySpark workloads. This map contains key-value pairs that configure Apache Spark settings to optimize performance for your data processing jobs. You can specify up to 50 Spark properties, with each key being 1-200 characters and each value being 0-500 characters. These properties allow you to adjust compute capacity for large datasets and complex workloads.
(string) --
(string) --
jobComputePayerAccountId (string) --
The account ID of the member that pays for the job compute costs.