CleanRoomsService / Client / create_collaboration_change_request

create_collaboration_change_request¶

CleanRoomsService.Client.create_collaboration_change_request(**kwargs)¶

Creates a new change request to modify an existing collaboration. This enables post-creation modifications to collaborations through a structured API-driven approach.

Request Syntax

response = client.create_collaboration_change_request(
    collaborationIdentifier='string',
    changes=[
        {
            'specificationType': 'MEMBER',
            'specification': {
                'member': {
                    'accountId': 'string',
                    'memberAbilities': [
                        'CAN_QUERY'|'CAN_RECEIVE_RESULTS'|'CAN_RUN_JOB',
                    ],
                    'displayName': 'string'
                }
            }
        },
    ]
)

Parameters:

collaborationIdentifier (string) –
[REQUIRED]

The identifier of the collaboration that the change request is made against.
changes (list) –
[REQUIRED]

The list of changes to apply to the collaboration. Each change specifies the type of modification and the details of what should be changed.
- (dict) –
  
  Specifies a change to apply to a collaboration.
  - specificationType (string) – [REQUIRED]
    
    The type of specification for the change. Currently supports MEMBER for member-related changes.
  - specification (dict) – [REQUIRED]
    
    The specification details for the change. The structure depends on the specification type.
    
    Note
    This is a Tagged Union structure. Only one of the following top level keys can be set: member.
    - 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, CAN_RECEIVE_RESULTS, and CAN_RUN_JOB.
        
        Set the value of memberAbilities to [] to allow a member to contribute data.
        
        (string) –
      - 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.

Return type:

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',
                'specification': {
                    'member': {
                        'accountId': 'string',
                        'memberAbilities': [
                            'CAN_QUERY'|'CAN_RECEIVE_RESULTS'|'CAN_RUN_JOB',
                        ],
                        'displayName': 'string'
                    }
                },
                'types': [
                    'ADD_MEMBER',
                ]
            },
        ]
    }
}

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. 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, CAN_RECEIVE_RESULTS, and CAN_RUN_JOB.
        
        Set the value of memberAbilities to [] to allow a member to contribute data.
        
        (string) –
        
        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.
      - types (list) –
        
        The list of change types that were applied.
        
        (string) –

Exceptions

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