collaboration_change_requests

Creates, updates, deletes, gets or lists a collaboration_change_requests resource.

Overview

Name	collaboration_change_requests
Type	Resource
Id	aws.cleanrooms.collaboration_change_requests

Fields

The following fields are returned by SELECT queries:

get_collaboration_change_request

Name	Datatype	Description
id	string	The unique identifier for the change request. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
approvals	object	A list of approval details from collaboration members, including approval status and multi-party approval workflow information.
changes	array	The list of changes specified in this change request.
collaboration_id	string	The unique identifier for the collaboration being modified. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
create_time	string (date-time)	The time when the change request was created.
is_auto_approved	boolean	Whether the change request was automatically approved based on the collaboration's auto-approval settings.
status	string	The current status of the change request. Valid values are PENDING, APPROVED, DENIED, COMMITTED, and CANCELLED. (PENDING, APPROVED, CANCELLED, DENIED, COMMITTED)
update_time	string (date-time)	The time when the change request was last updated.

list_collaboration_change_requests

Name	Datatype	Description
id	string	The unique identifier for the change request. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
approvals	object	Summary of approval statuses from all collaboration members for this change request.
changes	array	Summary of the changes in this change request.
collaboration_id	string	The unique identifier for the collaboration. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
create_time	string (date-time)	The time when the change request was created.
is_auto_approved	boolean	Whether the change request was automatically approved.
status	string	The current status of the change request. (PENDING, APPROVED, CANCELLED, DENIED, COMMITTED)
update_time	string (date-time)	The time when the change request was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_collaboration_change_request	select	collaboration_identifier, change_request_identifier, region		Retrieves detailed information about a specific collaboration change request.
list_collaboration_change_requests	select	collaboration_identifier, region	status, nextToken, maxResults	Lists all change requests for a collaboration with pagination support. Returns change requests sorted by creation time.
create_collaboration_change_request	insert	collaboration_identifier, region, changes		Creates a new change request to modify an existing collaboration. This enables post-creation modifications to collaborations through a structured API-driven approach.
update_collaboration_change_request	update	collaboration_identifier, change_request_identifier, region, action		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
change_request_identifier	string	The unique identifier of the specific change request to be updated within the collaboration.
collaboration_identifier	string	The unique identifier of the collaboration that contains the change request to be updated.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results that are returned for an API request call.
nextToken	string	The pagination token that's used to fetch the next set of results.
status	string	A filter to only return change requests with the specified status.

SELECT examples

get_collaboration_change_request

Retrieves detailed information about a specific collaboration change request.

SELECT
id,
approvals,
changes,
collaboration_id,
create_time,
is_auto_approved,
status,
update_time
FROM aws.cleanrooms.collaboration_change_requests
WHERE collaboration_identifier = '{{ collaboration_identifier }}' -- required
AND change_request_identifier = '{{ change_request_identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_collaboration_change_requests

Lists all change requests for a collaboration with pagination support. Returns change requests sorted by creation time.

SELECT
id,
approvals,
changes,
collaboration_id,
create_time,
is_auto_approved,
status,
update_time
FROM aws.cleanrooms.collaboration_change_requests
WHERE collaboration_identifier = '{{ collaboration_identifier }}' -- required
AND region = '{{ region }}' -- required
AND status = '{{ status }}'
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_collaboration_change_request

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

INSERT INTO aws.cleanrooms.collaboration_change_requests (
changes,
collaboration_identifier,
region
)
SELECT 
'{{ changes }}' /* required */,
'{{ collaboration_identifier }}',
'{{ region }}'
RETURNING
collaboration_change_request
;

Manifest

# Description fields are for documentation purposes
- name: collaboration_change_requests
props:
  - name: collaboration_identifier
    value: "{{ collaboration_identifier }}"
    description: Required parameter for the collaboration_change_requests resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the collaboration_change_requests resource.
  - name: changes
    value:
      - specificationType: "{{ specificationType }}"
        specification:
          member:
            accountId: "{{ accountId }}"
            memberAbilities:
              - "{{ memberAbilities }}"
            mlMemberAbilities:
              customMLMemberAbilities:
                - "{{ customMLMemberAbilities }}"
            paymentConfiguration:
              queryCompute:
                isResponsible: {{ isResponsible }}
              machineLearning:
                modelTraining: "{{ modelTraining }}"
                modelInference: "{{ modelInference }}"
                syntheticDataGeneration: "{{ syntheticDataGeneration }}"
              jobCompute:
                isResponsible: {{ isResponsible }}
            displayName: "{{ displayName }}"
          collaboration:
            autoApprovedChangeTypes:
              - "{{ autoApprovedChangeTypes }}"

UPDATE examples

update_collaboration_change_request

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.

UPDATE aws.cleanrooms.collaboration_change_requests
SET 
action = '{{ action }}'
WHERE 
collaboration_identifier = '{{ collaboration_identifier }}' --required
AND change_request_identifier = '{{ change_request_identifier }}' --required
AND region = '{{ region }}' --required
AND action = '{{ action }}' --required
RETURNING
collaboration_change_request;