DescribeAppCommand

Suggest an Edit

Describes an Resilience Hub application.

Example Syntax

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

import { ResiliencehubClient, DescribeAppCommand } from "@aws-sdk/client-resiliencehub"; // ES Modules import
// const { ResiliencehubClient, DescribeAppCommand } = require("@aws-sdk/client-resiliencehub"); // CommonJS import
const client = new ResiliencehubClient(config);
const input = { // DescribeAppRequest
  appArn: "STRING_VALUE", // required
};
const command = new DescribeAppCommand(input);
const response = await client.send(command);
// { // DescribeAppResponse
//   app: { // App
//     appArn: "STRING_VALUE", // required
//     name: "STRING_VALUE", // required
//     description: "STRING_VALUE",
//     policyArn: "STRING_VALUE",
//     creationTime: new Date("TIMESTAMP"), // required
//     status: "Active" || "Deleting",
//     complianceStatus: "PolicyBreached" || "PolicyMet" || "NotAssessed" || "ChangesDetected" || "NotApplicable" || "MissingPolicy",
//     lastAppComplianceEvaluationTime: new Date("TIMESTAMP"),
//     resiliencyScore: Number("double"),
//     lastResiliencyScoreEvaluationTime: new Date("TIMESTAMP"),
//     tags: { // TagMap
//       "<keys>": "STRING_VALUE",
//     },
//     assessmentSchedule: "Disabled" || "Daily",
//     permissionModel: { // PermissionModel
//       type: "LegacyIAMUser" || "RoleBased", // required
//       invokerRoleName: "STRING_VALUE",
//       crossAccountRoleArns: [ // IamRoleArnList
//         "STRING_VALUE",
//       ],
//     },
//     eventSubscriptions: [ // EventSubscriptionList
//       { // EventSubscription
//         name: "STRING_VALUE", // required
//         eventType: "ScheduledAssessmentFailure" || "DriftDetected", // required
//         snsTopicArn: "STRING_VALUE",
//       },
//     ],
//     driftStatus: "NotChecked" || "NotDetected" || "Detected",
//     lastDriftEvaluationTime: new Date("TIMESTAMP"),
//     rtoInSecs: Number("int"),
//     rpoInSecs: Number("int"),
//     awsApplicationArn: "STRING_VALUE",
//   },
// };

DescribeAppCommand Input

See DescribeAppCommandInput for more details

Parameter
Type
Description
appArn
Required
string | undefined

Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs)  in the Amazon Web Services General Reference guide.

DescribeAppCommand Output

See DescribeAppCommandOutput for details

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

The specified application, returned as an object with details including compliance status, creation time, description, resiliency score, and more.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

InternalServerException
server

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException
client

This exception occurs when the specified resource could not be found.

ThrottlingException
client

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException
client

This exception occurs when a request is not valid.

ResiliencehubServiceException
Base exception class for all service exceptions from Resiliencehub service.