configured_model_algorithms

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

Overview

Name	configured_model_algorithms
Type	Resource
Id	aws.cleanroomsml.configured_model_algorithms

Fields

The following fields are returned by SELECT queries:

get_configured_model_algorithm

Name	Datatype	Description
name	string	The name of the configured model algorithm. (pattern: <code>(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*</code>)
configured_model_algorithm_arn	string	The Amazon Resource Name (ARN) of the configured model algorithm. (pattern: <code>arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:configured-model-algorithm/[-a-zA-Z0-9_/.]+</code>)
create_time	string (date-time)	The time at which the configured model algorithm was created.
description	string	The description of the configured model algorithm. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*</code>)
inference_container_config	object	Provides configuration information for the inference container.
kms_key_arn	string	The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the configured ML model and associated data. (pattern: <code>arn:aws[-a-z]*:kms:[-a-z0-9]+:[0-9]{12}:key/.+</code>)
role_arn	string	The Amazon Resource Name (ARN) of the service role that was used to create the configured model algorithm. (pattern: <code>arn:aws[-a-z]*:iam::[0-9]{12}:role/.+</code>)
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.
training_container_config	object	Provides configuration information for the dockerized container where the model algorithm is stored.
update_time	string (date-time)	The most recent time at which the configured model algorithm was updated.

list_configured_model_algorithms

Name	Datatype	Description
name	string	The name of the configured model algorithm. (pattern: <code>(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*</code>)
configured_model_algorithm_arn	string	The Amazon Resource Name (ARN) of the configured model algorithm. (pattern: <code>arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:configured-model-algorithm/[-a-zA-Z0-9_/.]+</code>)
create_time	string (date-time)	The time at which the configured model algorithm was created.
description	string	The description of the configured model algorithm. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*</code>)
update_time	string (date-time)	The most recent time at which the configured model algorithm was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_configured_model_algorithm	select	configured_model_algorithm_arn, region		Returns information about a configured model algorithm.
list_configured_model_algorithms	select	region	nextToken, maxResults	Returns a list of configured model algorithms.
create_configured_model_algorithm	insert	region, name, roleArn		Creates a configured model algorithm using a container image stored in an ECR repository.
delete_configured_model_algorithm	delete	configured_model_algorithm_arn, region		Deletes a configured model algorithm.

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_arn	string	The Amazon Resource Name (ARN) of the configured model algorithm that you want to delete.
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

Returns information about a configured model algorithm.

SELECT
name,
configured_model_algorithm_arn,
create_time,
description,
inference_container_config,
kms_key_arn,
role_arn,
tags,
training_container_config,
update_time
FROM aws.cleanroomsml.configured_model_algorithms
WHERE configured_model_algorithm_arn = '{{ configured_model_algorithm_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_configured_model_algorithms

Returns a list of configured model algorithms.

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

INSERT examples

create_configured_model_algorithm

Creates a configured model algorithm using a container image stored in an ECR repository.

INSERT INTO aws.cleanroomsml.configured_model_algorithms (
name,
description,
roleArn,
trainingContainerConfig,
inferenceContainerConfig,
tags,
kmsKeyArn,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ roleArn }}' /* required */,
'{{ trainingContainerConfig }}',
'{{ inferenceContainerConfig }}',
'{{ tags }}',
'{{ kmsKeyArn }}',
'{{ region }}'
RETURNING
configured_model_algorithm_arn
;

Manifest

# Description fields are for documentation purposes
- name: configured_model_algorithms
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the configured_model_algorithms resource.
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: roleArn
    value: "{{ roleArn }}"
  - name: trainingContainerConfig
    description: |
      Provides configuration information for the dockerized container where the model algorithm is stored.
    value:
      imageUri: "{{ imageUri }}"
      entrypoint:
        - "{{ entrypoint }}"
      arguments:
        - "{{ arguments }}"
      metricDefinitions:
        - name: "{{ name }}"
          regex: "{{ regex }}"
  - name: inferenceContainerConfig
    description: |
      Provides configuration information for the inference container.
    value:
      imageUri: "{{ imageUri }}"
  - name: tags
    value: "{{ tags }}"
  - name: kmsKeyArn
    value: "{{ kmsKeyArn }}"

DELETE examples

delete_configured_model_algorithm

Deletes a configured model algorithm.

DELETE FROM aws.cleanroomsml.configured_model_algorithms
WHERE configured_model_algorithm_arn = '{{ configured_model_algorithm_arn }}' --required
AND region = '{{ region }}' --required
;