- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeLaunchConfigurationTemplatesCommand
Lists all Launch Configuration Templates, filtered by Launch Configuration Template IDs
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { MgnClient, DescribeLaunchConfigurationTemplatesCommand } from "@aws-sdk/client-mgn"; // ES Modules import
// const { MgnClient, DescribeLaunchConfigurationTemplatesCommand } = require("@aws-sdk/client-mgn"); // CommonJS import
const client = new MgnClient(config);
const input = { // DescribeLaunchConfigurationTemplatesRequest
launchConfigurationTemplateIDs: [ // LaunchConfigurationTemplateIDs
"STRING_VALUE",
],
maxResults: Number("int"),
nextToken: "STRING_VALUE",
};
const command = new DescribeLaunchConfigurationTemplatesCommand(input);
const response = await client.send(command);
// { // DescribeLaunchConfigurationTemplatesResponse
// items: [ // LaunchConfigurationTemplates
// { // LaunchConfigurationTemplate
// launchConfigurationTemplateID: "STRING_VALUE", // required
// arn: "STRING_VALUE",
// postLaunchActions: { // PostLaunchActions
// deployment: "STRING_VALUE",
// s3LogBucket: "STRING_VALUE",
// s3OutputKeyPrefix: "STRING_VALUE",
// cloudWatchLogGroupName: "STRING_VALUE",
// ssmDocuments: [ // SsmDocuments
// { // SsmDocument
// actionName: "STRING_VALUE", // required
// ssmDocumentName: "STRING_VALUE", // required
// timeoutSeconds: Number("int"),
// mustSucceedForCutover: true || false,
// parameters: { // SsmDocumentParameters
// "<keys>": [ // SsmParameterStoreParameters
// { // SsmParameterStoreParameter
// parameterType: "STRING_VALUE", // required
// parameterName: "STRING_VALUE", // required
// },
// ],
// },
// externalParameters: { // SsmDocumentExternalParameters
// "<keys>": { // SsmExternalParameter Union: only one key present
// dynamicPath: "STRING_VALUE",
// },
// },
// },
// ],
// },
// enableMapAutoTagging: true || false,
// mapAutoTaggingMpeID: "STRING_VALUE",
// tags: { // TagsMap
// "<keys>": "STRING_VALUE",
// },
// ec2LaunchTemplateID: "STRING_VALUE",
// launchDisposition: "STRING_VALUE",
// targetInstanceTypeRightSizingMethod: "STRING_VALUE",
// copyPrivateIp: true || false,
// associatePublicIpAddress: true || false,
// copyTags: true || false,
// licensing: { // Licensing
// osByol: true || false,
// },
// bootMode: "STRING_VALUE",
// smallVolumeMaxSize: Number("long"),
// smallVolumeConf: { // LaunchTemplateDiskConf
// volumeType: "STRING_VALUE",
// iops: Number("long"),
// throughput: Number("long"),
// },
// largeVolumeConf: {
// volumeType: "STRING_VALUE",
// iops: Number("long"),
// throughput: Number("long"),
// },
// },
// ],
// nextToken: "STRING_VALUE",
// };
DescribeLaunchConfigurationTemplatesCommand Input
See DescribeLaunchConfigurationTemplatesCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
launchConfigurationTemplateIDs | string[] | undefined | Request to filter Launch Configuration Templates list by Launch Configuration Template ID. |
maxResults | number | undefined | Maximum results to be returned in DescribeLaunchConfigurationTemplates. |
nextToken | string | undefined | Next pagination token returned from DescribeLaunchConfigurationTemplates. |
DescribeLaunchConfigurationTemplatesCommand Output
See DescribeLaunchConfigurationTemplatesCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
items | LaunchConfigurationTemplate[] | undefined | List of items returned by DescribeLaunchConfigurationTemplates. |
nextToken | string | undefined | Next pagination token returned from DescribeLaunchConfigurationTemplates. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
ResourceNotFoundException | client | Resource not found exception. |
UninitializedAccountException | client | Uninitialized account exception. |
ValidationException | client | Validate exception. |
MgnServiceException | Base exception class for all service exceptions from Mgn service. |