Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeAppAssessment

Describes an assessment for an AWS Resilience Hub application.

Request Syntax


POST /describe-app-assessment HTTP/1.1
Content-type: application/json

{
   "assessmentArn": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

assessmentArn

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

Type: String

Pattern: ^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}$

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "assessment": { 
      "appArn": "string",
      "appVersion": "string",
      "assessmentArn": "string",
      "assessmentName": "string",
      "assessmentStatus": "string",
      "compliance": { 
         "string" : { 
            "achievableRpoInSecs": number,
            "achievableRtoInSecs": number,
            "complianceStatus": "string",
            "currentRpoInSecs": number,
            "currentRtoInSecs": number,
            "message": "string",
            "rpoDescription": "string",
            "rpoReferenceId": "string",
            "rtoDescription": "string",
            "rtoReferenceId": "string"
         }
      },
      "complianceStatus": "string",
      "cost": { 
         "amount": number,
         "currency": "string",
         "frequency": "string"
      },
      "driftStatus": "string",
      "endTime": number,
      "invoker": "string",
      "message": "string",
      "policy": { 
         "creationTime": number,
         "dataLocationConstraint": "string",
         "estimatedCostTier": "string",
         "policy": { 
            "string" : { 
               "rpoInSecs": number,
               "rtoInSecs": number
            }
         },
         "policyArn": "string",
         "policyDescription": "string",
         "policyName": "string",
         "tags": { 
            "string" : "string" 
         },
         "tier": "string"
      },
      "resiliencyScore": { 
         "componentScore": { 
            "string" : { 
               "excludedCount": number,
               "outstandingCount": number,
               "possibleScore": number,
               "score": number
            }
         },
         "disruptionScore": { 
            "string" : number 
         },
         "score": number
      },
      "resourceErrorsDetails": { 
         "hasMoreErrors": boolean,
         "resourceErrors": [ 
            { 
               "logicalResourceId": "string",
               "physicalResourceId": "string",
               "reason": "string"
            }
         ]
      },
      "startTime": number,
      "summary": { 
         "riskRecommendations": [ 
            { 
               "appComponents": [ "string" ],
               "recommendation": "string",
               "risk": "string"
            }
         ],
         "summary": "string"
      },
      "tags": { 
         "string" : "string" 
      },
      "versionName": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

assessment

The assessment for an AWS Resilience Hub application, returned as an object. This object includes Amazon Resource Names (ARNs), compliance information, compliance status, cost, messages, resiliency scores, and more.

Type: AppAssessment object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

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.

HTTP Status Code: 403

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

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

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

This exception occurs when a request is not valid.

HTTP Status Code: 400