ResilienceHubV2 / Paginator / ListFailureModeAssessments

ListFailureModeAssessments¶

class ResilienceHubV2.Paginator.ListFailureModeAssessments¶

paginator = client.get_paginator('list_failure_mode_assessments')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from ResilienceHubV2.Client.list_failure_mode_assessments().

Request Syntax

response_iterator = paginator.paginate(
    serviceArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

serviceArn (string) –
[REQUIRED]

ARN identifier.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'assessmentSummaries': [
        {
            'assessmentId': 'string',
            'serviceArn': 'string',
            'assessmentStatus': 'NOT_STARTED'|'PENDING'|'IN_PROGRESS'|'FAILED'|'SUCCESS',
            'assessmentStep': 'TOPOLOGY_ENHANCEMENT'|'SERVICE_FUNCTION_GENERATION'|'RESILIENCE_ASSESSMENT',
            'totalFindings': 123,
            'startedAt': datetime(2015, 1, 1),
            'endedAt': datetime(2015, 1, 1),
            'errorMessage': 'string',
            'errorCode': 'INVALID_PERMISSIONS'|'CMK_ACCESS_DENIED'|'AGENT_ERROR'|'INTERNAL_ERROR'|'DESIGN_FILE_ACCESS_DENIED',
            'assessmentCost': {
                'amount': 123.0,
                'currency': 'USD'
            },
            'billableAssessmentUnitCount': 123,
            'achievability': {
                'availabilitySlo': 'ACHIEVABLE'|'NOT_ACHIEVABLE',
                'multiAzRtoRpo': 'ACHIEVABLE'|'NOT_ACHIEVABLE',
                'multiRegionRtoRpo': 'ACHIEVABLE'|'NOT_ACHIEVABLE'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- assessmentSummaries (list) –
  
  The list of assessment summaries.
  - (dict) –
    
    Contains summary information about a failure mode assessment.
    - assessmentId (string) –
      
      The unique identifier of the assessment.
    - serviceArn (string) –
      
      ARN identifier.
    - assessmentStatus (string) –
      
      The current status of the assessment.
    - assessmentStep (string) –
      
      The current step of the assessment process.
    - totalFindings (integer) –
      
      The total number of findings generated by the assessment.
    - startedAt (datetime) –
      
      The timestamp when the assessment started.
    - endedAt (datetime) –
      
      The timestamp when the assessment ended.
    - errorMessage (string) –
      
      A message describing the error if the assessment failed.
    - errorCode (string) –
      
      The error code if the assessment failed.
    - assessmentCost (dict) –
      
      The cost of the assessment.
      - amount (float) –
        
        The cost amount for the assessment.
      - currency (string) –
        
        The currency of the assessment cost.
    - billableAssessmentUnitCount (integer) –
      
      The number of billable assessment units consumed by the assessment.
    - achievability (dict) –
      
      The achievability results from the assessment.
      - availabilitySlo (string) –
        
        The achievability status of the availability SLO target for the service.
      - multiAzRtoRpo (string) –
        
        The achievability status of the multi-AZ RTO and RPO targets for the service.
      - multiRegionRtoRpo (string) –
        
        The achievability status of the multi-Region RTO and RPO targets for the service.
- NextToken (string) –
  
  A token to resume pagination.