ResilienceHub / Client / start_app_assessment

start_app_assessment#

ResilienceHub.Client.start_app_assessment(**kwargs)#

Creates a new application assessment for an application.

See also: AWS API Documentation

Request Syntax

response = client.start_app_assessment(
    appArn='string',
    appVersion='string',
    assessmentName='string',
    clientToken='string',
    tags={
        'string': 'string'
    }
)
Parameters:
  • appArn (string) –

    [REQUIRED]

    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 AWS General Reference guide.

  • appVersion (string) –

    [REQUIRED]

    The version of the application.

  • assessmentName (string) –

    [REQUIRED]

    The name for the assessment.

  • clientToken (string) –

    Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

    This field is autopopulated if not provided.

  • tags (dict) –

    Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'assessment': {
        'appArn': 'string',
        'appVersion': 'string',
        'assessmentArn': 'string',
        'assessmentName': 'string',
        'assessmentStatus': 'Pending'|'InProgress'|'Failed'|'Success',
        'compliance': {
            'string': {
                'achievableRpoInSecs': 123,
                'achievableRtoInSecs': 123,
                'complianceStatus': 'PolicyBreached'|'PolicyMet',
                'currentRpoInSecs': 123,
                'currentRtoInSecs': 123,
                'message': 'string',
                'rpoDescription': 'string',
                'rpoReferenceId': 'string',
                'rtoDescription': 'string',
                'rtoReferenceId': 'string'
            }
        },
        'complianceStatus': 'PolicyBreached'|'PolicyMet',
        'cost': {
            'amount': 123.0,
            'currency': 'string',
            'frequency': 'Hourly'|'Daily'|'Monthly'|'Yearly'
        },
        'driftStatus': 'NotChecked'|'NotDetected'|'Detected',
        'endTime': datetime(2015, 1, 1),
        'invoker': 'User'|'System',
        'message': 'string',
        'policy': {
            'creationTime': datetime(2015, 1, 1),
            'dataLocationConstraint': 'AnyLocation'|'SameContinent'|'SameCountry',
            'estimatedCostTier': 'L1'|'L2'|'L3'|'L4',
            'policy': {
                'string': {
                    'rpoInSecs': 123,
                    'rtoInSecs': 123
                }
            },
            'policyArn': 'string',
            'policyDescription': 'string',
            'policyName': 'string',
            'tags': {
                'string': 'string'
            },
            'tier': 'MissionCritical'|'Critical'|'Important'|'CoreServices'|'NonCritical'|'NotApplicable'
        },
        'resiliencyScore': {
            'disruptionScore': {
                'string': 123.0
            },
            'score': 123.0
        },
        'resourceErrorsDetails': {
            'hasMoreErrors': True|False,
            'resourceErrors': [
                {
                    'logicalResourceId': 'string',
                    'physicalResourceId': 'string',
                    'reason': 'string'
                },
            ]
        },
        'startTime': datetime(2015, 1, 1),
        'tags': {
            'string': 'string'
        },
        'versionName': 'string'
    }
}

Response Structure

  • (dict) –

    • assessment (dict) –

      The assessment created.

      • appArn (string) –

        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 AWS General Reference guide.

      • appVersion (string) –

        Version of an application.

      • assessmentArn (string) –

        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.

      • assessmentName (string) –

        Name of the assessment.

      • assessmentStatus (string) –

        Current status of the assessment for the resiliency policy.

      • compliance (dict) –

        Application compliance against the resiliency policy.

        • (string) –

          • (dict) –

            Defines the compliance against the resiliency policy for a disruption.

            • achievableRpoInSecs (integer) –

              The Recovery Point Objective (RPO) that is achievable, in seconds.

            • achievableRtoInSecs (integer) –

              The Recovery Time Objective (RTO) that is achievable, in seconds

            • complianceStatus (string) –

              The current status of compliance for the resiliency policy.

            • currentRpoInSecs (integer) –

              The current RPO, in seconds.

            • currentRtoInSecs (integer) –

              The current RTO, in seconds.

            • message (string) –

              The disruption compliance message.

            • rpoDescription (string) –

              The RPO description.

            • rpoReferenceId (string) –

              Reference identifier of the RPO .

            • rtoDescription (string) –

              The RTO description.

            • rtoReferenceId (string) –

              Reference identifier of the RTO.

      • complianceStatus (string) –

        Current status of the compliance for the resiliency policy.

      • cost (dict) –

        Cost for the application.

        • amount (float) –

          The cost amount.

        • currency (string) –

          The cost currency, for example USD.

        • frequency (string) –

          The cost frequency.

      • driftStatus (string) –

        Indicates if compliance drifts (deviations) were detected while running an assessment for your application.

      • endTime (datetime) –

        End time for the action.

      • invoker (string) –

        The entity that invoked the assessment.

      • message (string) –

        Error or warning message from the assessment execution

      • policy (dict) –

        Resiliency policy of an application.

        • creationTime (datetime) –

          The timestamp for when the resiliency policy was created.

        • dataLocationConstraint (string) –

          Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

        • estimatedCostTier (string) –

          Specifies the estimated cost tier of the resiliency policy.

        • policy (dict) –

          The resiliency policy.

          • (string) –

            • (dict) –

              Defines a failure policy.

              • rpoInSecs (integer) –

                The Recovery Point Objective (RPO), in seconds.

              • rtoInSecs (integer) –

                The Recovery Time Objective (RTO), in seconds.

        • policyArn (string) –

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

        • policyDescription (string) –

          The description for the policy.

        • policyName (string) –

          The name of the policy

        • tags (dict) –

          Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

          • (string) –

            • (string) –

        • tier (string) –

          The tier for this resiliency policy, ranging from the highest severity ( MissionCritical) to lowest ( NonCritical).

      • resiliencyScore (dict) –

        Current resiliency score for an application.

        • disruptionScore (dict) –

          The disruption score for a valid key.

          • (string) –

            • (float) –

        • score (float) –

          The outage score for a valid key.

      • resourceErrorsDetails (dict) –

        A resource error object containing a list of errors retrieving an application’s resources.

        • hasMoreErrors (boolean) –

          This indicates if there are more errors not listed in the resourceErrors list.

        • resourceErrors (list) –

          A list of errors retrieving an application’s resources.

          • (dict) –

            Defines application resource errors.

            • logicalResourceId (string) –

              Identifier of the logical resource.

            • physicalResourceId (string) –

              Identifier of the physical resource.

            • reason (string) –

              This is the error message.

      • startTime (datetime) –

        Starting time for the action.

      • tags (dict) –

        Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

        • (string) –

          • (string) –

      • versionName (string) –

        Version name of the published application.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException

  • ResilienceHub.Client.exceptions.ResourceNotFoundException

  • ResilienceHub.Client.exceptions.ConflictException

  • ResilienceHub.Client.exceptions.ServiceQuotaExceededException

  • ResilienceHub.Client.exceptions.ThrottlingException

  • ResilienceHub.Client.exceptions.ValidationException

  • ResilienceHub.Client.exceptions.AccessDeniedException