ResilienceHubV2 / Client / list_failure_mode_assessments

list_failure_mode_assessments

ResilienceHubV2.Client.list_failure_mode_assessments(**kwargs)

Lists failure mode assessments.

See also: AWS API Documentation

Request Syntax

response = client.list_failure_mode_assessments(
    serviceArn='string',
    assessmentStatuses=[
        'NOT_STARTED'|'PENDING'|'IN_PROGRESS'|'FAILED'|'SUCCESS',
    ],
    startedAfter=datetime(2015, 1, 1),
    endedBefore=datetime(2015, 1, 1),
    sortBy='STARTED_AT',
    sortOrder='ASC'|'DESC',
    maxResults=123,
    nextToken='string'
)

Parameters:

• serviceArn (string) –

  [REQUIRED]

  ARN identifier.

• assessmentStatuses (list) –

  Specifies the assessment statuses to include in the results.

  • (string) –

• startedAfter (datetime) – Specifies that only assessments that started at or after this timestamp appear in the results.

• endedBefore (datetime) – Specifies that only assessments that ended at or before this timestamp appear in the results.

• sortBy (string) – The field to use for sorting failure mode assessments.

• sortOrder (string) – The sort order for results.

• maxResults (integer) – Pagination page size.

• nextToken (string) – Pagination token.

Return type:

dict

Returns:

Response Syntax

{
    'assessmentSummaries': [
        {
            'assessmentId': 'string',
            'serviceArn': 'string',
            'assessmentStatus': 'NOT_STARTED'|'PENDING'|'IN_PROGRESS'|'FAILED'|'SUCCESS',
            'assessmentStep': 'TOPOLOGY_GENERATION'|'INPUT_VALIDATION'|'DESIGN_ANALYSIS'|'TOPOLOGY_ENHANCEMENT'|'SERVICE_FUNCTION_GENERATION'|'POLICY_VALIDATION'|'RESILIENCE_ASSESSMENT'|'FAILURE_MODE_FINDINGS_CONSOLIDATION'|'FAILURE_MODE_FINDINGS_ENRICHMENT',
            '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',
                'dataRecoveryTimeBetweenBackups': '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.

        • dataRecoveryTimeBetweenBackups (string) –

          The achievability status of the data recovery time between backups for the service.

  • nextToken (string) –

    Pagination token.

Exceptions

• ResilienceHubV2.Client.exceptions.InternalServerException

• ResilienceHubV2.Client.exceptions.ResourceNotFoundException

• ResilienceHubV2.Client.exceptions.ValidationException

• ResilienceHubV2.Client.exceptions.AccessDeniedException