DescribeLayersCommand

Requests a description of one or more layers in a specified stack.

This call accepts only one resource-identifying parameter.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions .

Example Syntax

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

import { OpsWorksClient, DescribeLayersCommand } from "@aws-sdk/client-opsworks"; // ES Modules import
// const { OpsWorksClient, DescribeLayersCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import
const client = new OpsWorksClient(config);
const input = { // DescribeLayersRequest
  StackId: "STRING_VALUE",
  LayerIds: [ // Strings
    "STRING_VALUE",
  ],
};
const command = new DescribeLayersCommand(input);
const response = await client.send(command);
// { // DescribeLayersResult
//   Layers: [ // Layers
//     { // Layer
//       Arn: "STRING_VALUE",
//       StackId: "STRING_VALUE",
//       LayerId: "STRING_VALUE",
//       Type: "aws-flow-ruby" || "ecs-cluster" || "java-app" || "lb" || "web" || "php-app" || "rails-app" || "nodejs-app" || "memcached" || "db-master" || "monitoring-master" || "custom",
//       Name: "STRING_VALUE",
//       Shortname: "STRING_VALUE",
//       Attributes: { // LayerAttributes
//         "<keys>": "STRING_VALUE",
//       },
//       CloudWatchLogsConfiguration: { // CloudWatchLogsConfiguration
//         Enabled: true || false,
//         LogStreams: [ // CloudWatchLogsLogStreams
//           { // CloudWatchLogsLogStream
//             LogGroupName: "STRING_VALUE",
//             DatetimeFormat: "STRING_VALUE",
//             TimeZone: "LOCAL" || "UTC",
//             File: "STRING_VALUE",
//             FileFingerprintLines: "STRING_VALUE",
//             MultiLineStartPattern: "STRING_VALUE",
//             InitialPosition: "start_of_file" || "end_of_file",
//             Encoding: "ascii" || "big5" || "big5hkscs" || "cp037" || "cp424" || "cp437" || "cp500" || "cp720" || "cp737" || "cp775" || "cp850" || "cp852" || "cp855" || "cp856" || "cp857" || "cp858" || "cp860" || "cp861" || "cp862" || "cp863" || "cp864" || "cp865" || "cp866" || "cp869" || "cp874" || "cp875" || "cp932" || "cp949" || "cp950" || "cp1006" || "cp1026" || "cp1140" || "cp1250" || "cp1251" || "cp1252" || "cp1253" || "cp1254" || "cp1255" || "cp1256" || "cp1257" || "cp1258" || "euc_jp" || "euc_jis_2004" || "euc_jisx0213" || "euc_kr" || "gb2312" || "gbk" || "gb18030" || "hz" || "iso2022_jp" || "iso2022_jp_1" || "iso2022_jp_2" || "iso2022_jp_2004" || "iso2022_jp_3" || "iso2022_jp_ext" || "iso2022_kr" || "latin_1" || "iso8859_2" || "iso8859_3" || "iso8859_4" || "iso8859_5" || "iso8859_6" || "iso8859_7" || "iso8859_8" || "iso8859_9" || "iso8859_10" || "iso8859_13" || "iso8859_14" || "iso8859_15" || "iso8859_16" || "johab" || "koi8_r" || "koi8_u" || "mac_cyrillic" || "mac_greek" || "mac_iceland" || "mac_latin2" || "mac_roman" || "mac_turkish" || "ptcp154" || "shift_jis" || "shift_jis_2004" || "shift_jisx0213" || "utf_32" || "utf_32_be" || "utf_32_le" || "utf_16" || "utf_16_be" || "utf_16_le" || "utf_7" || "utf_8" || "utf_8_sig",
//             BufferDuration: Number("int"),
//             BatchCount: Number("int"),
//             BatchSize: Number("int"),
//           },
//         ],
//       },
//       CustomInstanceProfileArn: "STRING_VALUE",
//       CustomJson: "STRING_VALUE",
//       CustomSecurityGroupIds: [ // Strings
//         "STRING_VALUE",
//       ],
//       DefaultSecurityGroupNames: [
//         "STRING_VALUE",
//       ],
//       Packages: [
//         "STRING_VALUE",
//       ],
//       VolumeConfigurations: [ // VolumeConfigurations
//         { // VolumeConfiguration
//           MountPoint: "STRING_VALUE", // required
//           RaidLevel: Number("int"),
//           NumberOfDisks: Number("int"), // required
//           Size: Number("int"), // required
//           VolumeType: "STRING_VALUE",
//           Iops: Number("int"),
//           Encrypted: true || false,
//         },
//       ],
//       EnableAutoHealing: true || false,
//       AutoAssignElasticIps: true || false,
//       AutoAssignPublicIps: true || false,
//       DefaultRecipes: { // Recipes
//         Setup: [
//           "STRING_VALUE",
//         ],
//         Configure: [
//           "STRING_VALUE",
//         ],
//         Deploy: "<Strings>",
//         Undeploy: "<Strings>",
//         Shutdown: "<Strings>",
//       },
//       CustomRecipes: {
//         Setup: "<Strings>",
//         Configure: "<Strings>",
//         Deploy: "<Strings>",
//         Undeploy: "<Strings>",
//         Shutdown: "<Strings>",
//       },
//       CreatedAt: "STRING_VALUE",
//       InstallUpdatesOnBoot: true || false,
//       UseEbsOptimizedInstances: true || false,
//       LifecycleEventConfiguration: { // LifecycleEventConfiguration
//         Shutdown: { // ShutdownEventConfiguration
//           ExecutionTimeout: Number("int"),
//           DelayUntilElbConnectionsDrained: true || false,
//         },
//       },
//     },
//   ],
// };

DescribeLayersCommand Input

See DescribeLayersCommandInput for more details

Parameter
Type
Description
LayerIds
string[] | undefined

An array of layer IDs that specify the layers to be described. If you omit this parameter, DescribeLayers returns a description of every layer in the specified stack.

StackId
string | undefined

The stack ID.

DescribeLayersCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Layers
Layer[] | undefined

An array of Layer objects that describe the layers.

Throws

Name
Fault
Details
ResourceNotFoundException
client

Indicates that a resource was not found.

ValidationException
client

Indicates that a request was not valid.

OpsWorksServiceException
Base exception class for all service exceptions from OpsWorks service.