CreateTemplateCommand

Suggest an Edit

Creates a migration workflow template.

Example Syntax

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

import { MigrationHubOrchestratorClient, CreateTemplateCommand } from "@aws-sdk/client-migrationhuborchestrator"; // ES Modules import
// const { MigrationHubOrchestratorClient, CreateTemplateCommand } = require("@aws-sdk/client-migrationhuborchestrator"); // CommonJS import
const client = new MigrationHubOrchestratorClient(config);
const input = { // CreateTemplateRequest
  templateName: "STRING_VALUE", // required
  templateDescription: "STRING_VALUE",
  templateSource: { // TemplateSource Union: only one key present
    workflowId: "STRING_VALUE",
  },
  clientToken: "STRING_VALUE",
  tags: { // TagMap
    "<keys>": "STRING_VALUE",
  },
};
const command = new CreateTemplateCommand(input);
const response = await client.send(command);
// { // CreateTemplateResponse
//   templateId: "STRING_VALUE",
//   templateArn: "STRING_VALUE",
//   tags: { // StringMap
//     "<keys>": "STRING_VALUE",
//   },
// };

CreateTemplateCommand Input

See CreateTemplateCommandInput for more details

Parameter
Type
Description
templateName
Required
string | undefined

The name of the migration workflow template.

templateSource
Required
TemplateSource | undefined

The source of the migration workflow template.

clientToken
string | undefined

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Idempotency  in the Smithy documentation.

tags
Record<string, string> | undefined

The tags to add to the migration workflow template.

templateDescription
string | undefined

A description of the migration workflow template.

CreateTemplateCommand Output

See CreateTemplateCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
tags
Record<string, string> | undefined

The tags added to the migration workflow template.

templateArn
string | undefined

The Amazon Resource Name (ARN) of the migration workflow template. The format for an Migration Hub Orchestrator template ARN is arn:aws:migrationhub-orchestrator:region:account:template/template-abcd1234. For more information about ARNs, see Amazon Resource Names (ARNs)  in the AWS General Reference.

templateId
string | undefined

The ID of the migration workflow template.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

ConflictException
client

This exception is thrown when an attempt to update or delete a resource would cause an inconsistent state.

InternalServerException
server

An internal error has occurred.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input fails to satisfy the constraints specified by an AWS service.

MigrationHubOrchestratorServiceException
Base exception class for all service exceptions from MigrationHubOrchestrator service.