Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeAlgorithm

Describes the given algorithm.

Request Syntax


{
   "algorithmArn": "string"
}

Request Parameters

The request accepts the following data in JSON format.

algorithmArn

The Amazon Resource Name (ARN) of the algorithm to describe.

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:([a-z\d-]+):personalize:.*:.*:.+

Required: Yes

Response Syntax


{
   "algorithm": { 
      "algorithmArn": "string",
      "algorithmImage": { 
         "dockerURI": "string",
         "name": "string"
      },
      "creationDateTime": number,
      "defaultHyperParameterRanges": { 
         "categoricalHyperParameterRanges": [ 
            { 
               "isTunable": boolean,
               "name": "string",
               "values": [ "string" ]
            }
         ],
         "continuousHyperParameterRanges": [ 
            { 
               "isTunable": boolean,
               "maxValue": number,
               "minValue": number,
               "name": "string"
            }
         ],
         "integerHyperParameterRanges": [ 
            { 
               "isTunable": boolean,
               "maxValue": number,
               "minValue": number,
               "name": "string"
            }
         ]
      },
      "defaultHyperParameters": { 
         "string" : "string" 
      },
      "defaultResourceConfig": { 
         "string" : "string" 
      },
      "lastUpdatedDateTime": number,
      "name": "string",
      "roleArn": "string",
      "trainingInputMode": "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.

algorithm

A listing of the properties of the algorithm.

Type: Algorithm object

Errors

InvalidInputException

Provide a valid value for the field or parameter.

HTTP Status Code: 400

ResourceNotFoundException

Could not find the specified resource.

HTTP Status Code: 400