DescribeSolutionCommand

Suggest an Edit

Describes a solution. For more information on solutions, see CreateSolution .

Example Syntax

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

import { PersonalizeClient, DescribeSolutionCommand } from "@aws-sdk/client-personalize"; // ES Modules import
// const { PersonalizeClient, DescribeSolutionCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
const client = new PersonalizeClient(config);
const input = { // DescribeSolutionRequest
  solutionArn: "STRING_VALUE", // required
};
const command = new DescribeSolutionCommand(input);
const response = await client.send(command);
// { // DescribeSolutionResponse
//   solution: { // Solution
//     name: "STRING_VALUE",
//     solutionArn: "STRING_VALUE",
//     performHPO: true || false,
//     performAutoML: true || false,
//     performAutoTraining: true || false,
//     recipeArn: "STRING_VALUE",
//     datasetGroupArn: "STRING_VALUE",
//     eventType: "STRING_VALUE",
//     solutionConfig: { // SolutionConfig
//       eventValueThreshold: "STRING_VALUE",
//       hpoConfig: { // HPOConfig
//         hpoObjective: { // HPOObjective
//           type: "STRING_VALUE",
//           metricName: "STRING_VALUE",
//           metricRegex: "STRING_VALUE",
//         },
//         hpoResourceConfig: { // HPOResourceConfig
//           maxNumberOfTrainingJobs: "STRING_VALUE",
//           maxParallelTrainingJobs: "STRING_VALUE",
//         },
//         algorithmHyperParameterRanges: { // HyperParameterRanges
//           integerHyperParameterRanges: [ // IntegerHyperParameterRanges
//             { // IntegerHyperParameterRange
//               name: "STRING_VALUE",
//               minValue: Number("int"),
//               maxValue: Number("int"),
//             },
//           ],
//           continuousHyperParameterRanges: [ // ContinuousHyperParameterRanges
//             { // ContinuousHyperParameterRange
//               name: "STRING_VALUE",
//               minValue: Number("double"),
//               maxValue: Number("double"),
//             },
//           ],
//           categoricalHyperParameterRanges: [ // CategoricalHyperParameterRanges
//             { // CategoricalHyperParameterRange
//               name: "STRING_VALUE",
//               values: [ // CategoricalValues
//                 "STRING_VALUE",
//               ],
//             },
//           ],
//         },
//       },
//       algorithmHyperParameters: { // HyperParameters
//         "<keys>": "STRING_VALUE",
//       },
//       featureTransformationParameters: { // FeatureTransformationParameters
//         "<keys>": "STRING_VALUE",
//       },
//       autoMLConfig: { // AutoMLConfig
//         metricName: "STRING_VALUE",
//         recipeList: [ // ArnList
//           "STRING_VALUE",
//         ],
//       },
//       eventsConfig: { // EventsConfig
//         eventParametersList: [ // EventParametersList
//           { // EventParameters
//             eventType: "STRING_VALUE",
//             eventValueThreshold: Number("double"),
//             weight: Number("double"),
//           },
//         ],
//       },
//       optimizationObjective: { // OptimizationObjective
//         itemAttribute: "STRING_VALUE",
//         objectiveSensitivity: "LOW" || "MEDIUM" || "HIGH" || "OFF",
//       },
//       trainingDataConfig: { // TrainingDataConfig
//         excludedDatasetColumns: { // ExcludedDatasetColumns
//           "<keys>": [ // ColumnNamesList
//             "STRING_VALUE",
//           ],
//         },
//       },
//       autoTrainingConfig: { // AutoTrainingConfig
//         schedulingExpression: "STRING_VALUE",
//       },
//     },
//     autoMLResult: { // AutoMLResult
//       bestRecipeArn: "STRING_VALUE",
//     },
//     status: "STRING_VALUE",
//     creationDateTime: new Date("TIMESTAMP"),
//     lastUpdatedDateTime: new Date("TIMESTAMP"),
//     latestSolutionVersion: { // SolutionVersionSummary
//       solutionVersionArn: "STRING_VALUE",
//       status: "STRING_VALUE",
//       trainingMode: "FULL" || "UPDATE" || "AUTOTRAIN",
//       trainingType: "AUTOMATIC" || "MANUAL",
//       creationDateTime: new Date("TIMESTAMP"),
//       lastUpdatedDateTime: new Date("TIMESTAMP"),
//       failureReason: "STRING_VALUE",
//     },
//     latestSolutionUpdate: { // SolutionUpdateSummary
//       solutionUpdateConfig: { // SolutionUpdateConfig
//         autoTrainingConfig: {
//           schedulingExpression: "STRING_VALUE",
//         },
//         eventsConfig: {
//           eventParametersList: [
//             {
//               eventType: "STRING_VALUE",
//               eventValueThreshold: Number("double"),
//               weight: Number("double"),
//             },
//           ],
//         },
//       },
//       status: "STRING_VALUE",
//       performAutoTraining: true || false,
//       creationDateTime: new Date("TIMESTAMP"),
//       lastUpdatedDateTime: new Date("TIMESTAMP"),
//       failureReason: "STRING_VALUE",
//     },
//   },
// };

DescribeSolutionCommand Input

See DescribeSolutionCommandInput for more details

Parameter
Type
Description
solutionArn
Required
string | undefined

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

DescribeSolutionCommand Output

See DescribeSolutionCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
solution
Solution | undefined

An object that describes the solution.

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.