Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetConfiguredModelAlgorithm

Returns information about a configured model algorithm.

Request Syntax


GET /configured-model-algorithms/configuredModelAlgorithmArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

configuredModelAlgorithmArn

The Amazon Resource Name (ARN) of the configured model algorithm that you want to return information about.

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:configured-model-algorithm/[-a-zA-Z0-9_/.]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "configuredModelAlgorithmArn": "string",
   "createTime": "string",
   "description": "string",
   "inferenceContainerConfig": { 
      "imageUri": "string"
   },
   "kmsKeyArn": "string",
   "name": "string",
   "roleArn": "string",
   "tags": { 
      "string" : "string" 
   },
   "trainingContainerConfig": { 
      "arguments": [ "string" ],
      "entrypoint": [ "string" ],
      "imageUri": "string",
      "metricDefinitions": [ 
         { 
            "name": "string",
            "regex": "string"
         }
      ]
   },
   "updateTime": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

configuredModelAlgorithmArn

The Amazon Resource Name (ARN) of the configured model algorithm.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:configured-model-algorithm/[-a-zA-Z0-9_/.]+

createTime

The time at which the configured model algorithm was created.

Type: Timestamp

description

The description of the configured model algorithm.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*

inferenceContainerConfig

Configuration information for the inference container.

Type: InferenceContainerConfig object

kmsKeyArn

The Amazon Resource Name (ARN) of the AWS KMS key. This key is used to encrypt and decrypt customer-owned data in the configured ML model and associated data.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws[-a-z]*:kms:[-a-z0-9]+:[0-9]{12}:key/.+

name

The name of the configured model algorithm.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: (?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*

roleArn

The Amazon Resource Name (ARN) of the service role that was used to create the configured model algorithm.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws[-a-z]*:iam::[0-9]{12}:role/.+

tags

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.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

trainingContainerConfig

The configuration information of the training container for the configured model algorithm.

Type: ContainerConfig object

updateTime

The most recent time at which the configured model algorithm was updated.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ResourceNotFoundException

The resource you are requesting does not exist.

HTTP Status Code: 404

ValidationException

The request parameters for this request are incorrect.

HTTP Status Code: 400