2022/10/20 - AWS Resilience Hub - 2 updated api methods
Changes In this release, we are introducing support for regional optimization for AWS Resilience Hub applications. It also includes a few documentation updates to improve clarity.
{'componentRecommendations': {'configRecommendations': {'optimizationType': {'BestRegionRecovery'}}}}
Lists the recommendations for an AWS Resilience Hub component.
See also: AWS API Documentation
Request Syntax
client.list_app_component_recommendations(
assessmentArn='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The 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 .
integer
The 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.
string
Null, or the token from a previous call to get the next set of results.
dict
Response Syntax
{
'componentRecommendations': [
{
'appComponentName': 'string',
'configRecommendations': [
{
'appComponentName': 'string',
'compliance': {
'string': {
'achievableRpoInSecs': 123,
'achievableRtoInSecs': 123,
'complianceStatus': 'PolicyBreached'|'PolicyMet',
'currentRpoInSecs': 123,
'currentRtoInSecs': 123,
'message': 'string',
'rpoDescription': 'string',
'rpoReferenceId': 'string',
'rtoDescription': 'string',
'rtoReferenceId': 'string'
}
},
'cost': {
'amount': 123.0,
'currency': 'string',
'frequency': 'Hourly'|'Daily'|'Monthly'|'Yearly'
},
'description': 'string',
'haArchitecture': 'MultiSite'|'WarmStandby'|'PilotLight'|'BackupAndRestore'|'NoRecoveryPlan',
'name': 'string',
'optimizationType': 'LeastCost'|'LeastChange'|'BestAZRecovery'|'LeastErrors'|'BestAttainable'|'BestRegionRecovery',
'recommendationCompliance': {
'string': {
'expectedComplianceStatus': 'PolicyBreached'|'PolicyMet',
'expectedRpoDescription': 'string',
'expectedRpoInSecs': 123,
'expectedRtoDescription': 'string',
'expectedRtoInSecs': 123
}
},
'referenceId': 'string',
'suggestedChanges': [
'string',
]
},
],
'recommendationStatus': 'BreachedUnattainable'|'BreachedCanMeet'|'MetCanImprove'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
componentRecommendations (list) --
The recommendations for an Resilience Hub application component, returned as an object. This object contains component names, configuration recommendations, and recommendation statuses.
(dict) --
Defines recommendations for a Resilience Hub application component, returned as an object. This object contains component names, configuration recommendations, and recommendation statuses.
appComponentName (string) --
The name of the application component.
configRecommendations (list) --
The list of recommendations.
(dict) --
Defines a configuration recommendation.
appComponentName (string) --
The application component name.
compliance (dict) --
The current compliance against the resiliency policy before applying the configuration change.
(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) --
The RPO reference identifier.
rtoDescription (string) --
The RTO description.
rtoReferenceId (string) --
The RTO reference identifier.
cost (dict) --
The cost for the application.
amount (float) --
The cost amount.
currency (string) --
The cost currency, for example USD .
frequency (string) --
The cost frequency.
description (string) --
The optional description for an app.
haArchitecture (string) --
The architecture type.
name (string) --
The name of the recommendation configuration.
optimizationType (string) --
The type of optimization.
recommendationCompliance (dict) --
The expected compliance against the resiliency policy after applying the configuration change.
(string) --
(dict) --
Defines a disruption compliance recommendation.
expectedComplianceStatus (string) --
The expected compliance status after applying the recommended configuration change.
expectedRpoDescription (string) --
The expected Recovery Point Objective (RPO) description after applying the recommended configuration change.
expectedRpoInSecs (integer) --
The expected RPO after applying the recommended configuration change.
expectedRtoDescription (string) --
The expected Recovery Time Objective (RTO) description after applying the recommended configuration change.
expectedRtoInSecs (integer) --
The expected RTO after applying the recommended configuration change.
referenceId (string) --
The reference identifier for the recommendation configuration.
suggestedChanges (list) --
List of the suggested configuration changes.
(string) --
recommendationStatus (string) --
The recommendation status.
nextToken (string) --
The token for the next set of results, or null if there are no more results.
{'appSummaries': {'status': 'Active | Deleting'}}
Lists your Resilience Hub applications.
See also: AWS API Documentation
Request Syntax
client.list_apps(
appArn='string',
maxResults=123,
name='string',
nextToken='string'
)
string
The Amazon Resource Name (ARN) of the 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 .
integer
The 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.
string
The name for the one of the listed applications.
string
Null, or the token from a previous call to get the next set of results.
dict
Response Syntax
{
'appSummaries': [
{
'appArn': 'string',
'assessmentSchedule': 'Disabled'|'Daily',
'complianceStatus': 'PolicyBreached'|'PolicyMet'|'NotAssessed'|'ChangesDetected',
'creationTime': datetime(2015, 1, 1),
'description': 'string',
'name': 'string',
'resiliencyScore': 123.0,
'status': 'Active'|'Deleting'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
appSummaries (list) --
Summaries for the Resilience Hub application.
(dict) --
Defines an application summary.
appArn (string) --
The Amazon Resource Name (ARN) of the 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 .
assessmentSchedule (string) --
Assessment execution schedule with 'Daily' or 'Disabled' values.
complianceStatus (string) --
The current status of compliance for the resiliency policy.
creationTime (datetime) --
The timestamp for when the app was created.
description (string) --
The optional description for an app.
name (string) --
The name of the application.
resiliencyScore (float) --
The current resiliency score for the application.
status (string) --
The status of the application.
nextToken (string) --
The token for the next set of results, or null if there are no more results.