2026/11/12 - AWS Clean Rooms Service - 6 updated api methods
Changes Adds a retry signal to protected query and protected job errors that indicates whether running the same request again might succeed, and defines error codes that identify the category of the failure.
{'protectedJob': {'error': {'retry': {'retryable': 'boolean'}}}}
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'
}
}
},
'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.
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.
{'protectedQuery': {'error': {'retry': {'retryable': 'boolean'}}}}
Returns query processing metadata.
See also: AWS API Documentation
Request Syntax
client.get_protected_query(
membershipIdentifier='string',
protectedQueryIdentifier='string'
)
string
[REQUIRED]
The identifier for a membership in a protected query instance.
string
[REQUIRED]
The identifier for a protected query instance.
dict
Response Syntax
{
'protectedQuery': {
'id': 'string',
'membershipId': 'string',
'membershipArn': 'string',
'createTime': datetime(2015, 1, 1),
'sqlParameters': {
'queryString': 'string',
'analysisTemplateArn': 'string',
'parameters': {
'string': 'string'
}
},
'status': 'SUBMITTED'|'STARTED'|'CANCELLED'|'CANCELLING'|'FAILED'|'SUCCESS'|'TIMED_OUT',
'resultConfiguration': {
'outputConfiguration': {
's3': {
'resultFormat': 'CSV'|'PARQUET',
'bucket': 'string',
'keyPrefix': 'string',
'singleFileOutput': True|False
},
'member': {
'accountId': 'string'
},
'distribute': {
'locations': [
{
's3': {
'resultFormat': 'CSV'|'PARQUET',
'bucket': 'string',
'keyPrefix': 'string',
'singleFileOutput': True|False
},
'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'
},
],
'distribute': {
's3': {
'location': 'string'
},
'memberList': [
{
'accountId': 'string'
},
]
}
}
},
'error': {
'message': 'string',
'code': 'string',
'retry': {
'retryable': True|False
}
},
'differentialPrivacy': {
'sensitivityParameters': [
{
'aggregationType': 'AVG'|'COUNT'|'COUNT_DISTINCT'|'SUM'|'STDDEV',
'aggregationExpression': 'string',
'userContributionLimit': 123,
'minColumnValue': ...,
'maxColumnValue': ...
},
]
},
'computeConfiguration': {
'worker': {
'type': 'CR.1X'|'CR.4X'|'CR.8X',
'number': 123,
'properties': {
'spark': {
'string': 'string'
}
}
}
},
'queryComputePayerAccountId': 'string'
}
}
Response Structure
(dict) --
protectedQuery (dict) --
The query processing metadata.
id (string) --
The identifier for a protected query instance.
membershipId (string) --
The identifier for the membership.
membershipArn (string) --
The ARN of the membership.
createTime (datetime) --
The time at which the protected query was created.
sqlParameters (dict) --
The protected query SQL parameters.
queryString (string) --
The query string to be submitted.
analysisTemplateArn (string) --
The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.
parameters (dict) --
The protected query SQL parameters.
(string) --
(string) --
status (string) --
The status of the query.
resultConfiguration (dict) --
Contains any details needed to write the query results.
outputConfiguration (dict) --
Configuration for protected query results.
s3 (dict) --
Required configuration for a protected query with an s3 output type.
resultFormat (string) --
Intended file format of the result.
bucket (string) --
The S3 bucket to unload the protected query results.
keyPrefix (string) --
The S3 prefix to unload the protected query results.
singleFileOutput (boolean) --
Indicates whether files should be output as a single file ( TRUE) or output as multiple files ( FALSE). This parameter is only supported for analyses with the Spark analytics engine.
member (dict) --
Required configuration for a protected query with a member output type.
accountId (string) --
The unique identifier for the account.
distribute (dict) --
Required configuration for a protected query with a distribute output type.
locations (list) --
A list of locations where you want to distribute the protected query results. Each location must specify either an S3 destination or a collaboration member destination.
(dict) --
Specifies where you'll distribute the results of your protected query. You must configure either an S3 destination or a collaboration member destination.
s3 (dict) --
Contains the configuration to write the query results to S3.
resultFormat (string) --
Intended file format of the result.
bucket (string) --
The S3 bucket to unload the protected query results.
keyPrefix (string) --
The S3 prefix to unload the protected query results.
singleFileOutput (boolean) --
Indicates whether files should be output as a single file ( TRUE) or output as multiple files ( FALSE). This parameter is only supported for analyses with the Spark analytics engine.
member (dict) --
Contains configuration details for the protected query member output.
accountId (string) --
The unique identifier for the account.
intermediateTable (dict) --
The intermediate table output configuration, present when the protected query was triggered by a populate 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) --
Statistics about protected query execution.
totalDurationInMillis (integer) --
The duration of the protected query, from creation until query completion, in milliseconds.
billedResourceUtilization (dict) --
The billed resource utilization.
units (float) --
The number of Clean Rooms Processing Unit (CRPU) hours that have been billed.
result (dict) --
The result of the protected query.
output (dict) --
The output of the protected query.
s3 (dict) --
If present, the output for a protected query with an S3 output type.
location (string) --
The S3 location of the result.
memberList (list) --
The list of member Amazon Web Services account(s) that received the results of the query.
(dict) --
Details about the member who received the query result.
accountId (string) --
The Amazon Web Services account ID of the member in the collaboration who can receive results for the query.
distribute (dict) --
Contains output information for protected queries that use a distribute output type. This output type lets you send query results to multiple locations - either to S3 or to collaboration members.
s3 (dict) --
Contains output information for protected queries with an S3 output type.
location (string) --
The S3 location of the result.
memberList (list) --
Contains the output results for each member location specified in the distribute output configuration. Each entry provides details about the result distribution to a specific collaboration member.
(dict) --
Details about the member who received the query result.
accountId (string) --
The Amazon Web Services account ID of the member in the collaboration who can receive results for the query.
error (dict) --
An error thrown by the protected query.
message (string) --
A description of why the protected query failed.
code (string) --
A code that identifies the category of the failure. Valid values are:
MALFORMED_QUERY – The query is not valid (syntax, semantics, columns, or an unsupported operation).
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 query 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 query 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.
differentialPrivacy (dict) --
The sensitivity parameters of the differential privacy results of the protected query.
sensitivityParameters (list) --
Provides the sensitivity parameters that you can use to better understand the total amount of noise in query results.
(dict) --
Provides the sensitivity parameters.
aggregationType (string) --
The type of aggregation function that was run.
aggregationExpression (string) --
The aggregation expression that was run.
userContributionLimit (integer) --
The maximum number of rows contributed by a user in a SQL query.
minColumnValue (float) --
The lower bound of the aggregation expression.
maxColumnValue (float) --
The upper bound of the aggregation expression.
computeConfiguration (dict) --
The compute configuration for the protected query.
worker (dict) --
The worker configuration for the compute environment.
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) --
queryComputePayerAccountId (string) --
The account ID of the member that pays for the query compute costs.
{'protectedJob': {'error': {'retry': {'retryable': 'boolean'}}}}
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'
}
}
},
'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.
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.
{'protectedQuery': {'error': {'retry': {'retryable': 'boolean'}}}}
Creates a protected query that is started by Clean Rooms.
See also: AWS API Documentation
Request Syntax
client.start_protected_query(
type='SQL',
membershipIdentifier='string',
sqlParameters={
'queryString': 'string',
'analysisTemplateArn': 'string',
'parameters': {
'string': 'string'
}
},
resultConfiguration={
'outputConfiguration': {
's3': {
'resultFormat': 'CSV'|'PARQUET',
'bucket': 'string',
'keyPrefix': 'string',
'singleFileOutput': True|False
},
'member': {
'accountId': 'string'
},
'distribute': {
'locations': [
{
's3': {
'resultFormat': 'CSV'|'PARQUET',
'bucket': 'string',
'keyPrefix': 'string',
'singleFileOutput': True|False
},
'member': {
'accountId': 'string'
}
},
]
},
'intermediateTable': {
'id': 'string',
'arn': 'string',
'name': 'string'
}
}
},
computeConfiguration={
'worker': {
'type': 'CR.1X'|'CR.4X'|'CR.8X',
'number': 123,
'properties': {
'spark': {
'string': 'string'
}
}
}
},
queryComputePayerAccountId='string'
)
string
[REQUIRED]
The type of the protected query to be started.
string
[REQUIRED]
A unique identifier for the membership to run this query against. Currently accepts a membership ID.
dict
[REQUIRED]
The protected SQL query parameters.
queryString (string) --
The query string to be submitted.
analysisTemplateArn (string) --
The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.
parameters (dict) --
The protected query SQL parameters.
(string) --
(string) --
dict
The details needed to write the query results.
outputConfiguration (dict) -- [REQUIRED]
Configuration for protected query results.
s3 (dict) --
Required configuration for a protected query with an s3 output type.
resultFormat (string) -- [REQUIRED]
Intended file format of the result.
bucket (string) -- [REQUIRED]
The S3 bucket to unload the protected query results.
keyPrefix (string) --
The S3 prefix to unload the protected query results.
singleFileOutput (boolean) --
Indicates whether files should be output as a single file ( TRUE) or output as multiple files ( FALSE). This parameter is only supported for analyses with the Spark analytics engine.
member (dict) --
Required configuration for a protected query with a member output type.
accountId (string) -- [REQUIRED]
The unique identifier for the account.
distribute (dict) --
Required configuration for a protected query with a distribute output type.
locations (list) -- [REQUIRED]
A list of locations where you want to distribute the protected query results. Each location must specify either an S3 destination or a collaboration member destination.
(dict) --
Specifies where you'll distribute the results of your protected query. You must configure either an S3 destination or a collaboration member destination.
s3 (dict) --
Contains the configuration to write the query results to S3.
resultFormat (string) -- [REQUIRED]
Intended file format of the result.
bucket (string) -- [REQUIRED]
The S3 bucket to unload the protected query results.
keyPrefix (string) --
The S3 prefix to unload the protected query results.
singleFileOutput (boolean) --
Indicates whether files should be output as a single file ( TRUE) or output as multiple files ( FALSE). This parameter is only supported for analyses with the Spark analytics engine.
member (dict) --
Contains configuration details for the protected query member output.
accountId (string) -- [REQUIRED]
The unique identifier for the account.
intermediateTable (dict) --
The intermediate table output configuration, present when the protected query was triggered by a populate operation.
id (string) -- [REQUIRED]
The unique identifier of the intermediate table.
arn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the intermediate table.
name (string) -- [REQUIRED]
The name of the intermediate table.
dict
The compute configuration for the protected query.
worker (dict) --
The worker configuration for the compute environment.
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) --
string
The account ID of the member that pays for the query compute costs.
dict
Response Syntax
{
'protectedQuery': {
'id': 'string',
'membershipId': 'string',
'membershipArn': 'string',
'createTime': datetime(2015, 1, 1),
'sqlParameters': {
'queryString': 'string',
'analysisTemplateArn': 'string',
'parameters': {
'string': 'string'
}
},
'status': 'SUBMITTED'|'STARTED'|'CANCELLED'|'CANCELLING'|'FAILED'|'SUCCESS'|'TIMED_OUT',
'resultConfiguration': {
'outputConfiguration': {
's3': {
'resultFormat': 'CSV'|'PARQUET',
'bucket': 'string',
'keyPrefix': 'string',
'singleFileOutput': True|False
},
'member': {
'accountId': 'string'
},
'distribute': {
'locations': [
{
's3': {
'resultFormat': 'CSV'|'PARQUET',
'bucket': 'string',
'keyPrefix': 'string',
'singleFileOutput': True|False
},
'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'
},
],
'distribute': {
's3': {
'location': 'string'
},
'memberList': [
{
'accountId': 'string'
},
]
}
}
},
'error': {
'message': 'string',
'code': 'string',
'retry': {
'retryable': True|False
}
},
'differentialPrivacy': {
'sensitivityParameters': [
{
'aggregationType': 'AVG'|'COUNT'|'COUNT_DISTINCT'|'SUM'|'STDDEV',
'aggregationExpression': 'string',
'userContributionLimit': 123,
'minColumnValue': ...,
'maxColumnValue': ...
},
]
},
'computeConfiguration': {
'worker': {
'type': 'CR.1X'|'CR.4X'|'CR.8X',
'number': 123,
'properties': {
'spark': {
'string': 'string'
}
}
}
},
'queryComputePayerAccountId': 'string'
}
}
Response Structure
(dict) --
protectedQuery (dict) --
The protected query.
id (string) --
The identifier for a protected query instance.
membershipId (string) --
The identifier for the membership.
membershipArn (string) --
The ARN of the membership.
createTime (datetime) --
The time at which the protected query was created.
sqlParameters (dict) --
The protected query SQL parameters.
queryString (string) --
The query string to be submitted.
analysisTemplateArn (string) --
The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.
parameters (dict) --
The protected query SQL parameters.
(string) --
(string) --
status (string) --
The status of the query.
resultConfiguration (dict) --
Contains any details needed to write the query results.
outputConfiguration (dict) --
Configuration for protected query results.
s3 (dict) --
Required configuration for a protected query with an s3 output type.
resultFormat (string) --
Intended file format of the result.
bucket (string) --
The S3 bucket to unload the protected query results.
keyPrefix (string) --
The S3 prefix to unload the protected query results.
singleFileOutput (boolean) --
Indicates whether files should be output as a single file ( TRUE) or output as multiple files ( FALSE). This parameter is only supported for analyses with the Spark analytics engine.
member (dict) --
Required configuration for a protected query with a member output type.
accountId (string) --
The unique identifier for the account.
distribute (dict) --
Required configuration for a protected query with a distribute output type.
locations (list) --
A list of locations where you want to distribute the protected query results. Each location must specify either an S3 destination or a collaboration member destination.
(dict) --
Specifies where you'll distribute the results of your protected query. You must configure either an S3 destination or a collaboration member destination.
s3 (dict) --
Contains the configuration to write the query results to S3.
resultFormat (string) --
Intended file format of the result.
bucket (string) --
The S3 bucket to unload the protected query results.
keyPrefix (string) --
The S3 prefix to unload the protected query results.
singleFileOutput (boolean) --
Indicates whether files should be output as a single file ( TRUE) or output as multiple files ( FALSE). This parameter is only supported for analyses with the Spark analytics engine.
member (dict) --
Contains configuration details for the protected query member output.
accountId (string) --
The unique identifier for the account.
intermediateTable (dict) --
The intermediate table output configuration, present when the protected query was triggered by a populate 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) --
Statistics about protected query execution.
totalDurationInMillis (integer) --
The duration of the protected query, from creation until query completion, in milliseconds.
billedResourceUtilization (dict) --
The billed resource utilization.
units (float) --
The number of Clean Rooms Processing Unit (CRPU) hours that have been billed.
result (dict) --
The result of the protected query.
output (dict) --
The output of the protected query.
s3 (dict) --
If present, the output for a protected query with an S3 output type.
location (string) --
The S3 location of the result.
memberList (list) --
The list of member Amazon Web Services account(s) that received the results of the query.
(dict) --
Details about the member who received the query result.
accountId (string) --
The Amazon Web Services account ID of the member in the collaboration who can receive results for the query.
distribute (dict) --
Contains output information for protected queries that use a distribute output type. This output type lets you send query results to multiple locations - either to S3 or to collaboration members.
s3 (dict) --
Contains output information for protected queries with an S3 output type.
location (string) --
The S3 location of the result.
memberList (list) --
Contains the output results for each member location specified in the distribute output configuration. Each entry provides details about the result distribution to a specific collaboration member.
(dict) --
Details about the member who received the query result.
accountId (string) --
The Amazon Web Services account ID of the member in the collaboration who can receive results for the query.
error (dict) --
An error thrown by the protected query.
message (string) --
A description of why the protected query failed.
code (string) --
A code that identifies the category of the failure. Valid values are:
MALFORMED_QUERY – The query is not valid (syntax, semantics, columns, or an unsupported operation).
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 query 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 query 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.
differentialPrivacy (dict) --
The sensitivity parameters of the differential privacy results of the protected query.
sensitivityParameters (list) --
Provides the sensitivity parameters that you can use to better understand the total amount of noise in query results.
(dict) --
Provides the sensitivity parameters.
aggregationType (string) --
The type of aggregation function that was run.
aggregationExpression (string) --
The aggregation expression that was run.
userContributionLimit (integer) --
The maximum number of rows contributed by a user in a SQL query.
minColumnValue (float) --
The lower bound of the aggregation expression.
maxColumnValue (float) --
The upper bound of the aggregation expression.
computeConfiguration (dict) --
The compute configuration for the protected query.
worker (dict) --
The worker configuration for the compute environment.
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) --
queryComputePayerAccountId (string) --
The account ID of the member that pays for the query compute costs.
{'protectedJob': {'error': {'retry': {'retryable': 'boolean'}}}}
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'
}
}
},
'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.
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.
{'protectedQuery': {'error': {'retry': {'retryable': 'boolean'}}}}
Updates the processing of a currently running query.
See also: AWS API Documentation
Request Syntax
client.update_protected_query(
membershipIdentifier='string',
protectedQueryIdentifier='string',
targetStatus='CANCELLED'
)
string
[REQUIRED]
The identifier for a member of a protected query instance.
string
[REQUIRED]
The identifier for a protected query instance.
string
[REQUIRED]
The target status of a query. Used to update the execution status of a currently running query.
dict
Response Syntax
{
'protectedQuery': {
'id': 'string',
'membershipId': 'string',
'membershipArn': 'string',
'createTime': datetime(2015, 1, 1),
'sqlParameters': {
'queryString': 'string',
'analysisTemplateArn': 'string',
'parameters': {
'string': 'string'
}
},
'status': 'SUBMITTED'|'STARTED'|'CANCELLED'|'CANCELLING'|'FAILED'|'SUCCESS'|'TIMED_OUT',
'resultConfiguration': {
'outputConfiguration': {
's3': {
'resultFormat': 'CSV'|'PARQUET',
'bucket': 'string',
'keyPrefix': 'string',
'singleFileOutput': True|False
},
'member': {
'accountId': 'string'
},
'distribute': {
'locations': [
{
's3': {
'resultFormat': 'CSV'|'PARQUET',
'bucket': 'string',
'keyPrefix': 'string',
'singleFileOutput': True|False
},
'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'
},
],
'distribute': {
's3': {
'location': 'string'
},
'memberList': [
{
'accountId': 'string'
},
]
}
}
},
'error': {
'message': 'string',
'code': 'string',
'retry': {
'retryable': True|False
}
},
'differentialPrivacy': {
'sensitivityParameters': [
{
'aggregationType': 'AVG'|'COUNT'|'COUNT_DISTINCT'|'SUM'|'STDDEV',
'aggregationExpression': 'string',
'userContributionLimit': 123,
'minColumnValue': ...,
'maxColumnValue': ...
},
]
},
'computeConfiguration': {
'worker': {
'type': 'CR.1X'|'CR.4X'|'CR.8X',
'number': 123,
'properties': {
'spark': {
'string': 'string'
}
}
}
},
'queryComputePayerAccountId': 'string'
}
}
Response Structure
(dict) --
protectedQuery (dict) --
The protected query output.
id (string) --
The identifier for a protected query instance.
membershipId (string) --
The identifier for the membership.
membershipArn (string) --
The ARN of the membership.
createTime (datetime) --
The time at which the protected query was created.
sqlParameters (dict) --
The protected query SQL parameters.
queryString (string) --
The query string to be submitted.
analysisTemplateArn (string) --
The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.
parameters (dict) --
The protected query SQL parameters.
(string) --
(string) --
status (string) --
The status of the query.
resultConfiguration (dict) --
Contains any details needed to write the query results.
outputConfiguration (dict) --
Configuration for protected query results.
s3 (dict) --
Required configuration for a protected query with an s3 output type.
resultFormat (string) --
Intended file format of the result.
bucket (string) --
The S3 bucket to unload the protected query results.
keyPrefix (string) --
The S3 prefix to unload the protected query results.
singleFileOutput (boolean) --
Indicates whether files should be output as a single file ( TRUE) or output as multiple files ( FALSE). This parameter is only supported for analyses with the Spark analytics engine.
member (dict) --
Required configuration for a protected query with a member output type.
accountId (string) --
The unique identifier for the account.
distribute (dict) --
Required configuration for a protected query with a distribute output type.
locations (list) --
A list of locations where you want to distribute the protected query results. Each location must specify either an S3 destination or a collaboration member destination.
(dict) --
Specifies where you'll distribute the results of your protected query. You must configure either an S3 destination or a collaboration member destination.
s3 (dict) --
Contains the configuration to write the query results to S3.
resultFormat (string) --
Intended file format of the result.
bucket (string) --
The S3 bucket to unload the protected query results.
keyPrefix (string) --
The S3 prefix to unload the protected query results.
singleFileOutput (boolean) --
Indicates whether files should be output as a single file ( TRUE) or output as multiple files ( FALSE). This parameter is only supported for analyses with the Spark analytics engine.
member (dict) --
Contains configuration details for the protected query member output.
accountId (string) --
The unique identifier for the account.
intermediateTable (dict) --
The intermediate table output configuration, present when the protected query was triggered by a populate 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) --
Statistics about protected query execution.
totalDurationInMillis (integer) --
The duration of the protected query, from creation until query completion, in milliseconds.
billedResourceUtilization (dict) --
The billed resource utilization.
units (float) --
The number of Clean Rooms Processing Unit (CRPU) hours that have been billed.
result (dict) --
The result of the protected query.
output (dict) --
The output of the protected query.
s3 (dict) --
If present, the output for a protected query with an S3 output type.
location (string) --
The S3 location of the result.
memberList (list) --
The list of member Amazon Web Services account(s) that received the results of the query.
(dict) --
Details about the member who received the query result.
accountId (string) --
The Amazon Web Services account ID of the member in the collaboration who can receive results for the query.
distribute (dict) --
Contains output information for protected queries that use a distribute output type. This output type lets you send query results to multiple locations - either to S3 or to collaboration members.
s3 (dict) --
Contains output information for protected queries with an S3 output type.
location (string) --
The S3 location of the result.
memberList (list) --
Contains the output results for each member location specified in the distribute output configuration. Each entry provides details about the result distribution to a specific collaboration member.
(dict) --
Details about the member who received the query result.
accountId (string) --
The Amazon Web Services account ID of the member in the collaboration who can receive results for the query.
error (dict) --
An error thrown by the protected query.
message (string) --
A description of why the protected query failed.
code (string) --
A code that identifies the category of the failure. Valid values are:
MALFORMED_QUERY – The query is not valid (syntax, semantics, columns, or an unsupported operation).
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 query 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 query 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.
differentialPrivacy (dict) --
The sensitivity parameters of the differential privacy results of the protected query.
sensitivityParameters (list) --
Provides the sensitivity parameters that you can use to better understand the total amount of noise in query results.
(dict) --
Provides the sensitivity parameters.
aggregationType (string) --
The type of aggregation function that was run.
aggregationExpression (string) --
The aggregation expression that was run.
userContributionLimit (integer) --
The maximum number of rows contributed by a user in a SQL query.
minColumnValue (float) --
The lower bound of the aggregation expression.
maxColumnValue (float) --
The upper bound of the aggregation expression.
computeConfiguration (dict) --
The compute configuration for the protected query.
worker (dict) --
The worker configuration for the compute environment.
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) --
queryComputePayerAccountId (string) --
The account ID of the member that pays for the query compute costs.