DescribeAlgorithmCommand

Suggest an Edit

Describes the given algorithm.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { PersonalizeClient, DescribeAlgorithmCommand } from "@aws-sdk/client-personalize"; // ES Modules import
// const { PersonalizeClient, DescribeAlgorithmCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
const client = new PersonalizeClient(config);
const input = { // DescribeAlgorithmRequest
  algorithmArn: "STRING_VALUE", // required
};
const command = new DescribeAlgorithmCommand(input);
const response = await client.send(command);
// { // DescribeAlgorithmResponse
//   algorithm: { // Algorithm
//     name: "STRING_VALUE",
//     algorithmArn: "STRING_VALUE",
//     algorithmImage: { // AlgorithmImage
//       name: "STRING_VALUE",
//       dockerURI: "STRING_VALUE", // required
//     },
//     defaultHyperParameters: { // HyperParameters
//       "<keys>": "STRING_VALUE",
//     },
//     defaultHyperParameterRanges: { // DefaultHyperParameterRanges
//       integerHyperParameterRanges: [ // DefaultIntegerHyperParameterRanges
//         { // DefaultIntegerHyperParameterRange
//           name: "STRING_VALUE",
//           minValue: Number("int"),
//           maxValue: Number("int"),
//           isTunable: true || false,
//         },
//       ],
//       continuousHyperParameterRanges: [ // DefaultContinuousHyperParameterRanges
//         { // DefaultContinuousHyperParameterRange
//           name: "STRING_VALUE",
//           minValue: Number("double"),
//           maxValue: Number("double"),
//           isTunable: true || false,
//         },
//       ],
//       categoricalHyperParameterRanges: [ // DefaultCategoricalHyperParameterRanges
//         { // DefaultCategoricalHyperParameterRange
//           name: "STRING_VALUE",
//           values: [ // CategoricalValues
//             "STRING_VALUE",
//           ],
//           isTunable: true || false,
//         },
//       ],
//     },
//     defaultResourceConfig: { // ResourceConfig
//       "<keys>": "STRING_VALUE",
//     },
//     trainingInputMode: "STRING_VALUE",
//     roleArn: "STRING_VALUE",
//     creationDateTime: new Date("TIMESTAMP"),
//     lastUpdatedDateTime: new Date("TIMESTAMP"),
//   },
// };

DescribeAlgorithmCommand Input

See DescribeAlgorithmCommandInput for more details

Parameter
Type
Description
algorithmArn
Required
string | undefined

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

DescribeAlgorithmCommand Output

See DescribeAlgorithmCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
algorithm
Algorithm | undefined

A listing of the properties of the algorithm.

Throws

Name
Fault
Details
InvalidInputException
client

Provide a valid value for the field or parameter.

ResourceNotFoundException
client

Could not find the specified resource.

PersonalizeServiceException
Base exception class for all service exceptions from Personalize service.