View a markdown version of this page

Data retrieval APIs for AWS Resilience Hub - AWS Online Register of Data Formats

Data retrieval APIs for AWS Resilience Hub

AWS Resilience Hub provides the following APIs for data retrieval.

Actions Description Access level
DescribeAppDescribe applicationRead
DescribeAppAssessmentDescribe application assessmentRead
DescribeAppVersionDescribe application versionRead
DescribeAppVersionAppComponentDescribe application version app componentRead
DescribeAppVersionResourceDescribe application version resourceRead
DescribeAppVersionResourcesResolutionStatusDescribe application resolutionRead
DescribeAppVersionTemplateDescribe application version templateRead
DescribeDraftAppVersionResourcesImportStatusDescribe draft application version resources import statusRead
DescribeMetricsExportDescribe metrics exportRead
DescribeResiliencyPolicyDescribe resiliency policyRead
DescribeResourceGroupingRecommendationTaskDescribe the latest status of the grouping recommendation processRead
GetFailureModeFindingRetrieve a failure mode findingRead
GetPolicyRetrieve a resilience policyRead
GetServiceRetrieve a serviceRead
GetSystemRetrieve a systemRead
GetUserJourneyRetrieve a user journeyRead
ListAlarmRecommendationsList alarm recommendationList
ListAppAssessmentComplianceDriftsList compliance drifts that were detected while running an assessmentList
ListAppAssessmentResourceDriftsList resource drifts that were detected while running an assessmentList
ListAppAssessmentsList application assessmentList
ListAppComponentCompliancesList app component compliancesList
ListAppComponentRecommendationsList app component recommendationsList
ListAppInputSourcesList application input sourcesList
ListAppVersionAppComponentsList application version app componentsList
ListAppVersionResourceMappingsApplication version resource mappingsList
ListAppVersionResourcesList application resourcesList
ListAppVersionsList application versionList
ListAppsList applicationsList
ListAssertionsList assertions for a serviceRead
ListDependenciesList dependencies discovered for servicesRead
ListFailureModeAssessmentsList failure mode assessmentsRead
ListFailureModeFindingsList failure mode findingsRead
ListInputSourcesList input sources for a serviceRead
ListMetricsList metricsList
ListPoliciesList resilience policiesRead
ListRecommendationTemplatesList recommendation templatesList
ListReportsList reportsRead
ListResiliencyPoliciesList resiliency policiesList
ListResourceGroupingRecommendationsList resource grouping recommendationsList
ListResourcesList resources for a serviceRead
ListServiceEventsList events for a serviceRead
ListServiceFunctionsList service functionsRead
ListServiceTopologyEdgesList service topology edgesRead
ListServicesList servicesRead
ListSopRecommendationsList SOP recommendationsList
ListSuggestedResiliencyPoliciesList suggested resiliency policiesList
ListSystemEventsList events for a systemRead
ListSystemsList systemsRead
ListTagsForResourceList tags for a resourceRead
ListTestRecommendationsList test recommendationsList
ListUnsupportedAppVersionResourcesList unsupported application version resourcesList
ListUserJourneysList user journeys for a systemRead