ResilienceHub / Client / list_app_assessments

list_app_assessments#

ResilienceHub.Client.list_app_assessments(**kwargs)#

Lists the assessments for an Resilience Hub application. You can use request parameters to refine the results for the response object.

Request Syntax

response = client.list_app_assessments(
    appArn='string',
    assessmentName='string',
    assessmentStatus=[
        'Pending'|'InProgress'|'Failed'|'Success',
    ],
    complianceStatus='PolicyBreached'|'PolicyMet',
    invoker='User'|'System',
    maxResults=123,
    nextToken='string',
    reverseOrder=True|False
)

Parameters:

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.
assessmentName (string) – The name for the assessment.
assessmentStatus (list) –
The current status of the assessment for the resiliency policy.
- (string) –
complianceStatus (string) – The current status of compliance for the resiliency policy.
invoker (string) – Specifies the entity that invoked a specific assessment, either a User or the System.
maxResults (integer) – Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
nextToken (string) – Null, or the token from a previous call to get the next set of results.
reverseOrder (boolean) – The default is to sort by ascending startTime. To sort by descending startTime, set reverseOrder to true.

Return type:

dict

Returns:

Response Syntax

{
    'assessmentSummaries': [
        {
            'appArn': 'string',
            'appVersion': 'string',
            'assessmentArn': 'string',
            'assessmentName': 'string',
            'assessmentStatus': 'Pending'|'InProgress'|'Failed'|'Success',
            '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',
            'resiliencyScore': 123.0,
            'startTime': datetime(2015, 1, 1),
            'versionName': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- assessmentSummaries (list) –
  
  The summaries for the specified assessments, returned as an object. This object includes application versions, associated Amazon Resource Numbers (ARNs), cost, messages, resiliency scores, and more.
  - (dict) –
    
    Defines an application assessment summary.
    - 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.
    - complianceStatus (string) –
      
      TCurrent status of compliance for the resiliency policy.
    - cost (dict) –
      
      Cost for an 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) –
      
      Entity that invoked the assessment.
    - message (string) –
      
      Message from the assessment run.
    - resiliencyScore (float) –
      
      Current resiliency score for the application.
    - startTime (datetime) –
      
      Starting time for the action.
    - versionName (string) –
      
      Name of an application version.
- nextToken (string) –
  
  Token for the next set of results, or null if there are no more results.

Exceptions

ResilienceHub.Client.exceptions.InternalServerException
ResilienceHub.Client.exceptions.ResourceNotFoundException
ResilienceHub.Client.exceptions.ThrottlingException
ResilienceHub.Client.exceptions.ValidationException
ResilienceHub.Client.exceptions.AccessDeniedException