configured_model_algorithm_associations

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

Overview

Name	configured_model_algorithm_associations
Type	Resource
Id	aws.cleanroomsml.configured_model_algorithm_associations

Fields

The following fields are returned by SELECT queries:

get_configured_model_algorithm_association

Name	Datatype	Description
name	string	The name of the configured model algorithm association. (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 configured model algorithm association. (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_arn	string	The Amazon Resource Name (ARN) of the configured model algorithm that was associated to the collaboration. (pattern: <code>arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:configured-model-algorithm/[-a-zA-Z0-9_/.]+</code>)
configured_model_algorithm_association_arn	string	The Amazon Resource Name (ARN) of the configured model algorithm association. (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}/configured-model-algorithm-association/[-a-zA-Z0-9_/.]+</code>)
create_time	string (date-time)	The time at which the configured model algorithm association was created.
description	string	The description of the configured model algorithm association. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*</code>)
membership_identifier	string	The membership ID of the member that created the configured model algorithm association. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
privacy_configuration	object	Information about the privacy configuration for a configured model algorithm association.
tags	object	The optional metadata that you applied to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. The following basic restrictions apply to tags: Maximum number of tags per resource - 50. For each resource, each tag key must be unique, and each tag key can have only one value. Maximum key length - 128 Unicode characters in UTF-8. Maximum value length - 256 Unicode characters in UTF-8. If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case sensitive. Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
update_time	string (date-time)	The most recent time at which the configured model algorithm association was updated.

list_configured_model_algorithm_associations

Name	Datatype	Description
name	string	The name of the configured model algorithm association. (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 configured model algorithm association. (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_arn	string	The Amazon Resource Name (ARN) of the configured model algorithm that is being associated. (pattern: <code>arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:configured-model-algorithm/[-a-zA-Z0-9_/.]+</code>)
configured_model_algorithm_association_arn	string	The Amazon Resource Name (ARN) of the configured model algorithm association. (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}/configured-model-algorithm-association/[-a-zA-Z0-9_/.]+</code>)
create_time	string (date-time)	The time at which the configured model algorithm association was created.
description	string	The description of the configured model algorithm association. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*</code>)
membership_identifier	string	The membership ID of the member that created the configured model algorithm association. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
update_time	string (date-time)	The most recent time at which the configured model algorithm association was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_configured_model_algorithm_association	select	configured_model_algorithm_association_arn, membership_identifier, region		Returns information about a configured model algorithm association.
list_configured_model_algorithm_associations	select	membership_identifier, region	nextToken, maxResults	Returns a list of configured model algorithm associations.
create_configured_model_algorithm_association	insert	membership_identifier, region, configuredModelAlgorithmArn, name		Associates a configured model algorithm to a collaboration for use by any member of the collaboration.
delete_configured_model_algorithm_association	delete	configured_model_algorithm_association_arn, membership_identifier, region		Deletes a configured model algorithm association.

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
configured_model_algorithm_association_arn	string	The Amazon Resource Name (ARN) of the configured model algorithm association that you want to delete.
membership_identifier	string	The membership ID of the member that is deleting the configured model algorithm association.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum size of the results that is returned per call.
nextToken	string	The token value retrieved from a previous call to access the next page of results.

SELECT examples

get_configured_model_algorithm_association

Returns information about a configured model algorithm association.

SELECT
name,
collaboration_identifier,
configured_model_algorithm_arn,
configured_model_algorithm_association_arn,
create_time,
description,
membership_identifier,
privacy_configuration,
tags,
update_time
FROM aws.cleanroomsml.configured_model_algorithm_associations
WHERE configured_model_algorithm_association_arn = '{{ configured_model_algorithm_association_arn }}' -- required
AND membership_identifier = '{{ membership_identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_configured_model_algorithm_associations

Returns a list of configured model algorithm associations.

SELECT
name,
collaboration_identifier,
configured_model_algorithm_arn,
configured_model_algorithm_association_arn,
create_time,
description,
membership_identifier,
update_time
FROM aws.cleanroomsml.configured_model_algorithm_associations
WHERE membership_identifier = '{{ membership_identifier }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_configured_model_algorithm_association

Associates a configured model algorithm to a collaboration for use by any member of the collaboration.

INSERT INTO aws.cleanroomsml.configured_model_algorithm_associations (
configuredModelAlgorithmArn,
name,
description,
privacyConfiguration,
tags,
membership_identifier,
region
)
SELECT 
'{{ configuredModelAlgorithmArn }}' /* required */,
'{{ name }}' /* required */,
'{{ description }}',
'{{ privacyConfiguration }}',
'{{ tags }}',
'{{ membership_identifier }}',
'{{ region }}'
RETURNING
configured_model_algorithm_association_arn
;

Manifest

# Description fields are for documentation purposes
- name: configured_model_algorithm_associations
props:
  - name: membership_identifier
    value: "{{ membership_identifier }}"
    description: Required parameter for the configured_model_algorithm_associations resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the configured_model_algorithm_associations resource.
  - name: configuredModelAlgorithmArn
    value: "{{ configuredModelAlgorithmArn }}"
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: privacyConfiguration
    description: |
      Information about the privacy configuration for a configured model algorithm association.
    value:
      policies:
        trainedModels:
          containerLogs:
            - allowedAccountIds: "{{ allowedAccountIds }}"
              filterPattern: "{{ filterPattern }}"
              logType: "{{ logType }}"
              logRedactionConfiguration:
                entitiesToRedact: "{{ entitiesToRedact }}"
                customEntityConfig: "{{ customEntityConfig }}"
          containerMetrics:
            noiseLevel: "{{ noiseLevel }}"
          maxArtifactSize:
            unit: "{{ unit }}"
            value: {{ value }}
        trainedModelExports:
          maxSize:
            unit: "{{ unit }}"
            value: {{ value }}
          filesToExport:
            - "{{ filesToExport }}"
        trainedModelInferenceJobs:
          containerLogs:
            - allowedAccountIds: "{{ allowedAccountIds }}"
              filterPattern: "{{ filterPattern }}"
              logType: "{{ logType }}"
              logRedactionConfiguration:
                entitiesToRedact: "{{ entitiesToRedact }}"
                customEntityConfig: "{{ customEntityConfig }}"
          maxOutputSize:
            unit: "{{ unit }}"
            value: {{ value }}
  - name: tags
    value: "{{ tags }}"

DELETE examples

delete_configured_model_algorithm_association

Deletes a configured model algorithm association.

DELETE FROM aws.cleanroomsml.configured_model_algorithm_associations
WHERE configured_model_algorithm_association_arn = '{{ configured_model_algorithm_association_arn }}' --required
AND membership_identifier = '{{ membership_identifier }}' --required
AND region = '{{ region }}' --required
;