2026/05/21 - AWS Clean Rooms Service - 13 updated api methods
Changes Collaboration creators can update payment configurations without recreating the collaboration. When multiple payer candidates are configured for a cost type, analysis runners can specify the actual payer at submission time, providing granular control over billing.
{'changes': {'specification': {'member': {'mlMemberAbilities': {'customMLMemberAbilities': ['CAN_RECEIVE_MODEL_OUTPUT '
'| '
'CAN_RECEIVE_INFERENCE_OUTPUT']},
'paymentConfiguration': {'jobCompute': {'isResponsible': 'boolean'},
'machineLearning': {'modelInference': {'isResponsible': 'boolean'},
'modelTraining': {'isResponsible': 'boolean'},
'syntheticDataGeneration': {'isResponsible': 'boolean'}},
'queryCompute': {'isResponsible': 'boolean'}}}}}}
Response {'collaborationChangeRequest': {'changes': {'specification': {'member': {'mlMemberAbilities': {'customMLMemberAbilities': ['CAN_RECEIVE_MODEL_OUTPUT '
'| '
'CAN_RECEIVE_INFERENCE_OUTPUT']},
'paymentConfiguration': {'jobCompute': {'isResponsible': 'boolean'},
'machineLearning': {'modelInference': {'isResponsible': 'boolean'},
'modelTraining': {'isResponsible': 'boolean'},
'syntheticDataGeneration': {'isResponsible': 'boolean'}},
'queryCompute': {'isResponsible': 'boolean'}}}},
'types': {'ADD_PAYER_CANDIDATE',
'GRANT_CAN_RECEIVE_INFERENCE_OUTPUT',
'GRANT_CAN_RECEIVE_MODEL_OUTPUT',
'REMOVE_PAYER_CANDIDATE',
'REVOKE_CAN_RECEIVE_INFERENCE_OUTPUT',
'REVOKE_CAN_RECEIVE_MODEL_OUTPUT'}}}}
Creates a new change request to modify an existing collaboration. This enables post-creation modifications to collaborations through a structured API-driven approach.
See also: AWS API Documentation
Request Syntax
client.create_collaboration_change_request(
collaborationIdentifier='string',
changes=[
{
'specificationType': 'MEMBER'|'COLLABORATION',
'specification': {
'member': {
'accountId': 'string',
'memberAbilities': [
'CAN_QUERY'|'CAN_RECEIVE_RESULTS'|'CAN_RUN_JOB',
],
'mlMemberAbilities': {
'customMLMemberAbilities': [
'CAN_RECEIVE_MODEL_OUTPUT'|'CAN_RECEIVE_INFERENCE_OUTPUT',
]
},
'paymentConfiguration': {
'queryCompute': {
'isResponsible': True|False
},
'machineLearning': {
'modelTraining': {
'isResponsible': True|False
},
'modelInference': {
'isResponsible': True|False
},
'syntheticDataGeneration': {
'isResponsible': True|False
}
},
'jobCompute': {
'isResponsible': True|False
}
},
'displayName': 'string'
},
'collaboration': {
'autoApprovedChangeTypes': [
'ADD_MEMBER'|'GRANT_RECEIVE_RESULTS_ABILITY'|'REVOKE_RECEIVE_RESULTS_ABILITY',
]
}
}
},
]
)
string
[REQUIRED]
The identifier of the collaboration that the change request is made against.
list
[REQUIRED]
The list of changes to apply to the collaboration. Each change specifies the type of modification and the details of what should be changed.
(dict) --
Specifies a change to apply to a collaboration.
specificationType (string) -- [REQUIRED]
The type of specification for the change. Currently supports MEMBER for member-related changes.
specification (dict) -- [REQUIRED]
The specification details for the change. The structure depends on the specification type.
member (dict) --
The member change specification when the change type is MEMBER.
accountId (string) -- [REQUIRED]
The Amazon Web Services account ID of the member to add to the collaboration.
memberAbilities (list) -- [REQUIRED]
The abilities granted to the collaboration member. These determine what actions the member can perform within the collaboration.
(string) --
mlMemberAbilities (dict) --
The ML member abilities for a collaboration member.
customMLMemberAbilities (list) -- [REQUIRED]
The custom ML member abilities for a collaboration member.
(string) --
paymentConfiguration (dict) --
An object representing the collaboration member's payment responsibilities set by the collaboration creator.
queryCompute (dict) -- [REQUIRED]
The collaboration member's payment responsibilities set by the collaboration creator for query compute costs.
isResponsible (boolean) -- [REQUIRED]
Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs ( TRUE) or has not configured the collaboration member to pay for query compute costs ( FALSE).
Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
machineLearning (dict) --
An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.
modelTraining (dict) --
The payment responsibilities accepted by the member for model training.
isResponsible (boolean) -- [REQUIRED]
Indicates whether the collaboration creator has configured the collaboration member to pay for model training costs ( TRUE) or has not configured the collaboration member to pay for model training costs ( FALSE).
Exactly one member can be configured to pay for model training costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for model training costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
modelInference (dict) --
The payment responsibilities accepted by the member for model inference.
isResponsible (boolean) -- [REQUIRED]
Indicates whether the collaboration creator has configured the collaboration member to pay for model inference costs ( TRUE) or has not configured the collaboration member to pay for model inference costs ( FALSE).
Exactly one member can be configured to pay for model inference costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for model inference costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
syntheticDataGeneration (dict) --
The payment configuration for machine learning synthetic data generation.
isResponsible (boolean) -- [REQUIRED]
Indicates who is responsible for paying for synthetic data generation.
jobCompute (dict) --
The compute configuration for the job.
isResponsible (boolean) -- [REQUIRED]
Indicates whether the collaboration creator has configured the collaboration member to pay for query and job compute costs ( TRUE) or has not configured the collaboration member to pay for query and job compute costs ( FALSE).
Exactly one member can be configured to pay for query and job compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
An error is returned if the collaboration creator sets a FALSE value for the member who can run queries and jobs.
displayName (string) --
Specifies the display name that will be shown for this member in the collaboration. While this field is required when inviting new members, it becomes optional when modifying abilities of existing collaboration members.
collaboration (dict) --
The collaboration configuration changes being requested. Currently, this only supports modifying which change types are auto-approved for the collaboration.
autoApprovedChangeTypes (list) --
Defines requested updates to properties of the collaboration. Currently, this only supports modifying which change types are auto-approved for the collaboration.
(string) --
dict
Response Syntax
{
'collaborationChangeRequest': {
'id': 'string',
'collaborationId': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'status': 'PENDING'|'APPROVED'|'CANCELLED'|'DENIED'|'COMMITTED',
'isAutoApproved': True|False,
'changes': [
{
'specificationType': 'MEMBER'|'COLLABORATION',
'specification': {
'member': {
'accountId': 'string',
'memberAbilities': [
'CAN_QUERY'|'CAN_RECEIVE_RESULTS'|'CAN_RUN_JOB',
],
'mlMemberAbilities': {
'customMLMemberAbilities': [
'CAN_RECEIVE_MODEL_OUTPUT'|'CAN_RECEIVE_INFERENCE_OUTPUT',
]
},
'paymentConfiguration': {
'queryCompute': {
'isResponsible': True|False
},
'machineLearning': {
'modelTraining': {
'isResponsible': True|False
},
'modelInference': {
'isResponsible': True|False
},
'syntheticDataGeneration': {
'isResponsible': True|False
}
},
'jobCompute': {
'isResponsible': True|False
}
},
'displayName': 'string'
},
'collaboration': {
'autoApprovedChangeTypes': [
'ADD_MEMBER'|'GRANT_RECEIVE_RESULTS_ABILITY'|'REVOKE_RECEIVE_RESULTS_ABILITY',
]
}
},
'types': [
'ADD_MEMBER'|'GRANT_RECEIVE_RESULTS_ABILITY'|'REVOKE_RECEIVE_RESULTS_ABILITY'|'EDIT_AUTO_APPROVED_CHANGE_TYPES'|'ADD_PAYER_CANDIDATE'|'REMOVE_PAYER_CANDIDATE'|'GRANT_CAN_RECEIVE_MODEL_OUTPUT'|'GRANT_CAN_RECEIVE_INFERENCE_OUTPUT'|'REVOKE_CAN_RECEIVE_MODEL_OUTPUT'|'REVOKE_CAN_RECEIVE_INFERENCE_OUTPUT',
]
},
],
'approvals': {
'string': {
'status': 'APPROVED'|'DENIED'|'PENDING'
}
}
}
}
Response Structure
(dict) --
collaborationChangeRequest (dict) --
Represents a request to modify a collaboration. Change requests enable structured modifications to collaborations after they have been created.
id (string) --
The unique identifier for the change request.
collaborationId (string) --
The unique identifier for the collaboration being modified.
createTime (datetime) --
The time when the change request was created.
updateTime (datetime) --
The time when the change request was last updated.
status (string) --
The current status of the change request. Valid values are PENDING, APPROVED, DENIED, COMMITTED, and CANCELLED.
isAutoApproved (boolean) --
Whether the change request was automatically approved based on the collaboration's auto-approval settings.
changes (list) --
The list of changes specified in this change request.
(dict) --
Represents a single change within a collaboration change request, containing the change identifier and specification.
specificationType (string) --
The type of specification for this change.
specification (dict) --
The specification details for this change.
member (dict) --
The member change specification when the change type is MEMBER.
accountId (string) --
The Amazon Web Services account ID of the member to add to the collaboration.
memberAbilities (list) --
The abilities granted to the collaboration member. These determine what actions the member can perform within the collaboration.
(string) --
mlMemberAbilities (dict) --
The ML member abilities for a collaboration member.
customMLMemberAbilities (list) --
The custom ML member abilities for a collaboration member.
(string) --
paymentConfiguration (dict) --
An object representing the collaboration member's payment responsibilities set by the collaboration creator.
queryCompute (dict) --
The collaboration member's payment responsibilities set by the collaboration creator for query compute costs.
isResponsible (boolean) --
Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs ( TRUE) or has not configured the collaboration member to pay for query compute costs ( FALSE).
Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
machineLearning (dict) --
An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.
modelTraining (dict) --
The payment responsibilities accepted by the member for model training.
isResponsible (boolean) --
Indicates whether the collaboration creator has configured the collaboration member to pay for model training costs ( TRUE) or has not configured the collaboration member to pay for model training costs ( FALSE).
Exactly one member can be configured to pay for model training costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for model training costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
modelInference (dict) --
The payment responsibilities accepted by the member for model inference.
isResponsible (boolean) --
Indicates whether the collaboration creator has configured the collaboration member to pay for model inference costs ( TRUE) or has not configured the collaboration member to pay for model inference costs ( FALSE).
Exactly one member can be configured to pay for model inference costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for model inference costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
syntheticDataGeneration (dict) --
The payment configuration for machine learning synthetic data generation.
isResponsible (boolean) --
Indicates who is responsible for paying for synthetic data generation.
jobCompute (dict) --
The compute configuration for the job.
isResponsible (boolean) --
Indicates whether the collaboration creator has configured the collaboration member to pay for query and job compute costs ( TRUE) or has not configured the collaboration member to pay for query and job compute costs ( FALSE).
Exactly one member can be configured to pay for query and job compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
An error is returned if the collaboration creator sets a FALSE value for the member who can run queries and jobs.
displayName (string) --
Specifies the display name that will be shown for this member in the collaboration. While this field is required when inviting new members, it becomes optional when modifying abilities of existing collaboration members.
collaboration (dict) --
The collaboration configuration changes being requested. Currently, this only supports modifying which change types are auto-approved for the collaboration.
autoApprovedChangeTypes (list) --
Defines requested updates to properties of the collaboration. Currently, this only supports modifying which change types are auto-approved for the collaboration.
(string) --
types (list) --
The list of change types that were applied.
(string) --
approvals (dict) --
A list of approval details from collaboration members, including approval status and multi-party approval workflow information.
(string) --
(dict) --
Contains detailed information about the approval state of a given member in the collaboration for a given collaboration change request.
status (string) --
The approval status of a member's vote on the change request. Valid values are PENDING (if they haven't voted), APPROVED, or DENIED.
{'collaborationChangeRequest': {'changes': {'specification': {'member': {'mlMemberAbilities': {'customMLMemberAbilities': ['CAN_RECEIVE_MODEL_OUTPUT '
'| '
'CAN_RECEIVE_INFERENCE_OUTPUT']},
'paymentConfiguration': {'jobCompute': {'isResponsible': 'boolean'},
'machineLearning': {'modelInference': {'isResponsible': 'boolean'},
'modelTraining': {'isResponsible': 'boolean'},
'syntheticDataGeneration': {'isResponsible': 'boolean'}},
'queryCompute': {'isResponsible': 'boolean'}}}},
'types': {'ADD_PAYER_CANDIDATE',
'GRANT_CAN_RECEIVE_INFERENCE_OUTPUT',
'GRANT_CAN_RECEIVE_MODEL_OUTPUT',
'REMOVE_PAYER_CANDIDATE',
'REVOKE_CAN_RECEIVE_INFERENCE_OUTPUT',
'REVOKE_CAN_RECEIVE_MODEL_OUTPUT'}}}}
Retrieves detailed information about a specific collaboration change request.
See also: AWS API Documentation
Request Syntax
client.get_collaboration_change_request(
collaborationIdentifier='string',
changeRequestIdentifier='string'
)
string
[REQUIRED]
The identifier of the collaboration that the change request is made against.
string
[REQUIRED]
A unique identifier for the change request to retrieve.
dict
Response Syntax
{
'collaborationChangeRequest': {
'id': 'string',
'collaborationId': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'status': 'PENDING'|'APPROVED'|'CANCELLED'|'DENIED'|'COMMITTED',
'isAutoApproved': True|False,
'changes': [
{
'specificationType': 'MEMBER'|'COLLABORATION',
'specification': {
'member': {
'accountId': 'string',
'memberAbilities': [
'CAN_QUERY'|'CAN_RECEIVE_RESULTS'|'CAN_RUN_JOB',
],
'mlMemberAbilities': {
'customMLMemberAbilities': [
'CAN_RECEIVE_MODEL_OUTPUT'|'CAN_RECEIVE_INFERENCE_OUTPUT',
]
},
'paymentConfiguration': {
'queryCompute': {
'isResponsible': True|False
},
'machineLearning': {
'modelTraining': {
'isResponsible': True|False
},
'modelInference': {
'isResponsible': True|False
},
'syntheticDataGeneration': {
'isResponsible': True|False
}
},
'jobCompute': {
'isResponsible': True|False
}
},
'displayName': 'string'
},
'collaboration': {
'autoApprovedChangeTypes': [
'ADD_MEMBER'|'GRANT_RECEIVE_RESULTS_ABILITY'|'REVOKE_RECEIVE_RESULTS_ABILITY',
]
}
},
'types': [
'ADD_MEMBER'|'GRANT_RECEIVE_RESULTS_ABILITY'|'REVOKE_RECEIVE_RESULTS_ABILITY'|'EDIT_AUTO_APPROVED_CHANGE_TYPES'|'ADD_PAYER_CANDIDATE'|'REMOVE_PAYER_CANDIDATE'|'GRANT_CAN_RECEIVE_MODEL_OUTPUT'|'GRANT_CAN_RECEIVE_INFERENCE_OUTPUT'|'REVOKE_CAN_RECEIVE_MODEL_OUTPUT'|'REVOKE_CAN_RECEIVE_INFERENCE_OUTPUT',
]
},
],
'approvals': {
'string': {
'status': 'APPROVED'|'DENIED'|'PENDING'
}
}
}
}
Response Structure
(dict) --
collaborationChangeRequest (dict) --
The collaboration change request that was requested.
id (string) --
The unique identifier for the change request.
collaborationId (string) --
The unique identifier for the collaboration being modified.
createTime (datetime) --
The time when the change request was created.
updateTime (datetime) --
The time when the change request was last updated.
status (string) --
The current status of the change request. Valid values are PENDING, APPROVED, DENIED, COMMITTED, and CANCELLED.
isAutoApproved (boolean) --
Whether the change request was automatically approved based on the collaboration's auto-approval settings.
changes (list) --
The list of changes specified in this change request.
(dict) --
Represents a single change within a collaboration change request, containing the change identifier and specification.
specificationType (string) --
The type of specification for this change.
specification (dict) --
The specification details for this change.
member (dict) --
The member change specification when the change type is MEMBER.
accountId (string) --
The Amazon Web Services account ID of the member to add to the collaboration.
memberAbilities (list) --
The abilities granted to the collaboration member. These determine what actions the member can perform within the collaboration.
(string) --
mlMemberAbilities (dict) --
The ML member abilities for a collaboration member.
customMLMemberAbilities (list) --
The custom ML member abilities for a collaboration member.
(string) --
paymentConfiguration (dict) --
An object representing the collaboration member's payment responsibilities set by the collaboration creator.
queryCompute (dict) --
The collaboration member's payment responsibilities set by the collaboration creator for query compute costs.
isResponsible (boolean) --
Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs ( TRUE) or has not configured the collaboration member to pay for query compute costs ( FALSE).
Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
machineLearning (dict) --
An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.
modelTraining (dict) --
The payment responsibilities accepted by the member for model training.
isResponsible (boolean) --
Indicates whether the collaboration creator has configured the collaboration member to pay for model training costs ( TRUE) or has not configured the collaboration member to pay for model training costs ( FALSE).
Exactly one member can be configured to pay for model training costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for model training costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
modelInference (dict) --
The payment responsibilities accepted by the member for model inference.
isResponsible (boolean) --
Indicates whether the collaboration creator has configured the collaboration member to pay for model inference costs ( TRUE) or has not configured the collaboration member to pay for model inference costs ( FALSE).
Exactly one member can be configured to pay for model inference costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for model inference costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
syntheticDataGeneration (dict) --
The payment configuration for machine learning synthetic data generation.
isResponsible (boolean) --
Indicates who is responsible for paying for synthetic data generation.
jobCompute (dict) --
The compute configuration for the job.
isResponsible (boolean) --
Indicates whether the collaboration creator has configured the collaboration member to pay for query and job compute costs ( TRUE) or has not configured the collaboration member to pay for query and job compute costs ( FALSE).
Exactly one member can be configured to pay for query and job compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
An error is returned if the collaboration creator sets a FALSE value for the member who can run queries and jobs.
displayName (string) --
Specifies the display name that will be shown for this member in the collaboration. While this field is required when inviting new members, it becomes optional when modifying abilities of existing collaboration members.
collaboration (dict) --
The collaboration configuration changes being requested. Currently, this only supports modifying which change types are auto-approved for the collaboration.
autoApprovedChangeTypes (list) --
Defines requested updates to properties of the collaboration. Currently, this only supports modifying which change types are auto-approved for the collaboration.
(string) --
types (list) --
The list of change types that were applied.
(string) --
approvals (dict) --
A list of approval details from collaboration members, including approval status and multi-party approval workflow information.
(string) --
(dict) --
Contains detailed information about the approval state of a given member in the collaboration for a given collaboration change request.
status (string) --
The approval status of a member's vote on the change request. Valid values are PENDING (if they haven't voted), APPROVED, or DENIED.
{'protectedJob': {'jobComputePayerAccountId': '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'
}
}
},
'statistics': {
'totalDurationInMillis': 123,
'billedResourceUtilization': {
'units': 123.0
}
},
'result': {
'output': {
's3': {
'location': 'string'
},
'memberList': [
{
'accountId': 'string'
},
]
}
},
'error': {
'message': 'string',
'code': 'string'
},
'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) --
The message for the protected job error.
code (string) --
The error code for the protected job.
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': {'queryComputePayerAccountId': 'string'}}
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'
}
},
]
}
}
},
'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'
},
'differentialPrivacy': {
'sensitivityParameters': [
{
'aggregationType': 'AVG'|'COUNT'|'COUNT_DISTINCT'|'SUM'|'STDDEV',
'aggregationExpression': 'string',
'userContributionLimit': 123,
'minColumnValue': ...,
'maxColumnValue': ...
},
]
},
'computeConfiguration': {
'worker': {
'type': 'CR.1X'|'CR.4X',
'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.
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 query failed.
code (string) --
An error code for the error.
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.
{'collaborationChangeRequestSummaries': {'changes': {'specification': {'member': {'mlMemberAbilities': {'customMLMemberAbilities': ['CAN_RECEIVE_MODEL_OUTPUT '
'| '
'CAN_RECEIVE_INFERENCE_OUTPUT']},
'paymentConfiguration': {'jobCompute': {'isResponsible': 'boolean'},
'machineLearning': {'modelInference': {'isResponsible': 'boolean'},
'modelTraining': {'isResponsible': 'boolean'},
'syntheticDataGeneration': {'isResponsible': 'boolean'}},
'queryCompute': {'isResponsible': 'boolean'}}}},
'types': {'ADD_PAYER_CANDIDATE',
'GRANT_CAN_RECEIVE_INFERENCE_OUTPUT',
'GRANT_CAN_RECEIVE_MODEL_OUTPUT',
'REMOVE_PAYER_CANDIDATE',
'REVOKE_CAN_RECEIVE_INFERENCE_OUTPUT',
'REVOKE_CAN_RECEIVE_MODEL_OUTPUT'}}}}
Lists all change requests for a collaboration with pagination support. Returns change requests sorted by creation time.
See also: AWS API Documentation
Request Syntax
client.list_collaboration_change_requests(
collaborationIdentifier='string',
status='PENDING'|'APPROVED'|'CANCELLED'|'DENIED'|'COMMITTED',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The identifier of the collaboration that the change request is made against.
string
A filter to only return change requests with the specified status.
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.
dict
Response Syntax
{
'collaborationChangeRequestSummaries': [
{
'id': 'string',
'collaborationId': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'status': 'PENDING'|'APPROVED'|'CANCELLED'|'DENIED'|'COMMITTED',
'isAutoApproved': True|False,
'changes': [
{
'specificationType': 'MEMBER'|'COLLABORATION',
'specification': {
'member': {
'accountId': 'string',
'memberAbilities': [
'CAN_QUERY'|'CAN_RECEIVE_RESULTS'|'CAN_RUN_JOB',
],
'mlMemberAbilities': {
'customMLMemberAbilities': [
'CAN_RECEIVE_MODEL_OUTPUT'|'CAN_RECEIVE_INFERENCE_OUTPUT',
]
},
'paymentConfiguration': {
'queryCompute': {
'isResponsible': True|False
},
'machineLearning': {
'modelTraining': {
'isResponsible': True|False
},
'modelInference': {
'isResponsible': True|False
},
'syntheticDataGeneration': {
'isResponsible': True|False
}
},
'jobCompute': {
'isResponsible': True|False
}
},
'displayName': 'string'
},
'collaboration': {
'autoApprovedChangeTypes': [
'ADD_MEMBER'|'GRANT_RECEIVE_RESULTS_ABILITY'|'REVOKE_RECEIVE_RESULTS_ABILITY',
]
}
},
'types': [
'ADD_MEMBER'|'GRANT_RECEIVE_RESULTS_ABILITY'|'REVOKE_RECEIVE_RESULTS_ABILITY'|'EDIT_AUTO_APPROVED_CHANGE_TYPES'|'ADD_PAYER_CANDIDATE'|'REMOVE_PAYER_CANDIDATE'|'GRANT_CAN_RECEIVE_MODEL_OUTPUT'|'GRANT_CAN_RECEIVE_INFERENCE_OUTPUT'|'REVOKE_CAN_RECEIVE_MODEL_OUTPUT'|'REVOKE_CAN_RECEIVE_INFERENCE_OUTPUT',
]
},
],
'approvals': {
'string': {
'status': 'APPROVED'|'DENIED'|'PENDING'
}
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
collaborationChangeRequestSummaries (list) --
The list of collaboration change request summaries.
(dict) --
Summary information about a collaboration change request.
id (string) --
The unique identifier for the change request.
collaborationId (string) --
The unique identifier for the collaboration.
createTime (datetime) --
The time when the change request was created.
updateTime (datetime) --
The time when the change request was last updated.
status (string) --
The current status of the change request.
isAutoApproved (boolean) --
Whether the change request was automatically approved.
changes (list) --
Summary of the changes in this change request.
(dict) --
Represents a single change within a collaboration change request, containing the change identifier and specification.
specificationType (string) --
The type of specification for this change.
specification (dict) --
The specification details for this change.
member (dict) --
The member change specification when the change type is MEMBER.
accountId (string) --
The Amazon Web Services account ID of the member to add to the collaboration.
memberAbilities (list) --
The abilities granted to the collaboration member. These determine what actions the member can perform within the collaboration.
(string) --
mlMemberAbilities (dict) --
The ML member abilities for a collaboration member.
customMLMemberAbilities (list) --
The custom ML member abilities for a collaboration member.
(string) --
paymentConfiguration (dict) --
An object representing the collaboration member's payment responsibilities set by the collaboration creator.
queryCompute (dict) --
The collaboration member's payment responsibilities set by the collaboration creator for query compute costs.
isResponsible (boolean) --
Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs ( TRUE) or has not configured the collaboration member to pay for query compute costs ( FALSE).
Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
machineLearning (dict) --
An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.
modelTraining (dict) --
The payment responsibilities accepted by the member for model training.
isResponsible (boolean) --
Indicates whether the collaboration creator has configured the collaboration member to pay for model training costs ( TRUE) or has not configured the collaboration member to pay for model training costs ( FALSE).
Exactly one member can be configured to pay for model training costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for model training costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
modelInference (dict) --
The payment responsibilities accepted by the member for model inference.
isResponsible (boolean) --
Indicates whether the collaboration creator has configured the collaboration member to pay for model inference costs ( TRUE) or has not configured the collaboration member to pay for model inference costs ( FALSE).
Exactly one member can be configured to pay for model inference costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for model inference costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
syntheticDataGeneration (dict) --
The payment configuration for machine learning synthetic data generation.
isResponsible (boolean) --
Indicates who is responsible for paying for synthetic data generation.
jobCompute (dict) --
The compute configuration for the job.
isResponsible (boolean) --
Indicates whether the collaboration creator has configured the collaboration member to pay for query and job compute costs ( TRUE) or has not configured the collaboration member to pay for query and job compute costs ( FALSE).
Exactly one member can be configured to pay for query and job compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
An error is returned if the collaboration creator sets a FALSE value for the member who can run queries and jobs.
displayName (string) --
Specifies the display name that will be shown for this member in the collaboration. While this field is required when inviting new members, it becomes optional when modifying abilities of existing collaboration members.
collaboration (dict) --
The collaboration configuration changes being requested. Currently, this only supports modifying which change types are auto-approved for the collaboration.
autoApprovedChangeTypes (list) --
Defines requested updates to properties of the collaboration. Currently, this only supports modifying which change types are auto-approved for the collaboration.
(string) --
types (list) --
The list of change types that were applied.
(string) --
approvals (dict) --
Summary of approval statuses from all collaboration members for this change request.
(string) --
(dict) --
Contains detailed information about the approval state of a given member in the collaboration for a given collaboration change request.
status (string) --
The approval status of a member's vote on the change request. Valid values are PENDING (if they haven't voted), APPROVED, or DENIED.
nextToken (string) --
The pagination token that's used to fetch the next set of results.
{'protectedJobs': {'jobComputePayerAccountId': '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'
},
]
}
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.
{'protectedQueries': {'queryComputePayerAccountId': 'string'}}
Lists protected queries, sorted by the most recent query.
See also: AWS API Documentation
Request Syntax
client.list_protected_queries(
membershipIdentifier='string',
status='SUBMITTED'|'STARTED'|'CANCELLED'|'CANCELLING'|'FAILED'|'SUCCESS'|'TIMED_OUT',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The identifier for the membership in the collaboration.
string
A filter on the status of the protected query.
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',
'protectedQueries': [
{
'id': 'string',
'membershipId': 'string',
'membershipArn': 'string',
'createTime': datetime(2015, 1, 1),
'status': 'SUBMITTED'|'STARTED'|'CANCELLED'|'CANCELLING'|'FAILED'|'SUCCESS'|'TIMED_OUT',
'receiverConfigurations': [
{
'analysisType': 'DIRECT_ANALYSIS'|'ADDITIONAL_ANALYSIS',
'configurationDetails': {
'directAnalysisConfigurationDetails': {
'receiverAccountIds': [
'string',
]
}
}
},
],
'queryComputePayerAccountId': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The pagination token that's used to fetch the next set of results.
protectedQueries (list) --
A list of protected queries.
(dict) --
The protected query summary for the objects listed by the request.
id (string) --
The unique ID of the protected query.
membershipId (string) --
The unique ID for the membership that initiated the protected query.
membershipArn (string) --
The unique ARN for the membership that initiated the protected query.
createTime (datetime) --
The time the protected query was created.
status (string) --
The status of the protected query.
receiverConfigurations (list) --
The receiver configuration.
(dict) --
The receiver configuration for a protected query.
analysisType (string) --
The type of analysis for the protected query. The results of the query can be analyzed directly ( DIRECT_ANALYSIS) or used as input into additional analyses ( ADDITIONAL_ANALYSIS), such as a query that is a seed for a lookalike ML model.
configurationDetails (dict) --
The configuration details of the receiver configuration.
directAnalysisConfigurationDetails (dict) --
The direct analysis configuration details.
receiverAccountIds (list) --
The account IDs for the member who received the results of a protected query.
(string) --
queryComputePayerAccountId (string) --
The account ID of the member that pays for the query compute costs.
{'jobComputePayerAccountId': 'string'}
Response {'protectedJob': {'jobComputePayerAccountId': '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'
}
}
},
'statistics': {
'totalDurationInMillis': 123,
'billedResourceUtilization': {
'units': 123.0
}
},
'result': {
'output': {
's3': {
'location': 'string'
},
'memberList': [
{
'accountId': 'string'
},
]
}
},
'error': {
'message': 'string',
'code': 'string'
},
'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) --
The message for the protected job error.
code (string) --
The error code for the protected job.
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.
{'queryComputePayerAccountId': 'string'}
Response {'protectedQuery': {'queryComputePayerAccountId': 'string'}}
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'
}
},
]
}
}
},
computeConfiguration={
'worker': {
'type': 'CR.1X'|'CR.4X',
'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.
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'
}
},
]
}
}
},
'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'
},
'differentialPrivacy': {
'sensitivityParameters': [
{
'aggregationType': 'AVG'|'COUNT'|'COUNT_DISTINCT'|'SUM'|'STDDEV',
'aggregationExpression': 'string',
'userContributionLimit': 123,
'minColumnValue': ...,
'maxColumnValue': ...
},
]
},
'computeConfiguration': {
'worker': {
'type': 'CR.1X'|'CR.4X',
'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.
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 query failed.
code (string) --
An error code for the error.
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.
{'collaborationChangeRequest': {'changes': {'specification': {'member': {'mlMemberAbilities': {'customMLMemberAbilities': ['CAN_RECEIVE_MODEL_OUTPUT '
'| '
'CAN_RECEIVE_INFERENCE_OUTPUT']},
'paymentConfiguration': {'jobCompute': {'isResponsible': 'boolean'},
'machineLearning': {'modelInference': {'isResponsible': 'boolean'},
'modelTraining': {'isResponsible': 'boolean'},
'syntheticDataGeneration': {'isResponsible': 'boolean'}},
'queryCompute': {'isResponsible': 'boolean'}}}},
'types': {'ADD_PAYER_CANDIDATE',
'GRANT_CAN_RECEIVE_INFERENCE_OUTPUT',
'GRANT_CAN_RECEIVE_MODEL_OUTPUT',
'REMOVE_PAYER_CANDIDATE',
'REVOKE_CAN_RECEIVE_INFERENCE_OUTPUT',
'REVOKE_CAN_RECEIVE_MODEL_OUTPUT'}}}}
Updates an existing collaboration change request. This operation allows approval actions for pending change requests in collaborations (APPROVE, DENY, CANCEL, COMMIT).
For change requests without automatic approval, a member in the collaboration can manually APPROVE or DENY a change request. The collaboration owner can manually CANCEL or COMMIT a change request.
See also: AWS API Documentation
Request Syntax
client.update_collaboration_change_request(
collaborationIdentifier='string',
changeRequestIdentifier='string',
action='APPROVE'|'DENY'|'CANCEL'|'COMMIT'
)
string
[REQUIRED]
The unique identifier of the collaboration that contains the change request to be updated.
string
[REQUIRED]
The unique identifier of the specific change request to be updated within the collaboration.
string
[REQUIRED]
The action to perform on the change request. Valid values include APPROVE (approve the change), DENY (reject the change), CANCEL (cancel the request), and COMMIT (commit after the request is approved).
For change requests without automatic approval, a member in the collaboration can manually APPROVE or DENY a change request. The collaboration owner can manually CANCEL or COMMIT a change request.
dict
Response Syntax
{
'collaborationChangeRequest': {
'id': 'string',
'collaborationId': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'status': 'PENDING'|'APPROVED'|'CANCELLED'|'DENIED'|'COMMITTED',
'isAutoApproved': True|False,
'changes': [
{
'specificationType': 'MEMBER'|'COLLABORATION',
'specification': {
'member': {
'accountId': 'string',
'memberAbilities': [
'CAN_QUERY'|'CAN_RECEIVE_RESULTS'|'CAN_RUN_JOB',
],
'mlMemberAbilities': {
'customMLMemberAbilities': [
'CAN_RECEIVE_MODEL_OUTPUT'|'CAN_RECEIVE_INFERENCE_OUTPUT',
]
},
'paymentConfiguration': {
'queryCompute': {
'isResponsible': True|False
},
'machineLearning': {
'modelTraining': {
'isResponsible': True|False
},
'modelInference': {
'isResponsible': True|False
},
'syntheticDataGeneration': {
'isResponsible': True|False
}
},
'jobCompute': {
'isResponsible': True|False
}
},
'displayName': 'string'
},
'collaboration': {
'autoApprovedChangeTypes': [
'ADD_MEMBER'|'GRANT_RECEIVE_RESULTS_ABILITY'|'REVOKE_RECEIVE_RESULTS_ABILITY',
]
}
},
'types': [
'ADD_MEMBER'|'GRANT_RECEIVE_RESULTS_ABILITY'|'REVOKE_RECEIVE_RESULTS_ABILITY'|'EDIT_AUTO_APPROVED_CHANGE_TYPES'|'ADD_PAYER_CANDIDATE'|'REMOVE_PAYER_CANDIDATE'|'GRANT_CAN_RECEIVE_MODEL_OUTPUT'|'GRANT_CAN_RECEIVE_INFERENCE_OUTPUT'|'REVOKE_CAN_RECEIVE_MODEL_OUTPUT'|'REVOKE_CAN_RECEIVE_INFERENCE_OUTPUT',
]
},
],
'approvals': {
'string': {
'status': 'APPROVED'|'DENIED'|'PENDING'
}
}
}
}
Response Structure
(dict) --
collaborationChangeRequest (dict) --
Represents a request to modify a collaboration. Change requests enable structured modifications to collaborations after they have been created.
id (string) --
The unique identifier for the change request.
collaborationId (string) --
The unique identifier for the collaboration being modified.
createTime (datetime) --
The time when the change request was created.
updateTime (datetime) --
The time when the change request was last updated.
status (string) --
The current status of the change request. Valid values are PENDING, APPROVED, DENIED, COMMITTED, and CANCELLED.
isAutoApproved (boolean) --
Whether the change request was automatically approved based on the collaboration's auto-approval settings.
changes (list) --
The list of changes specified in this change request.
(dict) --
Represents a single change within a collaboration change request, containing the change identifier and specification.
specificationType (string) --
The type of specification for this change.
specification (dict) --
The specification details for this change.
member (dict) --
The member change specification when the change type is MEMBER.
accountId (string) --
The Amazon Web Services account ID of the member to add to the collaboration.
memberAbilities (list) --
The abilities granted to the collaboration member. These determine what actions the member can perform within the collaboration.
(string) --
mlMemberAbilities (dict) --
The ML member abilities for a collaboration member.
customMLMemberAbilities (list) --
The custom ML member abilities for a collaboration member.
(string) --
paymentConfiguration (dict) --
An object representing the collaboration member's payment responsibilities set by the collaboration creator.
queryCompute (dict) --
The collaboration member's payment responsibilities set by the collaboration creator for query compute costs.
isResponsible (boolean) --
Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs ( TRUE) or has not configured the collaboration member to pay for query compute costs ( FALSE).
Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
machineLearning (dict) --
An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.
modelTraining (dict) --
The payment responsibilities accepted by the member for model training.
isResponsible (boolean) --
Indicates whether the collaboration creator has configured the collaboration member to pay for model training costs ( TRUE) or has not configured the collaboration member to pay for model training costs ( FALSE).
Exactly one member can be configured to pay for model training costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for model training costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
modelInference (dict) --
The payment responsibilities accepted by the member for model inference.
isResponsible (boolean) --
Indicates whether the collaboration creator has configured the collaboration member to pay for model inference costs ( TRUE) or has not configured the collaboration member to pay for model inference costs ( FALSE).
Exactly one member can be configured to pay for model inference costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for model inference costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
syntheticDataGeneration (dict) --
The payment configuration for machine learning synthetic data generation.
isResponsible (boolean) --
Indicates who is responsible for paying for synthetic data generation.
jobCompute (dict) --
The compute configuration for the job.
isResponsible (boolean) --
Indicates whether the collaboration creator has configured the collaboration member to pay for query and job compute costs ( TRUE) or has not configured the collaboration member to pay for query and job compute costs ( FALSE).
Exactly one member can be configured to pay for query and job compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
An error is returned if the collaboration creator sets a FALSE value for the member who can run queries and jobs.
displayName (string) --
Specifies the display name that will be shown for this member in the collaboration. While this field is required when inviting new members, it becomes optional when modifying abilities of existing collaboration members.
collaboration (dict) --
The collaboration configuration changes being requested. Currently, this only supports modifying which change types are auto-approved for the collaboration.
autoApprovedChangeTypes (list) --
Defines requested updates to properties of the collaboration. Currently, this only supports modifying which change types are auto-approved for the collaboration.
(string) --
types (list) --
The list of change types that were applied.
(string) --
approvals (dict) --
A list of approval details from collaboration members, including approval status and multi-party approval workflow information.
(string) --
(dict) --
Contains detailed information about the approval state of a given member in the collaboration for a given collaboration change request.
status (string) --
The approval status of a member's vote on the change request. Valid values are PENDING (if they haven't voted), APPROVED, or DENIED.
{'membershipPaymentConfiguration': {'jobCompute': {'isResponsible': 'boolean'},
'machineLearning': {'modelInference': {'isResponsible': 'boolean'},
'modelTraining': {'isResponsible': 'boolean'},
'syntheticDataGeneration': {'isResponsible': 'boolean'}},
'queryCompute': {'isResponsible': 'boolean'}}}
Updates a membership.
See also: AWS API Documentation
Request Syntax
client.update_membership(
membershipIdentifier='string',
queryLogStatus='ENABLED'|'DISABLED',
jobLogStatus='ENABLED'|'DISABLED',
defaultResultConfiguration={
'outputConfiguration': {
's3': {
'resultFormat': 'CSV'|'PARQUET',
'bucket': 'string',
'keyPrefix': 'string',
'singleFileOutput': True|False
}
},
'roleArn': 'string'
},
defaultJobResultConfiguration={
'outputConfiguration': {
's3': {
'bucket': 'string',
'keyPrefix': 'string'
}
},
'roleArn': 'string'
},
membershipPaymentConfiguration={
'queryCompute': {
'isResponsible': True|False
},
'machineLearning': {
'modelTraining': {
'isResponsible': True|False
},
'modelInference': {
'isResponsible': True|False
},
'syntheticDataGeneration': {
'isResponsible': True|False
}
},
'jobCompute': {
'isResponsible': True|False
}
}
)
string
[REQUIRED]
The unique identifier of the membership.
string
An indicator as to whether query logging has been enabled or disabled for the membership.
When ENABLED, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.
string
An indicator as to whether job logging has been enabled or disabled for the collaboration.
When ENABLED, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.
dict
The default protected query result configuration as specified by the member who can receive results.
outputConfiguration (dict) -- [REQUIRED]
Configuration for protected query results.
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.
roleArn (string) --
The unique ARN for an IAM role that is used by Clean Rooms to write protected query results to the result location, given by the member who can receive results.
dict
The default job result configuration.
outputConfiguration (dict) -- [REQUIRED]
The output configuration for a protected job result.
s3 (dict) --
Contains the configuration to write the job results to S3.
bucket (string) -- [REQUIRED]
The S3 bucket for job output.
keyPrefix (string) --
The S3 prefix to unload the protected job results.
roleArn (string) -- [REQUIRED]
The unique ARN for an IAM role that is used by Clean Rooms to write protected job results to the result location, given by the member who can receive results.
dict
The payment configuration to update for the membership.
queryCompute (dict) --
An object representing the payment responsibilities accepted by the collaboration member for query compute costs.
isResponsible (boolean) -- [REQUIRED]
Indicates whether the collaboration member has accepted to pay for query compute costs ( TRUE) or has not accepted to pay for query compute costs ( FALSE).
If the collaboration creator has not specified anyone to pay for query compute costs, then the member who can query is the default payer.
An error message is returned for the following reasons:
If you set the value to FALSE but you are responsible to pay for query compute costs.
If you set the value to TRUE but you are not responsible to pay for query compute costs.
machineLearning (dict) --
An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.
modelTraining (dict) --
The payment responsibilities accepted by the member for model training.
isResponsible (boolean) -- [REQUIRED]
Indicates whether the collaboration member has accepted to pay for model training costs ( TRUE) or has not accepted to pay for model training costs ( FALSE).
If the collaboration creator has not specified anyone to pay for model training costs, then the member who can query is the default payer.
An error message is returned for the following reasons:
If you set the value to FALSE but you are responsible to pay for model training costs.
If you set the value to TRUE but you are not responsible to pay for model training costs.
modelInference (dict) --
The payment responsibilities accepted by the member for model inference.
isResponsible (boolean) -- [REQUIRED]
Indicates whether the collaboration member has accepted to pay for model inference costs ( TRUE) or has not accepted to pay for model inference costs ( FALSE).
If the collaboration creator has not specified anyone to pay for model inference costs, then the member who can query is the default payer.
An error message is returned for the following reasons:
If you set the value to FALSE but you are responsible to pay for model inference costs.
If you set the value to TRUE but you are not responsible to pay for model inference costs.
syntheticDataGeneration (dict) --
The payment configuration for synthetic data generation for this machine learning membership.
isResponsible (boolean) -- [REQUIRED]
Indicates if this membership is responsible for paying for synthetic data generation.
jobCompute (dict) --
An object representing the payment responsibilities accepted by the collaboration member for query and job compute costs.
isResponsible (boolean) -- [REQUIRED]
Indicates whether the collaboration member has accepted to pay for job compute costs ( TRUE) or has not accepted to pay for query and job compute costs ( FALSE).
There is only one member who pays for queries and jobs.
An error message is returned for the following reasons:
If you set the value to FALSE but you are responsible to pay for query and job compute costs.
If you set the value to TRUE but you are not responsible to pay for query and job compute costs.
dict
Response Syntax
{
'membership': {
'id': 'string',
'arn': 'string',
'collaborationArn': 'string',
'collaborationId': 'string',
'collaborationCreatorAccountId': 'string',
'collaborationCreatorDisplayName': 'string',
'collaborationName': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'status': 'ACTIVE'|'REMOVED'|'COLLABORATION_DELETED',
'memberAbilities': [
'CAN_QUERY'|'CAN_RECEIVE_RESULTS'|'CAN_RUN_JOB',
],
'mlMemberAbilities': {
'customMLMemberAbilities': [
'CAN_RECEIVE_MODEL_OUTPUT'|'CAN_RECEIVE_INFERENCE_OUTPUT',
]
},
'queryLogStatus': 'ENABLED'|'DISABLED',
'jobLogStatus': 'ENABLED'|'DISABLED',
'defaultResultConfiguration': {
'outputConfiguration': {
's3': {
'resultFormat': 'CSV'|'PARQUET',
'bucket': 'string',
'keyPrefix': 'string',
'singleFileOutput': True|False
}
},
'roleArn': 'string'
},
'defaultJobResultConfiguration': {
'outputConfiguration': {
's3': {
'bucket': 'string',
'keyPrefix': 'string'
}
},
'roleArn': 'string'
},
'paymentConfiguration': {
'queryCompute': {
'isResponsible': True|False
},
'machineLearning': {
'modelTraining': {
'isResponsible': True|False
},
'modelInference': {
'isResponsible': True|False
},
'syntheticDataGeneration': {
'isResponsible': True|False
}
},
'jobCompute': {
'isResponsible': True|False
}
},
'isMetricsEnabled': True|False
}
}
Response Structure
(dict) --
membership (dict) --
The membership object.
id (string) --
The unique ID of the membership.
arn (string) --
The unique ARN for the membership.
collaborationArn (string) --
The unique ARN for the membership's associated collaboration.
collaborationId (string) --
The unique ID for the membership's collaboration.
collaborationCreatorAccountId (string) --
The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
collaborationCreatorDisplayName (string) --
The display name of the collaboration creator.
collaborationName (string) --
The name of the membership's collaboration.
createTime (datetime) --
The time when the membership was created.
updateTime (datetime) --
The time the membership metadata was last updated.
status (string) --
The status of the membership.
memberAbilities (list) --
The abilities granted to the collaboration member.
(string) --
mlMemberAbilities (dict) --
Specifies the ML member abilities that are granted to a collaboration member.
customMLMemberAbilities (list) --
The custom ML member abilities for a collaboration member.
(string) --
queryLogStatus (string) --
An indicator as to whether query logging has been enabled or disabled for the membership.
When ENABLED, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.
jobLogStatus (string) --
An indicator as to whether job logging has been enabled or disabled for the collaboration.
When ENABLED, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.
defaultResultConfiguration (dict) --
The default protected query result configuration as specified by the member who can receive results.
outputConfiguration (dict) --
Configuration for protected query results.
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.
roleArn (string) --
The unique ARN for an IAM role that is used by Clean Rooms to write protected query results to the result location, given by the member who can receive results.
defaultJobResultConfiguration (dict) --
The default job result configuration for the membership.
outputConfiguration (dict) --
The output configuration for a protected job result.
s3 (dict) --
Contains the configuration to write the job results to S3.
bucket (string) --
The S3 bucket for job output.
keyPrefix (string) --
The S3 prefix to unload the protected job results.
roleArn (string) --
The unique ARN for an IAM role that is used by Clean Rooms to write protected job results to the result location, given by the member who can receive results.
paymentConfiguration (dict) --
The payment responsibilities accepted by the collaboration member.
queryCompute (dict) --
The payment responsibilities accepted by the collaboration member for query compute costs.
isResponsible (boolean) --
Indicates whether the collaboration member has accepted to pay for query compute costs ( TRUE) or has not accepted to pay for query compute costs ( FALSE).
If the collaboration creator has not specified anyone to pay for query compute costs, then the member who can query is the default payer.
An error message is returned for the following reasons:
If you set the value to FALSE but you are responsible to pay for query compute costs.
If you set the value to TRUE but you are not responsible to pay for query compute costs.
machineLearning (dict) --
The payment responsibilities accepted by the collaboration member for machine learning costs.
modelTraining (dict) --
The payment responsibilities accepted by the member for model training.
isResponsible (boolean) --
Indicates whether the collaboration member has accepted to pay for model training costs ( TRUE) or has not accepted to pay for model training costs ( FALSE).
If the collaboration creator has not specified anyone to pay for model training costs, then the member who can query is the default payer.
An error message is returned for the following reasons:
If you set the value to FALSE but you are responsible to pay for model training costs.
If you set the value to TRUE but you are not responsible to pay for model training costs.
modelInference (dict) --
The payment responsibilities accepted by the member for model inference.
isResponsible (boolean) --
Indicates whether the collaboration member has accepted to pay for model inference costs ( TRUE) or has not accepted to pay for model inference costs ( FALSE).
If the collaboration creator has not specified anyone to pay for model inference costs, then the member who can query is the default payer.
An error message is returned for the following reasons:
If you set the value to FALSE but you are responsible to pay for model inference costs.
If you set the value to TRUE but you are not responsible to pay for model inference costs.
syntheticDataGeneration (dict) --
The payment configuration for synthetic data generation for this machine learning membership.
isResponsible (boolean) --
Indicates if this membership is responsible for paying for synthetic data generation.
jobCompute (dict) --
The payment responsibilities accepted by the collaboration member for job compute costs.
isResponsible (boolean) --
Indicates whether the collaboration member has accepted to pay for job compute costs ( TRUE) or has not accepted to pay for query and job compute costs ( FALSE).
There is only one member who pays for queries and jobs.
An error message is returned for the following reasons:
If you set the value to FALSE but you are responsible to pay for query and job compute costs.
If you set the value to TRUE but you are not responsible to pay for query and job compute costs.
isMetricsEnabled (boolean) --
An indicator as to whether Amazon CloudWatch metrics are enabled for the membership.
When true, metrics about query execution are collected in Amazon CloudWatch.
{'protectedJob': {'jobComputePayerAccountId': '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'
}
}
},
'statistics': {
'totalDurationInMillis': 123,
'billedResourceUtilization': {
'units': 123.0
}
},
'result': {
'output': {
's3': {
'location': 'string'
},
'memberList': [
{
'accountId': 'string'
},
]
}
},
'error': {
'message': 'string',
'code': 'string'
},
'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) --
The message for the protected job error.
code (string) --
The error code for the protected job.
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': {'queryComputePayerAccountId': 'string'}}
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'
}
},
]
}
}
},
'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'
},
'differentialPrivacy': {
'sensitivityParameters': [
{
'aggregationType': 'AVG'|'COUNT'|'COUNT_DISTINCT'|'SUM'|'STDDEV',
'aggregationExpression': 'string',
'userContributionLimit': 123,
'minColumnValue': ...,
'maxColumnValue': ...
},
]
},
'computeConfiguration': {
'worker': {
'type': 'CR.1X'|'CR.4X',
'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.
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 query failed.
code (string) --
An error code for the error.
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.