DescribeApplicationCommand

Describes the application.

Example Syntax

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

import { ApplicationInsightsClient, DescribeApplicationCommand } from "@aws-sdk/client-application-insights"; // ES Modules import
// const { ApplicationInsightsClient, DescribeApplicationCommand } = require("@aws-sdk/client-application-insights"); // CommonJS import
const client = new ApplicationInsightsClient(config);
const input = { // DescribeApplicationRequest
  ResourceGroupName: "STRING_VALUE", // required
  AccountId: "STRING_VALUE",
};
const command = new DescribeApplicationCommand(input);
const response = await client.send(command);
// { // DescribeApplicationResponse
//   ApplicationInfo: { // ApplicationInfo
//     AccountId: "STRING_VALUE",
//     ResourceGroupName: "STRING_VALUE",
//     LifeCycle: "STRING_VALUE",
//     OpsItemSNSTopicArn: "STRING_VALUE",
//     SNSNotificationArn: "STRING_VALUE",
//     OpsCenterEnabled: true || false,
//     CWEMonitorEnabled: true || false,
//     Remarks: "STRING_VALUE",
//     AutoConfigEnabled: true || false,
//     DiscoveryType: "RESOURCE_GROUP_BASED" || "ACCOUNT_BASED",
//     AttachMissingPermission: true || false,
//   },
// };

DescribeApplicationCommand Input

See DescribeApplicationCommandInput for more details

Parameter
Type
Description
ResourceGroupName
Required
string | undefined

The name of the resource group.

AccountId
string | undefined

The Amazon Web Services account ID for the resource group owner.

DescribeApplicationCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ApplicationInfo
ApplicationInfo | undefined

Information about the application.

Throws

Name
Fault
Details
InternalServerException
server

The server encountered an internal error and is unable to complete the request.

ResourceNotFoundException
client

The resource does not exist in the customer account.

ValidationException
client

The parameter is not valid.

ApplicationInsightsServiceException
Base exception class for all service exceptions from ApplicationInsights service.