collaboration_ml_input_channels

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

Overview

Name	collaboration_ml_input_channels
Type	Resource
Id	aws.cleanroomsml.collaboration_ml_input_channels

Fields

The following fields are returned by SELECT queries:

get_collaboration_ml_input_channel

Name	Datatype	Description
name	string	The name of the ML input channel. (pattern: <code>(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*</code>)
collaboration_identifier	string	The collaboration ID of the collaboration that contains the ML input channel. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
configured_model_algorithm_associations	array	The configured model algorithm associations that were used to create the ML input channel.
create_time	string (date-time)	The time at which the ML input channel was created.
creator_account_id	string	The account ID of the member who created the ML input channel. (pattern: <code>[0-9]{12}</code>)
description	string	The description of the ML input channel. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*</code>)
membership_identifier	string	The membership ID of the membership that contains the ML input channel. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
ml_input_channel_arn	string	The Amazon Resource Name (ARN) of the ML input channel. (pattern: <code>arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:membership/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/ml-input-channel/[-a-zA-Z0-9_/.]+</code>)
number_of_records	integer (int64)	The number of records in the ML input channel.
payer_configuration	object	Specifies which member accounts are responsible for paying for compute and synthetic data generation costs in a Clean Rooms ML collaboration.
privacy_budgets	object	Returns the privacy budgets that control access to this Clean Rooms ML input channel. Use these budgets to monitor and limit resource consumption over specified time periods.
retention_in_days	integer	The number of days to retain the data for the ML input channel.
status	string	The status of the ML input channel. (CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED, ACTIVE, DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED, INACTIVE)
status_details	object	Details about the status of a resource.
synthetic_data_configuration	object	The synthetic data configuration for this ML input channel, including parameters for generating privacy-preserving synthetic data and evaluation scores for measuring the privacy of the generated data.
update_time	string (date-time)	The most recent time at which the ML input channel was updated.

list_collaboration_ml_input_channels

Name	Datatype	Description
name	string	The name of the ML input channel. (pattern: <code>(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*</code>)
collaboration_identifier	string	The collaboration ID of the collaboration that contains the ML input channel. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
configured_model_algorithm_associations	array	The associated configured model algorithms used to create the ML input channel.
create_time	string (date-time)	The time at which the ML input channel was created.
creator_account_id	string	The account ID of the member who created the ML input channel. (pattern: <code>[0-9]{12}</code>)
description	string	The description of the ML input channel. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*</code>)
membership_identifier	string	The membership ID of the membership that contains the ML input channel. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
ml_input_channel_arn	string	The Amazon Resource Name (ARN) of the ML input channel. (pattern: <code>arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:membership/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/ml-input-channel/[-a-zA-Z0-9_/.]+</code>)
payer_configuration	object	Specifies which member accounts are responsible for paying for compute and synthetic data generation costs in a Clean Rooms ML collaboration.
status	string	The status of the ML input channel. (CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED, ACTIVE, DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED, INACTIVE)
update_time	string (date-time)	The most recent time at which the ML input channel was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_collaboration_ml_input_channel	select	ml_input_channel_arn, collaboration_identifier, region		Returns information about a specific ML input channel in a collaboration.
list_collaboration_ml_input_channels	select	collaboration_identifier, region	nextToken, maxResults	Returns a list of the ML input channels in a collaboration.

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
collaboration_identifier	string	The collaboration ID of the collaboration that contains the ML input channels that you want to list.
ml_input_channel_arn	string	The Amazon Resource Name (ARN) of the ML input channel that you want to get.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return.
nextToken	string	The token value retrieved from a previous call to access the next page of results.

SELECT examples

get_collaboration_ml_input_channel

Returns information about a specific ML input channel in a collaboration.

SELECT
name,
collaboration_identifier,
configured_model_algorithm_associations,
create_time,
creator_account_id,
description,
membership_identifier,
ml_input_channel_arn,
number_of_records,
payer_configuration,
privacy_budgets,
retention_in_days,
status,
status_details,
synthetic_data_configuration,
update_time
FROM aws.cleanroomsml.collaboration_ml_input_channels
WHERE ml_input_channel_arn = '{{ ml_input_channel_arn }}' -- required
AND collaboration_identifier = '{{ collaboration_identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_collaboration_ml_input_channels

Returns a list of the ML input channels in a collaboration.

SELECT
name,
collaboration_identifier,
configured_model_algorithm_associations,
create_time,
creator_account_id,
description,
membership_identifier,
ml_input_channel_arn,
payer_configuration,
status,
update_time
FROM aws.cleanroomsml.collaboration_ml_input_channels
WHERE collaboration_identifier = '{{ collaboration_identifier }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;