CleanRoomsService / Client / create_collaboration

create_collaboration#

CleanRoomsService.Client.create_collaboration(**kwargs)#

Creates a new collaboration.

Request Syntax

response = client.create_collaboration(
    members=[
        {
            'accountId': 'string',
            'memberAbilities': [
                'CAN_QUERY'|'CAN_RECEIVE_RESULTS',
            ],
            '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
                    }
                }
            }
        },
    ],
    name='string',
    description='string',
    creatorMemberAbilities=[
        'CAN_QUERY'|'CAN_RECEIVE_RESULTS',
    ],
    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',
    tags={
        'string': 'string'
    },
    creatorPaymentConfiguration={
        'queryCompute': {
            'isResponsible': True|False
        },
        'machineLearning': {
            'modelTraining': {
                'isResponsible': True|False
            },
            'modelInference': {
                'isResponsible': True|False
            }
        }
    },
    analyticsEngine='SPARK'|'CLEAN_ROOMS_SQL'
)

Parameters:

members (list) –
[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.
    
    Custom ML modeling is in beta release and is subject to change. For beta terms and conditions, see Betas and Previews in the Amazon Web Services Service Terms.
    - customMLMemberAbilities (list) – [REQUIRED]
      
      The custom ML member abilities for a collaboration member. The inference feature is not available in the custom ML modeling beta.
      
      Custom ML modeling is in beta release and is subject to change. For beta terms and conditions, see Betas and Previews in the Amazon Web Services Service Terms.
      - (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).
        
        Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
        
        If the collaboration creator hasn’t specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
    - machineLearning (dict) –
      
      An object representing the collaboration member’s machine learning payment responsibilities set by the collaboration creator.
      - modelTraining (dict) –
        
        The payment responsibilities accepted by the member for model training.
        
        isResponsible (boolean) – [REQUIRED]
        
        Indicates whether the collaboration creator has configured the collaboration member to pay for model training costs ( TRUE) or has not configured the collaboration member to pay for model training costs ( FALSE).
        
        Exactly one member can be configured to pay for model training costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
        
        If the collaboration creator hasn’t specified anyone as the member paying for model training costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
      - modelInference (dict) –
        
        The payment responsibilities accepted by the member for model inference.
        
        isResponsible (boolean) – [REQUIRED]
        
        Indicates whether the collaboration creator has configured the collaboration member to pay for model inference costs ( TRUE) or has not configured the collaboration member to pay for model inference costs ( FALSE).
        
        Exactly one member can be configured to pay for model inference costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
        
        If the collaboration creator hasn’t specified anyone as the member paying for model inference costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
name (string) –
[REQUIRED]

The display name for a collaboration.
description (string) –
[REQUIRED]

A description of the collaboration provided by the collaboration owner.
creatorMemberAbilities (list) –
[REQUIRED]

The abilities granted to the collaboration creator.
- (string) –
creatorMLMemberAbilities (dict) –
The ML abilities granted to the collaboration creator.

Custom ML modeling is in beta release and is subject to change. For beta terms and conditions, see Betas and Previews in the Amazon Web Services Service Terms.
- customMLMemberAbilities (list) – [REQUIRED]
  
  The custom ML member abilities for a collaboration member. The inference feature is not available in the custom ML modeling beta.
  
  Custom ML modeling is in beta release and is subject to change. For beta terms and conditions, see Betas and Previews in the Amazon Web Services Service Terms.
  - (string) –
creatorDisplayName (string) –
[REQUIRED]

The display name of the collaboration creator.
dataEncryptionMetadata (dict) –
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).
queryLogStatus (string) –
[REQUIRED]

An indicator as to whether query logging has been enabled or disabled for the collaboration.
tags (dict) –
An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
- (string) –
  - (string) –
creatorPaymentConfiguration (dict) –
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).
    
    Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
    
    If the collaboration creator hasn’t specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
- machineLearning (dict) –
  
  An object representing the collaboration member’s machine learning payment responsibilities set by the collaboration creator.
  - modelTraining (dict) –
    
    The payment responsibilities accepted by the member for model training.
    - isResponsible (boolean) – [REQUIRED]
      
      Indicates whether the collaboration creator has configured the collaboration member to pay for model training costs ( TRUE) or has not configured the collaboration member to pay for model training costs ( FALSE).
      
      Exactly one member can be configured to pay for model training costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
      
      If the collaboration creator hasn’t specified anyone as the member paying for model training costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
  - modelInference (dict) –
    
    The payment responsibilities accepted by the member for model inference.
    - isResponsible (boolean) – [REQUIRED]
      
      Indicates whether the collaboration creator has configured the collaboration member to pay for model inference costs ( TRUE) or has not configured the collaboration member to pay for model inference costs ( FALSE).
      
      Exactly one member can be configured to pay for model inference costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
      
      If the collaboration creator hasn’t specified anyone as the member paying for model inference costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
analyticsEngine (string) – The analytics engine.

Return type:

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',
        'analyticsEngine': 'SPARK'|'CLEAN_ROOMS_SQL'
    }
}

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.
  - analyticsEngine (string) –
    
    The analytics engine for the collaboration.

Exceptions

CleanRoomsService.Client.exceptions.ServiceQuotaExceededException
CleanRoomsService.Client.exceptions.InternalServerException
CleanRoomsService.Client.exceptions.ValidationException
CleanRoomsService.Client.exceptions.ThrottlingException
CleanRoomsService.Client.exceptions.AccessDeniedException