Class ListApplicationsCommandProtected

Lists the applications associated with a specific Amazon Web Services account. You can provide the unique identifier of a specific runtime environment in a query parameter to see all applications associated with that environment.

Example

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

import { M2Client, ListApplicationsCommand } from "@aws-sdk/client-m2"; // ES Modules import
// const { M2Client, ListApplicationsCommand } = require("@aws-sdk/client-m2"); // CommonJS import
const client = new M2Client(config);
const input = { // ListApplicationsRequest
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
  names: [ // EntityNameList
    "STRING_VALUE",
  ],
  environmentId: "STRING_VALUE",
};
const command = new ListApplicationsCommand(input);
const response = await client.send(command);
// { // ListApplicationsResponse
//   applications: [ // ApplicationSummaryList // required
//     { // ApplicationSummary
//       name: "STRING_VALUE", // required
//       description: "STRING_VALUE",
//       applicationId: "STRING_VALUE", // required
//       applicationArn: "STRING_VALUE", // required
//       applicationVersion: Number("int"), // required
//       status: "STRING_VALUE", // required
//       engineType: "STRING_VALUE", // required
//       creationTime: new Date("TIMESTAMP"), // required
//       environmentId: "STRING_VALUE",
//       lastStartTime: new Date("TIMESTAMP"),
//       versionStatus: "STRING_VALUE",
//       deploymentStatus: "STRING_VALUE",
//       roleArn: "STRING_VALUE",
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

Param

ListApplicationsCommandInput

Returns

ListApplicationsCommandOutput

See

• ListApplicationsCommandInput for command's input shape.
• ListApplicationsCommandOutput for command's response shape.
• config for M2Client's config shape.

Throws

AccessDeniedException (client fault)

The account or role doesn't have the right permissions to make the request.

Throws

InternalServerException (server fault)

An unexpected error occurred during the processing of the request.

Throws

ThrottlingException (client fault)

The number of requests made exceeds the limit.

Throws

ValidationException (client fault)

One or more parameters provided in the request is not valid.

Throws

M2ServiceException

Base exception class for all service exceptions from M2 service.