DescribeAppsCommand

Suggest an Edit

Requests a description of a specified set of apps.

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, DescribeAppsCommand } from "@aws-sdk/client-opsworks"; // ES Modules import
// const { OpsWorksClient, DescribeAppsCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import
const client = new OpsWorksClient(config);
const input = { // DescribeAppsRequest
  StackId: "STRING_VALUE",
  AppIds: [ // Strings
    "STRING_VALUE",
  ],
};
const command = new DescribeAppsCommand(input);
const response = await client.send(command);
// { // DescribeAppsResult
//   Apps: [ // Apps
//     { // App
//       AppId: "STRING_VALUE",
//       StackId: "STRING_VALUE",
//       Shortname: "STRING_VALUE",
//       Name: "STRING_VALUE",
//       Description: "STRING_VALUE",
//       DataSources: [ // DataSources
//         { // DataSource
//           Type: "STRING_VALUE",
//           Arn: "STRING_VALUE",
//           DatabaseName: "STRING_VALUE",
//         },
//       ],
//       Type: "aws-flow-ruby" || "java" || "rails" || "php" || "nodejs" || "static" || "other",
//       AppSource: { // Source
//         Type: "git" || "svn" || "archive" || "s3",
//         Url: "STRING_VALUE",
//         Username: "STRING_VALUE",
//         Password: "STRING_VALUE",
//         SshKey: "STRING_VALUE",
//         Revision: "STRING_VALUE",
//       },
//       Domains: [ // Strings
//         "STRING_VALUE",
//       ],
//       EnableSsl: true || false,
//       SslConfiguration: { // SslConfiguration
//         Certificate: "STRING_VALUE", // required
//         PrivateKey: "STRING_VALUE", // required
//         Chain: "STRING_VALUE",
//       },
//       Attributes: { // AppAttributes
//         "<keys>": "STRING_VALUE",
//       },
//       CreatedAt: "STRING_VALUE",
//       Environment: [ // EnvironmentVariables
//         { // EnvironmentVariable
//           Key: "STRING_VALUE", // required
//           Value: "STRING_VALUE", // required
//           Secure: true || false,
//         },
//       ],
//     },
//   ],
// };

DescribeAppsCommand Input

See DescribeAppsCommandInput for more details

Parameter
Type
Description
AppIds
string[] | undefined

An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a description of the specified apps. Otherwise, it returns a description of every app.

StackId
string | undefined

The app stack ID. If you use this parameter, DescribeApps returns a description of the apps in the specified stack.

DescribeAppsCommand Output

See DescribeAppsCommandOutput for details

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

An array of App objects that describe the specified apps.

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.