AWS API Changes

2026/08/11 - AWS Clean Rooms Service - 3 new 12 updated api methods

Changes Adds support for exporting redacted query execution logs in AWS Clean Rooms

GetAnalysisLogExport (new)

Returns information about an analysis log export, including its current status and, if the export failed, the reason for the failure.

Poll this operation until the status is SUCCESS or FAILED. An export can't be canceled after it starts.

See also: AWS API Documentation

Request Syntax

client.get_analysis_log_export(
    membershipIdentifier='string',
    analysisLogExportIdentifier='string'
)

type membershipIdentifier:

string

param membershipIdentifier:

[REQUIRED]

A unique identifier for the membership that the analysis log export belongs to. Currently accepts the membership ID.

type analysisLogExportIdentifier:

string

param analysisLogExportIdentifier:

[REQUIRED]

The unique identifier of the analysis log export to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'analysisLogExport': {
        'analysisLogExportId': 'string',
        'analysisId': 'string',
        'analysisType': 'PROTECTED_QUERY',
        'membershipId': 'string',
        'status': 'IN_PROGRESS'|'SUCCESS'|'FAILED',
        'resultConfiguration': {
            'outputConfiguration': {
                's3': {
                    'bucket': 'string',
                    'keyPrefix': 'string'
                }
            }
        },
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'error': {
            'code': 'string',
            'message': 'string'
        }
    }
}

Response Structure

(dict) --
- analysisLogExport (dict) --
  
  The analysis log export processing metadata.
  - analysisLogExportId (string) --
    
    The unique identifier of the analysis log export.
  - analysisId (string) --
    
    The unique identifier of the protected query that the analysis logs were exported for.
  - analysisType (string) --
    
    The type of analysis that the logs were exported for. Currently, only PROTECTED_QUERY is supported.
  - membershipId (string) --
    
    The unique identifier of the membership that the analysis log export belongs to.
  - status (string) --
    
    The status of the analysis log export. Possible values are:
    - IN_PROGRESS – The export is currently running.
    - SUCCESS – The export completed successfully.
    - FAILED – The export failed. See the error field for details.
  - resultConfiguration (dict) --
    
    Contains the details needed to write the exported analysis logs.
    - outputConfiguration (dict) --
      
      The configuration for analysis log export results.
      - s3 (dict) --
        
        Required configuration for an analysis log export with an s3 output type.
        
        bucket (string) --
        
        The S3 bucket that the exported analysis logs are written to. The bucket must be in the same Amazon Web Services Region as the collaboration.
        
        keyPrefix (string) --
        
        The S3 key prefix under which the exported analysis logs are written.
        
        Only one export can be in progress at a time for a given query and destination. To export the same query twice at once, use a different key prefix for the second export.
  - createTime (datetime) --
    
    The time the analysis log export was created.
  - updateTime (datetime) --
    
    The time the analysis log export was last updated.
  - error (dict) --
    
    The analysis log export error. This is present only when the export status is FAILED.
    - code (string) --
      
      The error code for the analysis log export.
    - message (string) --
      
      The message for the analysis log export error.

StartAnalysisLogExport (new)

Link ¶

Starts an export of the Apache Spark logs for a protected query to an Amazon S3 bucket that you own. Use the exported logs to diagnose a query that failed or that ran more slowly than you expected.

Clean Rooms exports a redacted copy of the Spark logs instead of the raw logs. Analyze the exported logs with the tooling of your choice, such as Spark History Server. For details about what the exported logs contain, see https://docs.aws.amazon.com/clean-rooms/latest/userguide/export-analysis-logs-contents.html.

The export runs asynchronously and returns with a status of IN_PROGRESS. Call GetAnalysisLogExport to poll for the final status.

For more information, see https://docs.aws.amazon.com/clean-rooms/latest/userguide/export-analysis-logs.html.

See also: AWS API Documentation

Request Syntax

client.start_analysis_log_export(
    membershipIdentifier='string',
    analysisId='string',
    analysisType='PROTECTED_QUERY',
    resultConfiguration={
        'outputConfiguration': {
            's3': {
                'bucket': 'string',
                'keyPrefix': 'string'
            }
        }
    }
)

type membershipIdentifier:

string

param membershipIdentifier:

[REQUIRED]

A unique identifier for the membership to export the analysis logs for. Currently accepts a membership ID.

type analysisId:

string

param analysisId:

[REQUIRED]

The unique identifier of the protected query that you want to export the analysis logs for.

type analysisType:

string

param analysisType:

[REQUIRED]

The type of analysis that the logs are exported for. Currently, only PROTECTED_QUERY is supported.

type resultConfiguration:

dict

param resultConfiguration:

[REQUIRED]

The details needed to write the exported analysis logs.

You don't need to create an IAM role for log export. Clean Rooms writes the exported logs using your own identity, so Clean Rooms writes the exported logs only where your existing permissions allow.

outputConfiguration (dict) -- [REQUIRED]

The configuration for analysis log export results.
- s3 (dict) -- [REQUIRED]
  
  Required configuration for an analysis log export with an s3 output type.
  - bucket (string) -- [REQUIRED]
    
    The S3 bucket that the exported analysis logs are written to. The bucket must be in the same Amazon Web Services Region as the collaboration.
  - keyPrefix (string) --
    
    The S3 key prefix under which the exported analysis logs are written.
    
    Only one export can be in progress at a time for a given query and destination. To export the same query twice at once, use a different key prefix for the second export.

rtype:

dict

returns:

Response Syntax

{
    'analysisLogExport': {
        'analysisLogExportId': 'string',
        'analysisId': 'string',
        'analysisType': 'PROTECTED_QUERY',
        'membershipId': 'string',
        'status': 'IN_PROGRESS'|'SUCCESS'|'FAILED',
        'resultConfiguration': {
            'outputConfiguration': {
                's3': {
                    'bucket': 'string',
                    'keyPrefix': 'string'
                }
            }
        },
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'error': {
            'code': 'string',
            'message': 'string'
        }
    }
}

Response Structure

(dict) --
- analysisLogExport (dict) --
  
  The analysis log export that was started. The status is IN_PROGRESS.
  - analysisLogExportId (string) --
    
    The unique identifier of the analysis log export.
  - analysisId (string) --
    
    The unique identifier of the protected query that the analysis logs were exported for.
  - analysisType (string) --
    
    The type of analysis that the logs were exported for. Currently, only PROTECTED_QUERY is supported.
  - membershipId (string) --
    
    The unique identifier of the membership that the analysis log export belongs to.
  - status (string) --
    
    The status of the analysis log export. Possible values are:
    - IN_PROGRESS – The export is currently running.
    - SUCCESS – The export completed successfully.
    - FAILED – The export failed. See the error field for details.
  - resultConfiguration (dict) --
    
    Contains the details needed to write the exported analysis logs.
    - outputConfiguration (dict) --
      
      The configuration for analysis log export results.
      - s3 (dict) --
        
        Required configuration for an analysis log export with an s3 output type.
        
        bucket (string) --
        
        The S3 bucket that the exported analysis logs are written to. The bucket must be in the same Amazon Web Services Region as the collaboration.
        
        keyPrefix (string) --
        
        The S3 key prefix under which the exported analysis logs are written.
        
        Only one export can be in progress at a time for a given query and destination. To export the same query twice at once, use a different key prefix for the second export.
  - createTime (datetime) --
    
    The time the analysis log export was created.
  - updateTime (datetime) --
    
    The time the analysis log export was last updated.
  - error (dict) --
    
    The analysis log export error. This is present only when the export status is FAILED.
    - code (string) --
      
      The error code for the analysis log export.
    - message (string) --
      
      The message for the analysis log export error.

ListAnalysisLogExports (new)

Link ¶

Lists analysis log exports, sorted by the most recent export. Results are paginated. Use the nextToken parameter to retrieve additional results.

See also: AWS API Documentation

Request Syntax

client.list_analysis_log_exports(
    membershipIdentifier='string',
    analysisIdentifier='string',
    status='IN_PROGRESS'|'SUCCESS'|'FAILED',
    nextToken='string',
    maxResults=123
)

type membershipIdentifier:

string

param membershipIdentifier:

[REQUIRED]

A unique identifier for the membership to list analysis log exports for. Currently accepts the membership ID.

type analysisIdentifier:

string

param analysisIdentifier:

A filter on the unique identifier of the protected query that the analysis logs were exported for.

type status:

string

param status:

A filter on the status of the analysis log export.

type nextToken:

string

param nextToken:

The pagination token that's used to fetch the next set of results.

type maxResults:

integer

param maxResults:

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.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'analysisLogExports': [
        {
            'analysisLogExportId': 'string',
            'analysisId': 'string',
            'analysisType': 'PROTECTED_QUERY',
            'status': 'IN_PROGRESS'|'SUCCESS'|'FAILED',
            'createTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  The pagination token that's used to fetch the next set of results.
- analysisLogExports (list) --
  
  A list of analysis log exports.
  - (dict) --
    
    A summary of an analysis log export, including its identifier, status, analysis type, and creation time. Returned by ListAnalysisLogExports.
    - analysisLogExportId (string) --
      
      The unique identifier of the analysis log export.
    - analysisId (string) --
      
      The unique identifier of the protected query that the analysis logs were exported for.
    - analysisType (string) --
      
      The type of analysis that the logs were exported for. Currently, only PROTECTED_QUERY is supported.
    - status (string) --
      
      The status of the analysis log export. Possible values are:
      - IN_PROGRESS – The export is currently running.
      - SUCCESS – The export completed successfully.
      - FAILED – The export failed.
    - createTime (datetime) --
      
      The time the analysis log export was created.

CreateCollaboration (updated)

Link ¶
Changes (request, response)
Request

{'autoApprovedChangeRequestTypes': {'GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY',
                                    'REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY'},
 'creatorMemberAbilities': {'CAN_EXPORT_QUERY_ANALYSIS_LOG'},
 'members': {'memberAbilities': {'CAN_EXPORT_QUERY_ANALYSIS_LOG'}}}

Response

{'collaboration': {'autoApprovedChangeTypes': {'GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY',
                                               'REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY'}}}

Creates a new collaboration.

See also: AWS API Documentation

Request Syntax

client.create_collaboration(
    members=[
        {
            'accountId': 'string',
            'memberAbilities': [
                'CAN_QUERY'|'CAN_RECEIVE_RESULTS'|'CAN_RUN_JOB'|'CAN_EXPORT_QUERY_ANALYSIS_LOG',
            ],
            'mlMemberAbilities': {
                'customMLMemberAbilities': [
                    'CAN_RECEIVE_MODEL_OUTPUT'|'CAN_RECEIVE_INFERENCE_OUTPUT',
                ]
            },
            'displayName': 'string',
            'paymentConfiguration': {
                'queryCompute': {
                    'isResponsible': True|False
                },
                'machineLearning': {
                    'modelTraining': {
                        'isResponsible': True|False
                    },
                    'modelInference': {
                        'isResponsible': True|False
                    },
                    'syntheticDataGeneration': {
                        'isResponsible': True|False
                    }
                },
                'jobCompute': {
                    'isResponsible': True|False
                }
            }
        },
    ],
    name='string',
    description='string',
    creatorMemberAbilities=[
        'CAN_QUERY'|'CAN_RECEIVE_RESULTS'|'CAN_RUN_JOB'|'CAN_EXPORT_QUERY_ANALYSIS_LOG',
    ],
    creatorMLMemberAbilities={
        'customMLMemberAbilities': [
            'CAN_RECEIVE_MODEL_OUTPUT'|'CAN_RECEIVE_INFERENCE_OUTPUT',
        ]
    },
    creatorDisplayName='string',
    dataEncryptionMetadata={
        'allowCleartext': True|False,
        'allowDuplicates': True|False,
        'allowJoinsOnColumnsWithDifferentNames': True|False,
        'preserveNulls': True|False
    },
    queryLogStatus='ENABLED'|'DISABLED',
    jobLogStatus='ENABLED'|'DISABLED',
    tags={
        'string': 'string'
    },
    creatorPaymentConfiguration={
        'queryCompute': {
            'isResponsible': True|False
        },
        'machineLearning': {
            'modelTraining': {
                'isResponsible': True|False
            },
            'modelInference': {
                'isResponsible': True|False
            },
            'syntheticDataGeneration': {
                'isResponsible': True|False
            }
        },
        'jobCompute': {
            'isResponsible': True|False
        }
    },
    analyticsEngine='SPARK'|'CLEAN_ROOMS_SQL',
    autoApprovedChangeRequestTypes=[
        'ADD_MEMBER'|'GRANT_RECEIVE_RESULTS_ABILITY'|'REVOKE_RECEIVE_RESULTS_ABILITY'|'GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY'|'REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY',
    ],
    allowedResultRegions=[
        'us-west-1'|'us-west-2'|'us-east-1'|'us-east-2'|'af-south-1'|'ap-east-1'|'ap-east-2'|'ap-south-2'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-southeast-5'|'ap-southeast-4'|'ap-southeast-7'|'ap-south-1'|'ap-northeast-3'|'ap-northeast-1'|'ap-northeast-2'|'ca-central-1'|'ca-west-1'|'eu-south-1'|'eu-west-3'|'eu-south-2'|'eu-central-2'|'eu-central-1'|'eu-north-1'|'eu-west-1'|'eu-west-2'|'me-south-1'|'me-central-1'|'il-central-1'|'sa-east-1'|'mx-central-1',
    ],
    isMetricsEnabled=True|False
)

type members:

list

param members:

[REQUIRED]

A list of initial members, not including the creator. This list is immutable.

(dict) --

Basic metadata used to construct a new member.
- accountId (string) -- [REQUIRED]
  
  The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
- memberAbilities (list) -- [REQUIRED]
  
  The abilities granted to the collaboration member.
  - (string) --
- mlMemberAbilities (dict) --
  
  The ML abilities granted to the collaboration member.
  - customMLMemberAbilities (list) -- [REQUIRED]
    
    The custom ML member abilities for a collaboration member.
    - (string) --
- displayName (string) -- [REQUIRED]
  
  The member's display name.
- paymentConfiguration (dict) --
  
  The collaboration member's payment responsibilities set by the collaboration creator.
  
  If the collaboration creator hasn't speciﬁed anyone as the member paying for query compute costs, then the member who can query is the default payer.
  - 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).
      
      One or more members can be configured as payer candidates for query compute costs.
      
      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.
  - 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).
        
        One or more members can be configured as payer candidates for model training costs.
        
        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.
    - 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).
        
        One or more members can be configured as payer candidates for model inference costs.
        
        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.
    - 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).
      
      One or more members can be configured as payer candidates for query and job compute costs.
      
      An error is returned if the collaboration creator sets a FALSE value for the member who can run queries and jobs.

type name:

string

param name:

[REQUIRED]

The display name for a collaboration.

type description:

string

param description:

A description of the collaboration provided by the collaboration owner.

type creatorMemberAbilities:

list

param creatorMemberAbilities:

[REQUIRED]

The abilities granted to the collaboration creator.

(string) --

type creatorMLMemberAbilities:

dict

param creatorMLMemberAbilities:

The ML abilities granted to the collaboration creator.

customMLMemberAbilities (list) -- [REQUIRED]

The custom ML member abilities for a collaboration member.
- (string) --

type creatorDisplayName:

string

param creatorDisplayName:

[REQUIRED]

The display name of the collaboration creator.

type dataEncryptionMetadata:

dict

param dataEncryptionMetadata:

The settings for client-side encryption with Cryptographic Computing for Clean Rooms.

allowCleartext (boolean) -- [REQUIRED]

Indicates whether encrypted tables can contain cleartext data ( TRUE) or are to cryptographically process every column ( FALSE).
allowDuplicates (boolean) -- [REQUIRED]

Indicates whether Fingerprint columns can contain duplicate entries ( TRUE) or are to contain only non-repeated values ( FALSE).
allowJoinsOnColumnsWithDifferentNames (boolean) -- [REQUIRED]

Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name ( TRUE) or can only be joined on Fingerprint columns of the same name ( FALSE).
preserveNulls (boolean) -- [REQUIRED]

Indicates whether NULL values are to be copied as NULL to encrypted tables ( TRUE) or cryptographically processed ( FALSE).

type queryLogStatus:

string

param queryLogStatus:

[REQUIRED]

An indicator as to whether query logging has been enabled or disabled for the collaboration.

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.

type jobLogStatus:

string

param jobLogStatus:

Specifies whether job logs are enabled for this collaboration.

When ENABLED, Clean Rooms logs details about jobs run within this collaboration; those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.

type tags:

dict

param tags:

An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

(string) --
- (string) --

type creatorPaymentConfiguration:

dict

param creatorPaymentConfiguration:

The collaboration creator's payment responsibilities set by the collaboration creator.

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.

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).
  
  One or more members can be configured as payer candidates for query compute costs.
  
  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.
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).
    
    One or more members can be configured as payer candidates for model training costs.
    
    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.
- 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).
    
    One or more members can be configured as payer candidates for model inference costs.
    
    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.
- 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).
  
  One or more members can be configured as payer candidates for query and job compute costs.
  
  An error is returned if the collaboration creator sets a FALSE value for the member who can run queries and jobs.

type analyticsEngine:

string

param analyticsEngine:

The analytics engine.

type autoApprovedChangeRequestTypes:

list

param autoApprovedChangeRequestTypes:

The types of change requests that are automatically approved for this collaboration.

(string) --

type allowedResultRegions:

list

param allowedResultRegions:

The Amazon Web Services Regions where collaboration query results can be stored. When specified, results can only be written to these Regions. This parameter enables you to meet your compliance and data governance requirements, and implement regional data governance policies.

(string) --

type isMetricsEnabled:

boolean

param isMetricsEnabled:

An indicator as to whether metrics have been enabled or disabled for the collaboration.

When true, collaboration members can opt in to Amazon CloudWatch metrics for their membership queries. The default value is false.

rtype:

dict

returns:

Response Syntax

{
    'collaboration': {
        'id': 'string',
        'arn': 'string',
        'name': 'string',
        'description': 'string',
        'creatorAccountId': 'string',
        'creatorDisplayName': 'string',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'memberStatus': 'INVITED'|'ACTIVE'|'LEFT'|'REMOVED',
        'membershipId': 'string',
        'membershipArn': 'string',
        'dataEncryptionMetadata': {
            'allowCleartext': True|False,
            'allowDuplicates': True|False,
            'allowJoinsOnColumnsWithDifferentNames': True|False,
            'preserveNulls': True|False
        },
        'queryLogStatus': 'ENABLED'|'DISABLED',
        'jobLogStatus': 'ENABLED'|'DISABLED',
        'analyticsEngine': 'SPARK'|'CLEAN_ROOMS_SQL',
        'autoApprovedChangeTypes': [
            'ADD_MEMBER'|'GRANT_RECEIVE_RESULTS_ABILITY'|'REVOKE_RECEIVE_RESULTS_ABILITY'|'GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY'|'REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY',
        ],
        'allowedResultRegions': [
            'us-west-1'|'us-west-2'|'us-east-1'|'us-east-2'|'af-south-1'|'ap-east-1'|'ap-east-2'|'ap-south-2'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-southeast-5'|'ap-southeast-4'|'ap-southeast-7'|'ap-south-1'|'ap-northeast-3'|'ap-northeast-1'|'ap-northeast-2'|'ca-central-1'|'ca-west-1'|'eu-south-1'|'eu-west-3'|'eu-south-2'|'eu-central-2'|'eu-central-1'|'eu-north-1'|'eu-west-1'|'eu-west-2'|'me-south-1'|'me-central-1'|'il-central-1'|'sa-east-1'|'mx-central-1',
        ],
        'isMetricsEnabled': True|False
    }
}

Response Structure

(dict) --
- collaboration (dict) --
  
  The collaboration.
  - id (string) --
    
    The unique ID for the collaboration.
  - arn (string) --
    
    The unique ARN for the collaboration.
  - name (string) --
    
    A human-readable identifier provided by the collaboration owner. Display names are not unique.
  - description (string) --
    
    A description of the collaboration provided by the collaboration owner.
  - creatorAccountId (string) --
    
    The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
  - creatorDisplayName (string) --
    
    A display name of the collaboration creator.
  - createTime (datetime) --
    
    The time when the collaboration was created.
  - updateTime (datetime) --
    
    The time the collaboration metadata was last updated.
  - memberStatus (string) --
    
    The status of a member in a collaboration.
  - membershipId (string) --
    
    The unique ID for your membership within the collaboration.
  - membershipArn (string) --
    
    The unique ARN for your membership within the collaboration.
  - dataEncryptionMetadata (dict) --
    
    The settings for client-side encryption for cryptographic computing.
    - allowCleartext (boolean) --
      
      Indicates whether encrypted tables can contain cleartext data ( TRUE) or are to cryptographically process every column ( FALSE).
    - allowDuplicates (boolean) --
      
      Indicates whether Fingerprint columns can contain duplicate entries ( TRUE) or are to contain only non-repeated values ( FALSE).
    - allowJoinsOnColumnsWithDifferentNames (boolean) --
      
      Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name ( TRUE) or can only be joined on Fingerprint columns of the same name ( FALSE).
    - preserveNulls (boolean) --
      
      Indicates whether NULL values are to be copied as NULL to encrypted tables ( TRUE) or cryptographically processed ( FALSE).
  - queryLogStatus (string) --
    
    An indicator as to whether query logging has been enabled or disabled for the collaboration.
    
    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.
  - analyticsEngine (string) --
    
    The analytics engine for the collaboration.
    
    Note
    
    After July 16, 2025, the CLEAN_ROOMS_SQL parameter will no longer be available.
  - autoApprovedChangeTypes (list) --
    
    The types of change requests that are automatically approved for this collaboration.
    - (string) --
  - allowedResultRegions (list) --
    
    The Amazon Web Services Regions where collaboration query results can be stored. Returns the list of Region identifiers that were specified when the collaboration was created. This list is used to enforce regional storage policies and compliance requirements.
    - (string) --
  - isMetricsEnabled (boolean) --
    
    An indicator as to whether metrics are enabled for the collaboration.
    
    When true, collaboration members can opt in to Amazon CloudWatch metrics for their membership queries.

CreateCollaborationChangeRequest (updated)

Link ¶
Changes (request, response)
Request

{'changes': {'specification': {'collaboration': {'autoApprovedChangeTypes': {'GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY',
                                                                             'REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY'}},
                               'member': {'memberAbilities': {'CAN_EXPORT_QUERY_ANALYSIS_LOG'}}}}}

Response

{'collaborationChangeRequest': {'changes': {'specification': {'collaboration': {'autoApprovedChangeTypes': {'GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY',
                                                                                                            'REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY'}},
                                                              'member': {'memberAbilities': {'CAN_EXPORT_QUERY_ANALYSIS_LOG'}}},
                                            'types': {'GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY',
                                                      'REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY'}}}}

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'|'CAN_EXPORT_QUERY_ANALYSIS_LOG',
                    ],
                    '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'|'GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY'|'REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY',
                    ]
                }
            }
        },
    ]
)

type collaborationIdentifier:

string

param collaborationIdentifier:

[REQUIRED]

The identifier of the collaboration that the change request is made against.

type changes:

list

param changes:

[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.
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: member, collaboration.
  - 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.
      
      Note
      
      The following values are currently not supported: CAN_QUERY and CAN_RUN_JOB.
      
      Set the value of memberAbilities to [] to allow a member to contribute data.
      
      Set the value of memberAbilities to [CAN_RECEIVE_RESULTS] to allow a member to contribute data and receive results.
      
      Set the value of memberAbilities to [CAN_EXPORT_QUERY_ANALYSIS_LOG] so that the member can export the analysis logs for a protected query. Having this ability isn't sufficient on its own: You can export logs only for queries that you ran or paid for.
      - (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).
        
        One or more members can be configured as payer candidates for query compute costs.
        
        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.
      - 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).
        
        One or more members can be configured as payer candidates for model training costs.
        
        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.
        
        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).
        
        One or more members can be configured as payer candidates for model inference costs.
        
        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.
        
        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).
        
        One or more members can be configured as payer candidates for query and job compute costs.
        
        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) --

rtype:

dict

returns:

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'|'CAN_EXPORT_QUERY_ANALYSIS_LOG',
                        ],
                        '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'|'GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY'|'REVOKE_EXPORT_QUERY_ANALYSIS_LOG_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'|'GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY'|'REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY',
                ]
            },
        ],
        '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.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: member, collaboration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        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.
        
        Note
        
        The following values are currently not supported: CAN_QUERY and CAN_RUN_JOB.
        
        Set the value of memberAbilities to [] to allow a member to contribute data.
        
        Set the value of memberAbilities to [CAN_RECEIVE_RESULTS] to allow a member to contribute data and receive results.
        
        Set the value of memberAbilities to [CAN_EXPORT_QUERY_ANALYSIS_LOG] so that the member can export the analysis logs for a protected query. Having this ability isn't sufficient on its own: You can export logs only for queries that you ran or paid for.
        
        (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).
        
        One or more members can be configured as payer candidates for query compute costs.
        
        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.
        
        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).
        
        One or more members can be configured as payer candidates for model training costs.
        
        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.
        
        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).
        
        One or more members can be configured as payer candidates for model inference costs.
        
        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.
        
        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).
        
        One or more members can be configured as payer candidates for query and job compute costs.
        
        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.

CreateMembership (updated)

Link ¶
Changes (response)

{'membership': {'memberAbilities': {'CAN_EXPORT_QUERY_ANALYSIS_LOG'}}}

Creates a membership for a specific collaboration identifier and joins the collaboration.

See also: AWS API Documentation

Request Syntax

client.create_membership(
    collaborationIdentifier='string',
    queryLogStatus='ENABLED'|'DISABLED',
    jobLogStatus='ENABLED'|'DISABLED',
    tags={
        'string': 'string'
    },
    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
)

type collaborationIdentifier:

string

param collaborationIdentifier:

[REQUIRED]

The unique ID for the associated collaboration.

type queryLogStatus:

string

param queryLogStatus:

[REQUIRED]

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.

type jobLogStatus:

string

param jobLogStatus:

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.

type tags:

dict

param tags:

(string) --
- (string) --

type defaultResultConfiguration:

dict

param defaultResultConfiguration:

The default protected query result configuration as specified by the member who can receive results.

outputConfiguration (dict) -- [REQUIRED]

Configuration for protected query results.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: s3.
- 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.

type defaultJobResultConfiguration:

dict

param defaultJobResultConfiguration:

The default job result configuration that determines how job results are protected and managed within this membership. This configuration applies to all jobs.

outputConfiguration (dict) -- [REQUIRED]

The output configuration for a protected job result.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: s3.
- 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.

type paymentConfiguration:

dict

param paymentConfiguration:

The payment responsibilities accepted by the collaboration member.

Not required if the collaboration member has the member ability to run queries.

Required if the collaboration member doesn't have the member ability to run queries but is configured as a payer by the collaboration creator.

queryCompute (dict) -- [REQUIRED]

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) --

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) -- [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) --

The payment responsibilities accepted by the collaboration member for 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 can be one or more members who are designated as payer candidates 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.

type isMetricsEnabled:

boolean

param isMetricsEnabled:

An indicator as to whether Amazon CloudWatch metrics have been enabled or disabled for the membership.

Amazon CloudWatch metrics are only available when the collaboration has metrics enabled. This option can be set by collaboration members who have the ability to run queries (analysis runners) or by members who are configured as payers.

When true, metrics about query execution are collected in Amazon CloudWatch. The default value is false.

rtype:

dict

returns:

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'|'CAN_EXPORT_QUERY_ANALYSIS_LOG',
        ],
        '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 that was created.
  - 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.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: s3. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - 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.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: s3. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - 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 can be one or more members who are designated as payer candidates 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.

GetCollaboration (updated)

Link ¶
Changes (response)

{'collaboration': {'autoApprovedChangeTypes': {'GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY',
                                               'REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY'}}}

Returns metadata about a collaboration.

See also: AWS API Documentation

Request Syntax

client.get_collaboration(
    collaborationIdentifier='string'
)

type collaborationIdentifier:

string

param collaborationIdentifier:

[REQUIRED]

The identifier for the collaboration.

rtype:

dict

returns:

Response Syntax

{
    'collaboration': {
        'id': 'string',
        'arn': 'string',
        'name': 'string',
        'description': 'string',
        'creatorAccountId': 'string',
        'creatorDisplayName': 'string',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'memberStatus': 'INVITED'|'ACTIVE'|'LEFT'|'REMOVED',
        'membershipId': 'string',
        'membershipArn': 'string',
        'dataEncryptionMetadata': {
            'allowCleartext': True|False,
            'allowDuplicates': True|False,
            'allowJoinsOnColumnsWithDifferentNames': True|False,
            'preserveNulls': True|False
        },
        'queryLogStatus': 'ENABLED'|'DISABLED',
        'jobLogStatus': 'ENABLED'|'DISABLED',
        'analyticsEngine': 'SPARK'|'CLEAN_ROOMS_SQL',
        'autoApprovedChangeTypes': [
            'ADD_MEMBER'|'GRANT_RECEIVE_RESULTS_ABILITY'|'REVOKE_RECEIVE_RESULTS_ABILITY'|'GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY'|'REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY',
        ],
        'allowedResultRegions': [
            'us-west-1'|'us-west-2'|'us-east-1'|'us-east-2'|'af-south-1'|'ap-east-1'|'ap-east-2'|'ap-south-2'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-southeast-5'|'ap-southeast-4'|'ap-southeast-7'|'ap-south-1'|'ap-northeast-3'|'ap-northeast-1'|'ap-northeast-2'|'ca-central-1'|'ca-west-1'|'eu-south-1'|'eu-west-3'|'eu-south-2'|'eu-central-2'|'eu-central-1'|'eu-north-1'|'eu-west-1'|'eu-west-2'|'me-south-1'|'me-central-1'|'il-central-1'|'sa-east-1'|'mx-central-1',
        ],
        'isMetricsEnabled': True|False
    }
}

Response Structure

(dict) --
- collaboration (dict) --
  
  The entire collaboration for this identifier.
  - id (string) --
    
    The unique ID for the collaboration.
  - arn (string) --
    
    The unique ARN for the collaboration.
  - name (string) --
    
    A human-readable identifier provided by the collaboration owner. Display names are not unique.
  - description (string) --
    
    A description of the collaboration provided by the collaboration owner.
  - creatorAccountId (string) --
    
    The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
  - creatorDisplayName (string) --
    
    A display name of the collaboration creator.
  - createTime (datetime) --
    
    The time when the collaboration was created.
  - updateTime (datetime) --
    
    The time the collaboration metadata was last updated.
  - memberStatus (string) --
    
    The status of a member in a collaboration.
  - membershipId (string) --
    
    The unique ID for your membership within the collaboration.
  - membershipArn (string) --
    
    The unique ARN for your membership within the collaboration.
  - dataEncryptionMetadata (dict) --
    
    The settings for client-side encryption for cryptographic computing.
    - allowCleartext (boolean) --
      
      Indicates whether encrypted tables can contain cleartext data ( TRUE) or are to cryptographically process every column ( FALSE).
    - allowDuplicates (boolean) --
      
      Indicates whether Fingerprint columns can contain duplicate entries ( TRUE) or are to contain only non-repeated values ( FALSE).
    - allowJoinsOnColumnsWithDifferentNames (boolean) --
      
      Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name ( TRUE) or can only be joined on Fingerprint columns of the same name ( FALSE).
    - preserveNulls (boolean) --
      
      Indicates whether NULL values are to be copied as NULL to encrypted tables ( TRUE) or cryptographically processed ( FALSE).
  - queryLogStatus (string) --
    
    An indicator as to whether query logging has been enabled or disabled for the collaboration.
    
    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.
  - analyticsEngine (string) --
    
    The analytics engine for the collaboration.
    
    Note
    
    After July 16, 2025, the CLEAN_ROOMS_SQL parameter will no longer be available.
  - autoApprovedChangeTypes (list) --
    
    The types of change requests that are automatically approved for this collaboration.
    - (string) --
  - allowedResultRegions (list) --
    
    The Amazon Web Services Regions where collaboration query results can be stored. Returns the list of Region identifiers that were specified when the collaboration was created. This list is used to enforce regional storage policies and compliance requirements.
    - (string) --
  - isMetricsEnabled (boolean) --
    
    An indicator as to whether metrics are enabled for the collaboration.
    
    When true, collaboration members can opt in to Amazon CloudWatch metrics for their membership queries.

GetCollaborationChangeRequest (updated)

Link ¶
Changes (response)

{'collaborationChangeRequest': {'changes': {'specification': {'collaboration': {'autoApprovedChangeTypes': {'GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY',
                                                                                                            'REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY'}},
                                                              'member': {'memberAbilities': {'CAN_EXPORT_QUERY_ANALYSIS_LOG'}}},
                                            'types': {'GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY',
                                                      'REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY'}}}}

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'
)

type collaborationIdentifier:

string

param collaborationIdentifier:

[REQUIRED]

The identifier of the collaboration that the change request is made against.

type changeRequestIdentifier:

string

param changeRequestIdentifier:

[REQUIRED]

A unique identifier for the change request to retrieve.

rtype:

dict

returns:

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'|'CAN_EXPORT_QUERY_ANALYSIS_LOG',
                        ],
                        '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'|'GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY'|'REVOKE_EXPORT_QUERY_ANALYSIS_LOG_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'|'GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY'|'REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY',
                ]
            },
        ],
        '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.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: member, collaboration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        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.
        
        Note
        
        The following values are currently not supported: CAN_QUERY and CAN_RUN_JOB.
        
        Set the value of memberAbilities to [] to allow a member to contribute data.
        
        Set the value of memberAbilities to [CAN_RECEIVE_RESULTS] to allow a member to contribute data and receive results.
        
        Set the value of memberAbilities to [CAN_EXPORT_QUERY_ANALYSIS_LOG] so that the member can export the analysis logs for a protected query. Having this ability isn't sufficient on its own: You can export logs only for queries that you ran or paid for.
        
        (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).
        
        One or more members can be configured as payer candidates for query compute costs.
        
        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.
        
        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).
        
        One or more members can be configured as payer candidates for model training costs.
        
        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.
        
        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).
        
        One or more members can be configured as payer candidates for model inference costs.
        
        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.
        
        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).
        
        One or more members can be configured as payer candidates for query and job compute costs.
        
        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.

GetMembership (updated)

Link ¶
Changes (response)

{'membership': {'memberAbilities': {'CAN_EXPORT_QUERY_ANALYSIS_LOG'}}}

Retrieves a specified membership for an identifier.

See also: AWS API Documentation

Request Syntax

client.get_membership(
    membershipIdentifier='string'
)

type membershipIdentifier:

string

param membershipIdentifier:

[REQUIRED]

The identifier for a membership resource.

rtype:

dict

returns:

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'|'CAN_EXPORT_QUERY_ANALYSIS_LOG',
        ],
        '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 retrieved for the provided identifier.
  - 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.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: s3. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - 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.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: s3. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - 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 can be one or more members who are designated as payer candidates 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.

ListCollaborationChangeRequests (updated)

Link ¶
Changes (response)

{'collaborationChangeRequestSummaries': {'changes': {'specification': {'collaboration': {'autoApprovedChangeTypes': {'GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY',
                                                                                                                     'REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY'}},
                                                                       'member': {'memberAbilities': {'CAN_EXPORT_QUERY_ANALYSIS_LOG'}}},
                                                     'types': {'GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY',
                                                               'REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY'}}}}

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
)

type collaborationIdentifier:

string

param collaborationIdentifier:

[REQUIRED]

The identifier of the collaboration that the change request is made against.

type status:

string

param status:

A filter to only return change requests with the specified status.

type nextToken:

string

param nextToken:

The pagination token that's used to fetch the next set of results.

type maxResults:

integer

param maxResults:

The maximum number of results that are returned for an API request call.

rtype:

dict

returns:

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'|'CAN_EXPORT_QUERY_ANALYSIS_LOG',
                            ],
                            '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'|'GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY'|'REVOKE_EXPORT_QUERY_ANALYSIS_LOG_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'|'GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY'|'REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY',
                    ]
                },
            ],
            '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.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: member, collaboration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        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.
        
        Note
        
        The following values are currently not supported: CAN_QUERY and CAN_RUN_JOB.
        
        Set the value of memberAbilities to [] to allow a member to contribute data.
        
        Set the value of memberAbilities to [CAN_RECEIVE_RESULTS] to allow a member to contribute data and receive results.
        
        Set the value of memberAbilities to [CAN_EXPORT_QUERY_ANALYSIS_LOG] so that the member can export the analysis logs for a protected query. Having this ability isn't sufficient on its own: You can export logs only for queries that you ran or paid for.
        
        (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).
        
        One or more members can be configured as payer candidates for query compute costs.
        
        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.
        
        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).
        
        One or more members can be configured as payer candidates for model training costs.
        
        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.
        
        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).
        
        One or more members can be configured as payer candidates for model inference costs.
        
        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.
        
        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).
        
        One or more members can be configured as payer candidates for query and job compute costs.
        
        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.

ListMembers (updated)

Link ¶
Changes (response)

{'memberSummaries': {'abilities': {'CAN_EXPORT_QUERY_ANALYSIS_LOG'}}}

Lists all members within a collaboration.

See also: AWS API Documentation

Request Syntax

client.list_members(
    collaborationIdentifier='string',
    nextToken='string',
    maxResults=123
)

type collaborationIdentifier:

string

param collaborationIdentifier:

[REQUIRED]

The identifier of the collaboration in which the members are listed.

type nextToken:

string

param nextToken:

The pagination token that's used to fetch the next set of results.

type maxResults:

integer

param maxResults:

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'memberSummaries': [
        {
            'accountId': 'string',
            'status': 'INVITED'|'ACTIVE'|'LEFT'|'REMOVED',
            'displayName': 'string',
            'abilities': [
                'CAN_QUERY'|'CAN_RECEIVE_RESULTS'|'CAN_RUN_JOB'|'CAN_EXPORT_QUERY_ANALYSIS_LOG',
            ],
            'mlAbilities': {
                'customMLMemberAbilities': [
                    'CAN_RECEIVE_MODEL_OUTPUT'|'CAN_RECEIVE_INFERENCE_OUTPUT',
                ]
            },
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'membershipId': 'string',
            'membershipArn': 'string',
            'paymentConfiguration': {
                'queryCompute': {
                    'isResponsible': True|False
                },
                'machineLearning': {
                    'modelTraining': {
                        'isResponsible': True|False
                    },
                    'modelInference': {
                        'isResponsible': True|False
                    },
                    'syntheticDataGeneration': {
                        'isResponsible': True|False
                    }
                },
                'jobCompute': {
                    'isResponsible': True|False
                }
            }
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  The pagination token that's used to fetch the next set of results.
- memberSummaries (list) --
  
  The list of members returned by the ListMembers operation.
  - (dict) --
    
    The member object listed by the request.
    - accountId (string) --
      
      The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
    - status (string) --
      
      The status of the member.
    - displayName (string) --
      
      The member's display name.
    - abilities (list) --
      
      The abilities granted to the collaboration member.
      - (string) --
    - mlAbilities (dict) --
      
      Provides a summary of the ML abilities for the collaboration member.
      - customMLMemberAbilities (list) --
        
        The custom ML member abilities for a collaboration member.
        
        (string) --
    - createTime (datetime) --
      
      The time when the member was created.
    - updateTime (datetime) --
      
      The time the member metadata was last updated.
    - membershipId (string) --
      
      The unique ID for the member's associated membership, if present.
    - membershipArn (string) --
      
      The unique ARN for the member's associated membership, if present.
    - paymentConfiguration (dict) --
      
      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).
        
        One or more members can be configured as payer candidates for query compute costs.
        
        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.
      - 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).
        
        One or more members can be configured as payer candidates for model training costs.
        
        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.
        
        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).
        
        One or more members can be configured as payer candidates for model inference costs.
        
        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.
        
        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).
        
        One or more members can be configured as payer candidates for query and job compute costs.
        
        An error is returned if the collaboration creator sets a FALSE value for the member who can run queries and jobs.

ListMemberships (updated)

Link ¶
Changes (response)

{'membershipSummaries': {'memberAbilities': {'CAN_EXPORT_QUERY_ANALYSIS_LOG'}}}

Lists all memberships resources within the caller's account.

See also: AWS API Documentation

Request Syntax

client.list_memberships(
    nextToken='string',
    maxResults=123,
    status='ACTIVE'|'REMOVED'|'COLLABORATION_DELETED'
)

type nextToken:

string

param nextToken:

The pagination token that's used to fetch the next set of results.

type maxResults:

integer

param maxResults:

type status:

string

param status:

A filter which will return only memberships in the specified status.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'membershipSummaries': [
        {
            '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'|'CAN_EXPORT_QUERY_ANALYSIS_LOG',
            ],
            '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
                }
            }
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  The pagination token that's used to fetch the next set of results.
- membershipSummaries (list) --
  
  The list of memberships returned from the ListMemberships operation.
  - (dict) --
    
    The membership object listed by the request.
    - id (string) --
      
      The unique ID for the membership's collaboration.
    - 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 of the Amazon Web Services principal that created the collaboration. Currently only supports Amazon Web Services account ID.
    - collaborationCreatorDisplayName (string) --
      
      The display name of the collaboration creator.
    - collaborationName (string) --
      
      The name for 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) --
      
      Provides a summary of the ML abilities for the collaboration member.
      - customMLMemberAbilities (list) --
        
        The custom ML member abilities for a collaboration member.
        
        (string) --
    - 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 can be one or more members who are designated as payer candidates 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.

UpdateCollaboration (updated)

Link ¶
Changes (response)

{'collaboration': {'autoApprovedChangeTypes': {'GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY',
                                               'REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY'}}}

Updates collaboration metadata and can only be called by the collaboration owner.

See also: AWS API Documentation

Request Syntax

client.update_collaboration(
    collaborationIdentifier='string',
    name='string',
    description='string',
    analyticsEngine='SPARK'|'CLEAN_ROOMS_SQL'
)

type collaborationIdentifier:

string

param collaborationIdentifier:

[REQUIRED]

The identifier for the collaboration.

type name:

string

param name:

A human-readable identifier provided by the collaboration owner. Display names are not unique.

type description:

string

param description:

A description of the collaboration.

type analyticsEngine:

string

param analyticsEngine:

The analytics engine.

rtype:

dict

returns:

Response Syntax

{
    'collaboration': {
        'id': 'string',
        'arn': 'string',
        'name': 'string',
        'description': 'string',
        'creatorAccountId': 'string',
        'creatorDisplayName': 'string',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'memberStatus': 'INVITED'|'ACTIVE'|'LEFT'|'REMOVED',
        'membershipId': 'string',
        'membershipArn': 'string',
        'dataEncryptionMetadata': {
            'allowCleartext': True|False,
            'allowDuplicates': True|False,
            'allowJoinsOnColumnsWithDifferentNames': True|False,
            'preserveNulls': True|False
        },
        'queryLogStatus': 'ENABLED'|'DISABLED',
        'jobLogStatus': 'ENABLED'|'DISABLED',
        'analyticsEngine': 'SPARK'|'CLEAN_ROOMS_SQL',
        'autoApprovedChangeTypes': [
            'ADD_MEMBER'|'GRANT_RECEIVE_RESULTS_ABILITY'|'REVOKE_RECEIVE_RESULTS_ABILITY'|'GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY'|'REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY',
        ],
        'allowedResultRegions': [
            'us-west-1'|'us-west-2'|'us-east-1'|'us-east-2'|'af-south-1'|'ap-east-1'|'ap-east-2'|'ap-south-2'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-southeast-5'|'ap-southeast-4'|'ap-southeast-7'|'ap-south-1'|'ap-northeast-3'|'ap-northeast-1'|'ap-northeast-2'|'ca-central-1'|'ca-west-1'|'eu-south-1'|'eu-west-3'|'eu-south-2'|'eu-central-2'|'eu-central-1'|'eu-north-1'|'eu-west-1'|'eu-west-2'|'me-south-1'|'me-central-1'|'il-central-1'|'sa-east-1'|'mx-central-1',
        ],
        'isMetricsEnabled': True|False
    }
}

Response Structure

(dict) --
- collaboration (dict) --
  
  The entire collaboration that has been updated.
  - id (string) --
    
    The unique ID for the collaboration.
  - arn (string) --
    
    The unique ARN for the collaboration.
  - name (string) --
    
    A human-readable identifier provided by the collaboration owner. Display names are not unique.
  - description (string) --
    
    A description of the collaboration provided by the collaboration owner.
  - creatorAccountId (string) --
    
    The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
  - creatorDisplayName (string) --
    
    A display name of the collaboration creator.
  - createTime (datetime) --
    
    The time when the collaboration was created.
  - updateTime (datetime) --
    
    The time the collaboration metadata was last updated.
  - memberStatus (string) --
    
    The status of a member in a collaboration.
  - membershipId (string) --
    
    The unique ID for your membership within the collaboration.
  - membershipArn (string) --
    
    The unique ARN for your membership within the collaboration.
  - dataEncryptionMetadata (dict) --
    
    The settings for client-side encryption for cryptographic computing.
    - allowCleartext (boolean) --
      
      Indicates whether encrypted tables can contain cleartext data ( TRUE) or are to cryptographically process every column ( FALSE).
    - allowDuplicates (boolean) --
      
      Indicates whether Fingerprint columns can contain duplicate entries ( TRUE) or are to contain only non-repeated values ( FALSE).
    - allowJoinsOnColumnsWithDifferentNames (boolean) --
      
      Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name ( TRUE) or can only be joined on Fingerprint columns of the same name ( FALSE).
    - preserveNulls (boolean) --
      
      Indicates whether NULL values are to be copied as NULL to encrypted tables ( TRUE) or cryptographically processed ( FALSE).
  - queryLogStatus (string) --
    
    An indicator as to whether query logging has been enabled or disabled for the collaboration.
    
    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.
  - analyticsEngine (string) --
    
    The analytics engine for the collaboration.
    
    Note
    
    After July 16, 2025, the CLEAN_ROOMS_SQL parameter will no longer be available.
  - autoApprovedChangeTypes (list) --
    
    The types of change requests that are automatically approved for this collaboration.
    - (string) --
  - allowedResultRegions (list) --
    
    The Amazon Web Services Regions where collaboration query results can be stored. Returns the list of Region identifiers that were specified when the collaboration was created. This list is used to enforce regional storage policies and compliance requirements.
    - (string) --
  - isMetricsEnabled (boolean) --
    
    An indicator as to whether metrics are enabled for the collaboration.
    
    When true, collaboration members can opt in to Amazon CloudWatch metrics for their membership queries.

UpdateCollaborationChangeRequest (updated)

Link ¶
Changes (response)

{'collaborationChangeRequest': {'changes': {'specification': {'collaboration': {'autoApprovedChangeTypes': {'GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY',
                                                                                                            'REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY'}},
                                                              'member': {'memberAbilities': {'CAN_EXPORT_QUERY_ANALYSIS_LOG'}}},
                                            'types': {'GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY',
                                                      'REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY'}}}}

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'
)

type collaborationIdentifier:

string

param collaborationIdentifier:

[REQUIRED]

The unique identifier of the collaboration that contains the change request to be updated.

type changeRequestIdentifier:

string

param changeRequestIdentifier:

[REQUIRED]

The unique identifier of the specific change request to be updated within the collaboration.

type action:

string

param action:

[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.

rtype:

dict

returns:

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'|'CAN_EXPORT_QUERY_ANALYSIS_LOG',
                        ],
                        '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'|'GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY'|'REVOKE_EXPORT_QUERY_ANALYSIS_LOG_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'|'GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY'|'REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY',
                ]
            },
        ],
        '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.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: member, collaboration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        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.
        
        Note
        
        The following values are currently not supported: CAN_QUERY and CAN_RUN_JOB.
        
        Set the value of memberAbilities to [] to allow a member to contribute data.
        
        Set the value of memberAbilities to [CAN_RECEIVE_RESULTS] to allow a member to contribute data and receive results.
        
        Set the value of memberAbilities to [CAN_EXPORT_QUERY_ANALYSIS_LOG] so that the member can export the analysis logs for a protected query. Having this ability isn't sufficient on its own: You can export logs only for queries that you ran or paid for.
        
        (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).
        
        One or more members can be configured as payer candidates for query compute costs.
        
        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.
        
        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).
        
        One or more members can be configured as payer candidates for model training costs.
        
        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.
        
        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).
        
        One or more members can be configured as payer candidates for model inference costs.
        
        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.
        
        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).
        
        One or more members can be configured as payer candidates for query and job compute costs.
        
        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.

UpdateMembership (updated)

Link ¶
Changes (response)

{'membership': {'memberAbilities': {'CAN_EXPORT_QUERY_ANALYSIS_LOG'}}}

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
        }
    }
)

type membershipIdentifier:

string

param membershipIdentifier:

[REQUIRED]

The unique identifier of the membership.

type queryLogStatus:

string

param queryLogStatus:

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.

type jobLogStatus:

string

param jobLogStatus:

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.

type defaultResultConfiguration:

dict

param defaultResultConfiguration:

The default protected query result configuration as specified by the member who can receive results.

outputConfiguration (dict) -- [REQUIRED]

Configuration for protected query results.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: s3.
- 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.

type defaultJobResultConfiguration:

dict

param defaultJobResultConfiguration:

The default job result configuration.

outputConfiguration (dict) -- [REQUIRED]

The output configuration for a protected job result.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: s3.
- 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.

type membershipPaymentConfiguration:

dict

param membershipPaymentConfiguration:

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 can be one or more members who are designated as payer candidates 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.

rtype:

dict

returns:

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'|'CAN_EXPORT_QUERY_ANALYSIS_LOG',
        ],
        '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.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: s3. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - 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.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: s3. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - 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 can be one or more members who are designated as payer candidates 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.