2021/11/10 - AWS Resilience Hub - 39 new api methods
Changes Initial release of AWS Resilience Hub, a managed service that enables you to define, validate, and track the resilience of your applications on AWS
Removes resource mappings from a draft application version.
See also: AWS API Documentation
Request Syntax
client.remove_draft_app_version_resource_mappings(
appArn='string',
appRegistryAppNames=[
'string',
],
logicalStackNames=[
'string',
],
resourceGroupNames=[
'string',
],
resourceNames=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
list
The names of the registered applications to remove from the resource mappings.
(string) --
list
The names of the CloudFormation stacks to remove from the resource mappings.
(string) --
list
The names of the resource groups to remove from the resource mappings.
(string) --
list
The names of the resources to remove from the resource mappings.
(string) --
dict
Response Syntax
{
'appArn': 'string',
'appVersion': 'string'
}
Response Structure
(dict) --
appArn (string) --
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
appVersion (string) --
The version of the application.
Applies one or more tags to a resource.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
dict
[REQUIRED]
The tags to assign to the resource. Each tag consists of a key/value pair.
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Lists the different versions for the Resilience Hub applications.
See also: AWS API Documentation
Request Syntax
client.list_app_versions(
appArn='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps: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
Null, or the token from a previous call to get the next set of results.
dict
Response Syntax
{
'appVersions': [
{
'appVersion': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
appVersions (list) --
The version of the application.
(dict) --
The version of the application.
appVersion (string) --
The version of the application.
nextToken (string) --
The token for the next set of results, or null if there are no more results.
Imports resources from sources such as a CloudFormation stack, resource-groups, or application registry app to a draft application version.
See also: AWS API Documentation
Request Syntax
client.import_resources_to_draft_app_version(
appArn='string',
sourceArns=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
list
[REQUIRED]
The Amazon Resource Names (ARNs) for the resources that you want to import.
(string) --
dict
Response Syntax
{
'appArn': 'string',
'appVersion': 'string',
'sourceArns': [
'string',
],
'status': 'Pending'|'InProgress'|'Failed'|'Success'
}
Response Structure
(dict) --
appArn (string) --
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
appVersion (string) --
The version of the application.
sourceArns (list) --
The Amazon Resource Names (ARNs) for the resources that you imported.
(string) --
status (string) --
The status of the action.
Publishes a new version of a specific Resilience Hub application.
See also: AWS API Documentation
Request Syntax
client.publish_app_version(
appArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
dict
Response Syntax
{
'appArn': 'string',
'appVersion': 'string'
}
Response Structure
(dict) --
appArn (string) --
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
appVersion (string) --
The version of the application.
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 :dcps: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',
'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.
Creates a new recommendation template.
See also: AWS API Documentation
Request Syntax
client.create_recommendation_template(
assessmentArn='string',
bucketName='string',
clientToken='string',
format='CfnYaml'|'CfnJson',
name='string',
recommendationIds=[
'string',
],
recommendationTypes=[
'Alarm'|'Sop'|'Test',
],
tags={
'string': 'string'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition :dcps:region :account :app-assessment/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
string
The name of the Amazon S3 bucket that will contain the recommendation template.
string
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
This field is autopopulated if not provided.
string
The format for the recommendation template.
CfnJson
The template is CloudFormation JSON.
CfnYaml
The template is CloudFormation YAML.
string
[REQUIRED]
The name for the recommendation template.
list
Identifiers for the recommendations used to create a recommendation template.
(string) --
list
An array of strings that specify the recommendation template type or types.
Alarm
The template is an AlarmRecommendation template.
Sop
The template is a SopRecommendation template.
Test
The template is a TestRecommendation template.
(string) --
dict
The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
(string) --
(string) --
dict
Response Syntax
{
'recommendationTemplate': {
'appArn': 'string',
'assessmentArn': 'string',
'endTime': datetime(2015, 1, 1),
'format': 'CfnYaml'|'CfnJson',
'message': 'string',
'name': 'string',
'needsReplacements': True|False,
'recommendationIds': [
'string',
],
'recommendationTemplateArn': 'string',
'recommendationTypes': [
'Alarm'|'Sop'|'Test',
],
'startTime': datetime(2015, 1, 1),
'status': 'Pending'|'InProgress'|'Failed'|'Success',
'tags': {
'string': 'string'
},
'templatesLocation': {
'bucket': 'string',
'prefix': 'string'
}
}
}
Response Structure
(dict) --
recommendationTemplate (dict) --
The newly created recommendation template, returned as an object. This object includes the template's name, format, status, tags, Amazon S3 bucket location, and more.
appArn (string) --
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
assessmentArn (string) --
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition :dcps:region :account :app-assessment/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
endTime (datetime) --
The end time for the action.
format (string) --
The format of the recommendation template.
CfnJson
The template is CloudFormation JSON.
CfnYaml
The template is CloudFormation YAML.
message (string) --
The message for the recommendation template.
name (string) --
The name for the recommendation template.
needsReplacements (boolean) --
Indicates if replacements are needed.
recommendationIds (list) --
Identifiers for the recommendations used in the recommendation template.
(string) --
recommendationTemplateArn (string) --
The Amazon Resource Name (ARN) for the recommendation template.
recommendationTypes (list) --
An array of strings that specify the recommendation template type or types.
Alarm
The template is an AlarmRecommendation template.
Sop
The template is a SopRecommendation template.
Test
The template is a TestRecommendation template.
(string) --
startTime (datetime) --
The start time for the action.
status (string) --
The status of the action.
tags (dict) --
The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
(string) --
(string) --
templatesLocation (dict) --
The file location of the template.
bucket (string) --
The name of the Amazon S3 bucket.
prefix (string) --
The prefix for the Amazon S3 bucket.
Deletes a recommendation template. This is a destructive action that can't be undone.
See also: AWS API Documentation
Request Syntax
client.delete_recommendation_template(
clientToken='string',
recommendationTemplateArn='string'
)
string
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
This field is autopopulated if not provided.
string
[REQUIRED]
The Amazon Resource Name (ARN) for a recommendation template.
dict
Response Syntax
{
'recommendationTemplateArn': 'string',
'status': 'Pending'|'InProgress'|'Failed'|'Success'
}
Response Structure
(dict) --
recommendationTemplateArn (string) --
The Amazon Resource Name (ARN) for a recommendation template.
status (string) --
The status of the action.
Adds the resource mapping for the draft application version.
See also: AWS API Documentation
Request Syntax
client.add_draft_app_version_resource_mappings(
appArn='string',
resourceMappings=[
{
'appRegistryAppName': 'string',
'logicalStackName': 'string',
'mappingType': 'CfnStack'|'Resource'|'AppRegistryApp'|'ResourceGroup',
'physicalResourceId': {
'awsAccountId': 'string',
'awsRegion': 'string',
'identifier': 'string',
'type': 'Arn'|'Native'
},
'resourceGroupName': 'string',
'resourceName': 'string'
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
list
[REQUIRED]
Mappings used to map logical resources from the template to physical resources. You can use the mapping type CFN_STACK if the application template uses a logical stack name. Or you can map individual resources by using the mapping type RESOURCE . We recommend using the mapping type CFN_STACK if the application is backed by a CloudFormation stack.
(dict) --
Defines a resource mapping.
appRegistryAppName (string) --
The name of the application this resource is mapped to.
logicalStackName (string) --
The name of the CloudFormation stack this resource is mapped to.
mappingType (string) -- [REQUIRED]
Specifies the type of resource mapping.
AppRegistryApp
The resource is mapped to another application. The name of the application is contained in the appRegistryAppName property.
CfnStack
The resource is mapped to a CloudFormation stack. The name of the CloudFormation stack is contained in the logicalStackName property.
Resource
The resource is mapped to another resource. The name of the resource is contained in the resourceName property.
ResourceGroup
The resource is mapped to a resource group. The name of the resource group is contained in the resourceGroupName property.
physicalResourceId (dict) -- [REQUIRED]
The identifier of this resource.
awsAccountId (string) --
The Amazon Web Services account that owns the physical resource.
awsRegion (string) --
The Amazon Web Services Region that the physical resource is located in.
identifier (string) -- [REQUIRED]
The identifier of the physical resource.
type (string) -- [REQUIRED]
Specifies the type of physical resource identifier.
Arn
The resource identifier is an Amazon Resource Name (ARN) .
Native
The resource identifier is a Resilience Hub-native identifier.
resourceGroupName (string) --
The name of the resource group this resource is mapped to.
resourceName (string) --
The name of the resource this resource is mapped to.
dict
Response Syntax
{
'appArn': 'string',
'appVersion': 'string',
'resourceMappings': [
{
'appRegistryAppName': 'string',
'logicalStackName': 'string',
'mappingType': 'CfnStack'|'Resource'|'AppRegistryApp'|'ResourceGroup',
'physicalResourceId': {
'awsAccountId': 'string',
'awsRegion': 'string',
'identifier': 'string',
'type': 'Arn'|'Native'
},
'resourceGroupName': 'string',
'resourceName': 'string'
},
]
}
Response Structure
(dict) --
appArn (string) --
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
appVersion (string) --
The version of the application.
resourceMappings (list) --
Mappings used to map logical resources from the template to physical resources. You can use the mapping type CFN_STACK if the application template uses a logical stack name. Or you can map individual resources by using the mapping type RESOURCE . We recommend using the mapping type CFN_STACK if the application is backed by a CloudFormation stack.
(dict) --
Defines a resource mapping.
appRegistryAppName (string) --
The name of the application this resource is mapped to.
logicalStackName (string) --
The name of the CloudFormation stack this resource is mapped to.
mappingType (string) --
Specifies the type of resource mapping.
AppRegistryApp
The resource is mapped to another application. The name of the application is contained in the appRegistryAppName property.
CfnStack
The resource is mapped to a CloudFormation stack. The name of the CloudFormation stack is contained in the logicalStackName property.
Resource
The resource is mapped to another resource. The name of the resource is contained in the resourceName property.
ResourceGroup
The resource is mapped to a resource group. The name of the resource group is contained in the resourceGroupName property.
physicalResourceId (dict) --
The identifier of this resource.
awsAccountId (string) --
The Amazon Web Services account that owns the physical resource.
awsRegion (string) --
The Amazon Web Services Region that the physical resource is located in.
identifier (string) --
The identifier of the physical resource.
type (string) --
Specifies the type of physical resource identifier.
Arn
The resource identifier is an Amazon Resource Name (ARN) .
Native
The resource identifier is a Resilience Hub-native identifier.
resourceGroupName (string) --
The name of the resource group this resource is mapped to.
resourceName (string) --
The name of the resource this resource is mapped to.
Lists the tags for your resources in your Resilience Hub applications.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
resourceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) for a specific resource in your Resilience Hub application.
dict
Response Syntax
{
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
tags (dict) --
The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
(string) --
(string) --
Lists all the resources in an application version.
See also: AWS API Documentation
Request Syntax
client.list_app_version_resources(
appArn='string',
appVersion='string',
maxResults=123,
nextToken='string',
resolutionId='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
string
[REQUIRED]
The version of the application.
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.
string
The identifier for a specific resolution.
dict
Response Syntax
{
'nextToken': 'string',
'physicalResources': [
{
'appComponents': [
{
'name': 'string',
'type': 'string'
},
],
'logicalResourceId': {
'identifier': 'string',
'logicalStackName': 'string',
'resourceGroupName': 'string'
},
'physicalResourceId': {
'awsAccountId': 'string',
'awsRegion': 'string',
'identifier': 'string',
'type': 'Arn'|'Native'
},
'resourceName': 'string',
'resourceType': 'string'
},
],
'resolutionId': 'string'
}
Response Structure
(dict) --
nextToken (string) --
The token for the next set of results, or null if there are no more results.
physicalResources (list) --
The physical resources in the application version.
(dict) --
Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.
appComponents (list) --
The application components that belong to this resource.
(dict) --
Defines an application component.
name (string) --
The name of the application component.
type (string) --
The type of application component.
logicalResourceId (dict) --
The logical identifier of the resource.
identifier (string) --
The identifier of the resource.
logicalStackName (string) --
The name of the CloudFormation stack this resource belongs to.
resourceGroupName (string) --
The name of the resource group that this resource belongs to.
physicalResourceId (dict) --
The physical identifier of the resource.
awsAccountId (string) --
The Amazon Web Services account that owns the physical resource.
awsRegion (string) --
The Amazon Web Services Region that the physical resource is located in.
identifier (string) --
The identifier of the physical resource.
type (string) --
Specifies the type of physical resource identifier.
Arn
The resource identifier is an Amazon Resource Name (ARN) .
Native
The resource identifier is a Resilience Hub-native identifier.
resourceName (string) --
The name of the resource.
resourceType (string) --
The type of resource.
resolutionId (string) --
The identifier for a specific resolution.
Resolves the resources for an application version.
See also: AWS API Documentation
Request Syntax
client.resolve_app_version_resources(
appArn='string',
appVersion='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
string
[REQUIRED]
The version of the application.
dict
Response Syntax
{
'appArn': 'string',
'appVersion': 'string',
'resolutionId': 'string',
'status': 'Pending'|'InProgress'|'Failed'|'Success'
}
Response Structure
(dict) --
appArn (string) --
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
appVersion (string) --
The version of the application.
resolutionId (string) --
The identifier for a specific resolution.
status (string) --
The status of the action.
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 :dcps: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',
'complianceStatus': 'PolicyBreached'|'PolicyMet'|'NotAssessed'|'ChangesDetected',
'creationTime': datetime(2015, 1, 1),
'description': 'string',
'name': 'string',
'resiliencyScore': 123.0
},
],
'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 :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
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.
nextToken (string) --
The token for the next set of results, or null if there are no more results.
Describes a specified resiliency policy for an AWS Resilience Hub application. The returned policy object includes creation time, data location constraints, the Amazon Resource Name (ARN) for the policy, tags, tier, and more.
See also: AWS API Documentation
Request Syntax
client.describe_resiliency_policy(
policyArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition :dcps:region :account :resiliency-policy/policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
dict
Response Syntax
{
'policy': {
'creationTime': datetime(2015, 1, 1),
'dataLocationConstraint': 'AnyLocation'|'SameContinent'|'SameCountry',
'estimatedCostTier': 'L1'|'L2'|'L3'|'L4',
'policy': {
'string': {
'rpoInSecs': 123,
'rtoInSecs': 123
}
},
'policyArn': 'string',
'policyDescription': 'string',
'policyName': 'string',
'tags': {
'string': 'string'
},
'tier': 'MissionCritical'|'Critical'|'Important'|'CoreServices'|'NonCritical'
}
}
Response Structure
(dict) --
policy (dict) --
Information about the specific resiliency policy, returned as an object. This object includes creation time, data location constraints, its name, description, tags, the recovery time objective (RTO) and recovery point objective (RPO) in seconds, and more.
creationTime (datetime) --
The timestamp for when the resiliency policy was created.
dataLocationConstraint (string) --
Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
estimatedCostTier (string) --
Specifies the estimated cost tier of the resiliency policy.
policy (dict) --
The resiliency policy.
(string) --
(dict) --
Defines a failure policy.
rpoInSecs (integer) --
The Recovery Point Objective (RPO), in seconds.
rtoInSecs (integer) --
The Recovery Time Objective (RTO), in seconds.
policyArn (string) --
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition :dcps:region :account :resiliency-policy/policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
policyDescription (string) --
The description for the policy.
policyName (string) --
The name of the policy
tags (dict) --
The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
(string) --
(string) --
tier (string) --
The tier for this resiliency policy, ranging from the highest severity (MissionCritical ) to lowest (NonCritical ).
Lists the suggested resiliency policies for the Resilience Hub applications.
See also: AWS API Documentation
Request Syntax
client.list_suggested_resiliency_policies(
maxResults=123,
nextToken='string'
)
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
{
'nextToken': 'string',
'resiliencyPolicies': [
{
'creationTime': datetime(2015, 1, 1),
'dataLocationConstraint': 'AnyLocation'|'SameContinent'|'SameCountry',
'estimatedCostTier': 'L1'|'L2'|'L3'|'L4',
'policy': {
'string': {
'rpoInSecs': 123,
'rtoInSecs': 123
}
},
'policyArn': 'string',
'policyDescription': 'string',
'policyName': 'string',
'tags': {
'string': 'string'
},
'tier': 'MissionCritical'|'Critical'|'Important'|'CoreServices'|'NonCritical'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token for the next set of results, or null if there are no more results.
resiliencyPolicies (list) --
The suggested resiliency policies for the Resilience Hub applications.
(dict) --
Defines a resiliency policy.
creationTime (datetime) --
The timestamp for when the resiliency policy was created.
dataLocationConstraint (string) --
Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
estimatedCostTier (string) --
Specifies the estimated cost tier of the resiliency policy.
policy (dict) --
The resiliency policy.
(string) --
(dict) --
Defines a failure policy.
rpoInSecs (integer) --
The Recovery Point Objective (RPO), in seconds.
rtoInSecs (integer) --
The Recovery Time Objective (RTO), in seconds.
policyArn (string) --
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition :dcps:region :account :resiliency-policy/policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
policyDescription (string) --
The description for the policy.
policyName (string) --
The name of the policy
tags (dict) --
The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
(string) --
(string) --
tier (string) --
The tier for this resiliency policy, ranging from the highest severity (MissionCritical ) to lowest (NonCritical ).
Updates a resiliency policy.
See also: AWS API Documentation
Request Syntax
client.update_resiliency_policy(
dataLocationConstraint='AnyLocation'|'SameContinent'|'SameCountry',
policy={
'string': {
'rpoInSecs': 123,
'rtoInSecs': 123
}
},
policyArn='string',
policyDescription='string',
policyName='string',
tier='MissionCritical'|'Critical'|'Important'|'CoreServices'|'NonCritical'
)
string
Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
dict
The type of resiliency policy to be created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.
(string) --
(dict) --
Defines a failure policy.
rpoInSecs (integer) -- [REQUIRED]
The Recovery Point Objective (RPO), in seconds.
rtoInSecs (integer) -- [REQUIRED]
The Recovery Time Objective (RTO), in seconds.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition :dcps:region :account :resiliency-policy/policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
string
The description for the policy.
string
The name of the policy
string
The tier for this resiliency policy, ranging from the highest severity (MissionCritical ) to lowest (NonCritical ).
dict
Response Syntax
{
'policy': {
'creationTime': datetime(2015, 1, 1),
'dataLocationConstraint': 'AnyLocation'|'SameContinent'|'SameCountry',
'estimatedCostTier': 'L1'|'L2'|'L3'|'L4',
'policy': {
'string': {
'rpoInSecs': 123,
'rtoInSecs': 123
}
},
'policyArn': 'string',
'policyDescription': 'string',
'policyName': 'string',
'tags': {
'string': 'string'
},
'tier': 'MissionCritical'|'Critical'|'Important'|'CoreServices'|'NonCritical'
}
}
Response Structure
(dict) --
policy (dict) --
The type of resiliency policy that was updated, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.
creationTime (datetime) --
The timestamp for when the resiliency policy was created.
dataLocationConstraint (string) --
Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
estimatedCostTier (string) --
Specifies the estimated cost tier of the resiliency policy.
policy (dict) --
The resiliency policy.
(string) --
(dict) --
Defines a failure policy.
rpoInSecs (integer) --
The Recovery Point Objective (RPO), in seconds.
rtoInSecs (integer) --
The Recovery Time Objective (RTO), in seconds.
policyArn (string) --
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition :dcps:region :account :resiliency-policy/policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
policyDescription (string) --
The description for the policy.
policyName (string) --
The name of the policy
tags (dict) --
The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
(string) --
(string) --
tier (string) --
The tier for this resiliency policy, ranging from the highest severity (MissionCritical ) to lowest (NonCritical ).
Describes an assessment for an AWS Resilience Hub application.
See also: AWS API Documentation
Request Syntax
client.describe_app_assessment(
assessmentArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition :dcps:region :account :app-assessment/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
dict
Response Syntax
{
'assessment': {
'appArn': 'string',
'appVersion': 'string',
'assessmentArn': 'string',
'assessmentName': 'string',
'assessmentStatus': 'Pending'|'InProgress'|'Failed'|'Success',
'compliance': {
'string': {
'achievableRpoInSecs': 123,
'achievableRtoInSecs': 123,
'complianceStatus': 'PolicyBreached'|'PolicyMet',
'currentRpoInSecs': 123,
'currentRtoInSecs': 123,
'message': 'string',
'rpoDescription': 'string',
'rpoReferenceId': 'string',
'rtoDescription': 'string',
'rtoReferenceId': 'string'
}
},
'complianceStatus': 'PolicyBreached'|'PolicyMet',
'cost': {
'amount': 123.0,
'currency': 'string',
'frequency': 'Hourly'|'Daily'|'Monthly'|'Yearly'
},
'endTime': datetime(2015, 1, 1),
'invoker': 'User'|'System',
'message': 'string',
'policy': {
'creationTime': datetime(2015, 1, 1),
'dataLocationConstraint': 'AnyLocation'|'SameContinent'|'SameCountry',
'estimatedCostTier': 'L1'|'L2'|'L3'|'L4',
'policy': {
'string': {
'rpoInSecs': 123,
'rtoInSecs': 123
}
},
'policyArn': 'string',
'policyDescription': 'string',
'policyName': 'string',
'tags': {
'string': 'string'
},
'tier': 'MissionCritical'|'Critical'|'Important'|'CoreServices'|'NonCritical'
},
'resiliencyScore': {
'disruptionScore': {
'string': 123.0
},
'score': 123.0
},
'startTime': datetime(2015, 1, 1),
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
assessment (dict) --
The assessment for an AWS Resilience Hub application, returned as an object. This object includes Amazon Resource Names (ARNs), compliance information, compliance status, cost, messages, resiliency scores, and more.
appArn (string) --
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
appVersion (string) --
The version of the application.
assessmentArn (string) --
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition :dcps:region :account :app-assessment/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
assessmentName (string) --
The name of the assessment.
assessmentStatus (string) --
The current status of the assessment for the resiliency policy.
compliance (dict) --
The application compliance against the resiliency policy.
(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.
complianceStatus (string) --
The current status of the compliance for the resiliency policy.
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.
endTime (datetime) --
The end time for the action.
invoker (string) --
The entity that invoked the assessment.
message (string) --
Error or warning message from the assessment execution
policy (dict) --
The resiliency policy.
creationTime (datetime) --
The timestamp for when the resiliency policy was created.
dataLocationConstraint (string) --
Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
estimatedCostTier (string) --
Specifies the estimated cost tier of the resiliency policy.
policy (dict) --
The resiliency policy.
(string) --
(dict) --
Defines a failure policy.
rpoInSecs (integer) --
The Recovery Point Objective (RPO), in seconds.
rtoInSecs (integer) --
The Recovery Time Objective (RTO), in seconds.
policyArn (string) --
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition :dcps:region :account :resiliency-policy/policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
policyDescription (string) --
The description for the policy.
policyName (string) --
The name of the policy
tags (dict) --
The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
(string) --
(string) --
tier (string) --
The tier for this resiliency policy, ranging from the highest severity (MissionCritical ) to lowest (NonCritical ).
resiliencyScore (dict) --
The current resiliency score for the application.
disruptionScore (dict) --
The disruption score for a valid key.
(string) --
(float) --
score (float) --
The outage score for a valid key.
startTime (datetime) --
The starting time for the action.
tags (dict) --
The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
(string) --
(string) --
Lists the alarm recommendations for a AWS Resilience Hub application.
See also: AWS API Documentation
Request Syntax
client.list_alarm_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 :dcps: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
{
'alarmRecommendations': [
{
'appComponentName': 'string',
'description': 'string',
'items': [
{
'alreadyImplemented': True|False,
'resourceId': 'string',
'targetAccountId': 'string',
'targetRegion': 'string'
},
],
'name': 'string',
'prerequisite': 'string',
'recommendationId': 'string',
'referenceId': 'string',
'type': 'Metric'|'Composite'|'Canary'|'Logs'|'Event'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
alarmRecommendations (list) --
The alarm recommendations for an AWS Resilience Hub application, returned as an object. This object includes application component names, descriptions, information about whether a recommendation has already been implemented or not, prerequisites, and more.
(dict) --
Defines a recommendation for a CloudWatch alarm.
appComponentName (string) --
The application component for the CloudWatch alarm recommendation.
description (string) --
The description of the recommendation.
items (list) --
The list of CloudWatch alarm recommendations.
(dict) --
Defines a recommendation.
alreadyImplemented (boolean) --
Specifies if the recommendation has already been implemented.
resourceId (string) --
The resource identifier.
targetAccountId (string) --
The target account identifier.
targetRegion (string) --
The target region.
name (string) --
The name of the alarm recommendation.
prerequisite (string) --
The prerequisite for the alarm recommendation.
recommendationId (string) --
The identifier of the alarm recommendation.
referenceId (string) --
The reference identifier of the alarm recommendation.
type (string) --
The type of alarm recommendation.
nextToken (string) --
The token for the next set of results, or null if there are no more results.
Describes an AWS Resilience Hub application.
See also: AWS API Documentation
Request Syntax
client.describe_app(
appArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
dict
Response Syntax
{
'app': {
'appArn': 'string',
'complianceStatus': 'PolicyBreached'|'PolicyMet'|'NotAssessed'|'ChangesDetected',
'creationTime': datetime(2015, 1, 1),
'description': 'string',
'lastAppComplianceEvaluationTime': datetime(2015, 1, 1),
'lastResiliencyScoreEvaluationTime': datetime(2015, 1, 1),
'name': 'string',
'policyArn': 'string',
'resiliencyScore': 123.0,
'status': 'Active'|'Deleting',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
app (dict) --
The specified application, returned as an object with details including compliance status, creation time, description, resiliency score, and more.
appArn (string) --
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
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.
lastAppComplianceEvaluationTime (datetime) --
The timestamp for the most recent compliance evaluation.
lastResiliencyScoreEvaluationTime (datetime) --
The timestamp for the most recent resiliency score evaluation.
name (string) --
The name for the application.
policyArn (string) --
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition :dcps:region :account :resiliency-policy/policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
resiliencyScore (float) --
The current resiliency score for the application.
status (string) --
The status of the action.
tags (dict) --
The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
(string) --
(string) --
Removes one or more tags from a resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
list
[REQUIRED]
The keys of the tags to remove.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes an AWS Resilience Hub application. This is a destructive action that can't be undone.
See also: AWS API Documentation
Request Syntax
client.delete_app(
appArn='string',
clientToken='string',
forceDelete=True|False
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
string
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
This field is autopopulated if not provided.
boolean
A boolean option to force the deletion of a Resilience Hub application.
dict
Response Syntax
{
'appArn': 'string'
}
Response Structure
(dict) --
appArn (string) --
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
Describes details about an AWS Resilience Hub
See also: AWS API Documentation
Request Syntax
client.describe_app_version_template(
appArn='string',
appVersion='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
string
[REQUIRED]
The version of the application.
dict
Response Syntax
{
'appArn': 'string',
'appTemplateBody': 'string',
'appVersion': 'string'
}
Response Structure
(dict) --
appArn (string) --
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
appTemplateBody (string) --
The body of the template.
appVersion (string) --
The version of the application.
Lists the test recommendations for the Resilience Hub application.
See also: AWS API Documentation
Request Syntax
client.list_test_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 :dcps: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
{
'nextToken': 'string',
'testRecommendations': [
{
'appComponentName': 'string',
'description': 'string',
'intent': 'string',
'items': [
{
'alreadyImplemented': True|False,
'resourceId': 'string',
'targetAccountId': 'string',
'targetRegion': 'string'
},
],
'name': 'string',
'prerequisite': 'string',
'recommendationId': 'string',
'referenceId': 'string',
'risk': 'Small'|'Medium'|'High',
'type': 'Software'|'Hardware'|'AZ'|'Region'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token for the next set of results, or null if there are no more results.
testRecommendations (list) --
The test recommendations for the Resilience Hub application.
(dict) --
Defines a test recommendation.
appComponentName (string) --
The name of the application component.
description (string) --
The description for the test recommendation.
intent (string) --
The intent of the test recommendation.
items (list) --
The test recommendation items.
(dict) --
Defines a recommendation.
alreadyImplemented (boolean) --
Specifies if the recommendation has already been implemented.
resourceId (string) --
The resource identifier.
targetAccountId (string) --
The target account identifier.
targetRegion (string) --
The target region.
name (string) --
The name of the test recommendation.
prerequisite (string) --
The prerequisite of the test recommendation.
recommendationId (string) --
Identifier for the test recommendation.
referenceId (string) --
The reference identifier for the test recommendation.
risk (string) --
The level of risk for this test recommendation.
type (string) --
The type of test recommendation.
Lists the resources that are not currently supported in AWS Resilience Hub. An unsupported resource is a resource that exists in the object that was used to create an app, but is not supported by Resilience Hub.
See also: AWS API Documentation
Request Syntax
client.list_unsupported_app_version_resources(
appArn='string',
appVersion='string',
maxResults=123,
nextToken='string',
resolutionId='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
string
[REQUIRED]
The version of the application.
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.
string
The identifier for a specific resolution.
dict
Response Syntax
{
'nextToken': 'string',
'resolutionId': 'string',
'unsupportedResources': [
{
'logicalResourceId': {
'identifier': 'string',
'logicalStackName': 'string',
'resourceGroupName': 'string'
},
'physicalResourceId': {
'awsAccountId': 'string',
'awsRegion': 'string',
'identifier': 'string',
'type': 'Arn'|'Native'
},
'resourceType': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token for the next set of results, or null if there are no more results.
resolutionId (string) --
The identifier for a specific resolution.
unsupportedResources (list) --
The unsupported resources for the application.
(dict) --
Defines a resource that is not supported by Resilience Hub.
logicalResourceId (dict) --
The logical resource identifier for the unsupported resource.
identifier (string) --
The identifier of the resource.
logicalStackName (string) --
The name of the CloudFormation stack this resource belongs to.
resourceGroupName (string) --
The name of the resource group that this resource belongs to.
physicalResourceId (dict) --
The physical resource identifier for the unsupported resource.
awsAccountId (string) --
The Amazon Web Services account that owns the physical resource.
awsRegion (string) --
The Amazon Web Services Region that the physical resource is located in.
identifier (string) --
The identifier of the physical resource.
type (string) --
Specifies the type of physical resource identifier.
Arn
The resource identifier is an Amazon Resource Name (ARN) .
Native
The resource identifier is a Resilience Hub-native identifier.
resourceType (string) --
The type of resource.
Lists how the resources in an application version are mapped/sourced from. Mappings can be physical resource identifiers, CloudFormation stacks, resource-groups, or an application registry app.
See also: AWS API Documentation
Request Syntax
client.list_app_version_resource_mappings(
appArn='string',
appVersion='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
string
[REQUIRED]
The version of the application.
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
{
'nextToken': 'string',
'resourceMappings': [
{
'appRegistryAppName': 'string',
'logicalStackName': 'string',
'mappingType': 'CfnStack'|'Resource'|'AppRegistryApp'|'ResourceGroup',
'physicalResourceId': {
'awsAccountId': 'string',
'awsRegion': 'string',
'identifier': 'string',
'type': 'Arn'|'Native'
},
'resourceGroupName': 'string',
'resourceName': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token for the next set of results, or null if there are no more results.
resourceMappings (list) --
Mappings used to map logical resources from the template to physical resources. You can use the mapping type CFN_STACK if the application template uses a logical stack name. Or you can map individual resources by using the mapping type RESOURCE . We recommend using the mapping type CFN_STACK if the application is backed by a CloudFormation stack.
(dict) --
Defines a resource mapping.
appRegistryAppName (string) --
The name of the application this resource is mapped to.
logicalStackName (string) --
The name of the CloudFormation stack this resource is mapped to.
mappingType (string) --
Specifies the type of resource mapping.
AppRegistryApp
The resource is mapped to another application. The name of the application is contained in the appRegistryAppName property.
CfnStack
The resource is mapped to a CloudFormation stack. The name of the CloudFormation stack is contained in the logicalStackName property.
Resource
The resource is mapped to another resource. The name of the resource is contained in the resourceName property.
ResourceGroup
The resource is mapped to a resource group. The name of the resource group is contained in the resourceGroupName property.
physicalResourceId (dict) --
The identifier of this resource.
awsAccountId (string) --
The Amazon Web Services account that owns the physical resource.
awsRegion (string) --
The Amazon Web Services Region that the physical resource is located in.
identifier (string) --
The identifier of the physical resource.
type (string) --
Specifies the type of physical resource identifier.
Arn
The resource identifier is an Amazon Resource Name (ARN) .
Native
The resource identifier is a Resilience Hub-native identifier.
resourceGroupName (string) --
The name of the resource group this resource is mapped to.
resourceName (string) --
The name of the resource this resource is mapped to.
Lists the standard operating procedure (SOP) recommendations for the Resilience Hub applications.
See also: AWS API Documentation
Request Syntax
client.list_sop_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 :dcps: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
{
'nextToken': 'string',
'sopRecommendations': [
{
'appComponentName': 'string',
'description': 'string',
'items': [
{
'alreadyImplemented': True|False,
'resourceId': 'string',
'targetAccountId': 'string',
'targetRegion': 'string'
},
],
'name': 'string',
'prerequisite': 'string',
'recommendationId': 'string',
'referenceId': 'string',
'serviceType': 'SSM'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token for the next set of results, or null if there are no more results.
sopRecommendations (list) --
The standard operating procedure (SOP) recommendations for the Resilience Hub applications.
(dict) --
Defines a standard operating procedure (SOP) recommendation.
appComponentName (string) --
The application component name.
description (string) --
The description of the SOP recommendation.
items (list) --
The recommendation items.
(dict) --
Defines a recommendation.
alreadyImplemented (boolean) --
Specifies if the recommendation has already been implemented.
resourceId (string) --
The resource identifier.
targetAccountId (string) --
The target account identifier.
targetRegion (string) --
The target region.
name (string) --
The name of the SOP recommendation.
prerequisite (string) --
The prerequisite for the SOP recommendation.
recommendationId (string) --
Identifier for the SOP recommendation.
referenceId (string) --
The reference identifier for the SOP recommendation.
serviceType (string) --
The service type.
Lists the recommendation templates for the Resilience Hub applications.
See also: AWS API Documentation
Request Syntax
client.list_recommendation_templates(
assessmentArn='string',
maxResults=123,
name='string',
nextToken='string',
recommendationTemplateArn='string',
reverseOrder=True|False,
status=[
'Pending'|'InProgress'|'Failed'|'Success',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition :dcps: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
The name for one of the listed recommendation templates.
string
Null, or the token from a previous call to get the next set of results.
string
The Amazon Resource Name (ARN) for a recommendation template.
boolean
The default is to sort by ascending startTime . To sort by descending startTime , set reverseOrder to true .
list
The status of the action.
(string) --
dict
Response Syntax
{
'nextToken': 'string',
'recommendationTemplates': [
{
'appArn': 'string',
'assessmentArn': 'string',
'endTime': datetime(2015, 1, 1),
'format': 'CfnYaml'|'CfnJson',
'message': 'string',
'name': 'string',
'needsReplacements': True|False,
'recommendationIds': [
'string',
],
'recommendationTemplateArn': 'string',
'recommendationTypes': [
'Alarm'|'Sop'|'Test',
],
'startTime': datetime(2015, 1, 1),
'status': 'Pending'|'InProgress'|'Failed'|'Success',
'tags': {
'string': 'string'
},
'templatesLocation': {
'bucket': 'string',
'prefix': 'string'
}
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token for the next set of results, or null if there are no more results.
recommendationTemplates (list) --
The recommendation templates for the Resilience Hub applications.
(dict) --
Defines a recommendation template created with the CreateRecommendationTemplate action.
appArn (string) --
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
assessmentArn (string) --
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition :dcps:region :account :app-assessment/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
endTime (datetime) --
The end time for the action.
format (string) --
The format of the recommendation template.
CfnJson
The template is CloudFormation JSON.
CfnYaml
The template is CloudFormation YAML.
message (string) --
The message for the recommendation template.
name (string) --
The name for the recommendation template.
needsReplacements (boolean) --
Indicates if replacements are needed.
recommendationIds (list) --
Identifiers for the recommendations used in the recommendation template.
(string) --
recommendationTemplateArn (string) --
The Amazon Resource Name (ARN) for the recommendation template.
recommendationTypes (list) --
An array of strings that specify the recommendation template type or types.
Alarm
The template is an AlarmRecommendation template.
Sop
The template is a SopRecommendation template.
Test
The template is a TestRecommendation template.
(string) --
startTime (datetime) --
The start time for the action.
status (string) --
The status of the action.
tags (dict) --
The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
(string) --
(string) --
templatesLocation (dict) --
The file location of the template.
bucket (string) --
The name of the Amazon S3 bucket.
prefix (string) --
The prefix for the Amazon S3 bucket.
Deletes a resiliency policy. This is a destructive action that can't be undone.
See also: AWS API Documentation
Request Syntax
client.delete_resiliency_policy(
clientToken='string',
policyArn='string'
)
string
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
This field is autopopulated if not provided.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition :dcps:region :account :resiliency-policy/policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
dict
Response Syntax
{
'policyArn': 'string'
}
Response Structure
(dict) --
policyArn (string) --
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition :dcps:region :account :resiliency-policy/policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
Deletes an AWS Resilience Hub application assessment. This is a destructive action that can't be undone.
See also: AWS API Documentation
Request Syntax
client.delete_app_assessment(
assessmentArn='string',
clientToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition :dcps:region :account :app-assessment/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
string
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
This field is autopopulated if not provided.
dict
Response Syntax
{
'assessmentArn': 'string',
'assessmentStatus': 'Pending'|'InProgress'|'Failed'|'Success'
}
Response Structure
(dict) --
assessmentArn (string) --
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition :dcps:region :account :app-assessment/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
assessmentStatus (string) --
The current status of the assessment for the resiliency policy.
Adds or updates the app template for a draft version of a Resilience Hub app.
See also: AWS API Documentation
Request Syntax
client.put_draft_app_version_template(
appArn='string',
appTemplateBody='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
string
[REQUIRED]
A JSON string that contains the body of the app template.
dict
Response Syntax
{
'appArn': 'string',
'appVersion': 'string'
}
Response Structure
(dict) --
appArn (string) --
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
appVersion (string) --
The version of the application.
Creates a new application assessment for an application.
See also: AWS API Documentation
Request Syntax
client.start_app_assessment(
appArn='string',
appVersion='string',
assessmentName='string',
clientToken='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
string
[REQUIRED]
The version of the application.
string
[REQUIRED]
The name for the assessment.
string
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
This field is autopopulated if not provided.
dict
The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
(string) --
(string) --
dict
Response Syntax
{
'assessment': {
'appArn': 'string',
'appVersion': 'string',
'assessmentArn': 'string',
'assessmentName': 'string',
'assessmentStatus': 'Pending'|'InProgress'|'Failed'|'Success',
'compliance': {
'string': {
'achievableRpoInSecs': 123,
'achievableRtoInSecs': 123,
'complianceStatus': 'PolicyBreached'|'PolicyMet',
'currentRpoInSecs': 123,
'currentRtoInSecs': 123,
'message': 'string',
'rpoDescription': 'string',
'rpoReferenceId': 'string',
'rtoDescription': 'string',
'rtoReferenceId': 'string'
}
},
'complianceStatus': 'PolicyBreached'|'PolicyMet',
'cost': {
'amount': 123.0,
'currency': 'string',
'frequency': 'Hourly'|'Daily'|'Monthly'|'Yearly'
},
'endTime': datetime(2015, 1, 1),
'invoker': 'User'|'System',
'message': 'string',
'policy': {
'creationTime': datetime(2015, 1, 1),
'dataLocationConstraint': 'AnyLocation'|'SameContinent'|'SameCountry',
'estimatedCostTier': 'L1'|'L2'|'L3'|'L4',
'policy': {
'string': {
'rpoInSecs': 123,
'rtoInSecs': 123
}
},
'policyArn': 'string',
'policyDescription': 'string',
'policyName': 'string',
'tags': {
'string': 'string'
},
'tier': 'MissionCritical'|'Critical'|'Important'|'CoreServices'|'NonCritical'
},
'resiliencyScore': {
'disruptionScore': {
'string': 123.0
},
'score': 123.0
},
'startTime': datetime(2015, 1, 1),
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
assessment (dict) --
The assessment created.
appArn (string) --
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
appVersion (string) --
The version of the application.
assessmentArn (string) --
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition :dcps:region :account :app-assessment/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
assessmentName (string) --
The name of the assessment.
assessmentStatus (string) --
The current status of the assessment for the resiliency policy.
compliance (dict) --
The application compliance against the resiliency policy.
(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.
complianceStatus (string) --
The current status of the compliance for the resiliency policy.
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.
endTime (datetime) --
The end time for the action.
invoker (string) --
The entity that invoked the assessment.
message (string) --
Error or warning message from the assessment execution
policy (dict) --
The resiliency policy.
creationTime (datetime) --
The timestamp for when the resiliency policy was created.
dataLocationConstraint (string) --
Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
estimatedCostTier (string) --
Specifies the estimated cost tier of the resiliency policy.
policy (dict) --
The resiliency policy.
(string) --
(dict) --
Defines a failure policy.
rpoInSecs (integer) --
The Recovery Point Objective (RPO), in seconds.
rtoInSecs (integer) --
The Recovery Time Objective (RTO), in seconds.
policyArn (string) --
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition :dcps:region :account :resiliency-policy/policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
policyDescription (string) --
The description for the policy.
policyName (string) --
The name of the policy
tags (dict) --
The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
(string) --
(string) --
tier (string) --
The tier for this resiliency policy, ranging from the highest severity (MissionCritical ) to lowest (NonCritical ).
resiliencyScore (dict) --
The current resiliency score for the application.
disruptionScore (dict) --
The disruption score for a valid key.
(string) --
(float) --
score (float) --
The outage score for a valid key.
startTime (datetime) --
The starting time for the action.
tags (dict) --
The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
(string) --
(string) --
Lists the assessments for an AWS Resilience Hub application. You can use request parameters to refine the results for the response object.
See also: AWS API Documentation
Request Syntax
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
)
string
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
string
The name for the assessment.
list
The current status of the assessment for the resiliency policy.
(string) --
string
The current status of compliance for the resiliency policy.
string
Specifies the entity that invoked a specific assessment, either a User or the System .
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.
boolean
The default is to sort by ascending startTime . To sort by descending startTime , set reverseOrder to true .
dict
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'
},
'endTime': datetime(2015, 1, 1),
'invoker': 'User'|'System',
'message': 'string',
'resiliencyScore': 123.0,
'startTime': datetime(2015, 1, 1)
},
],
'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) --
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
appVersion (string) --
The version of the application.
assessmentArn (string) --
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition :dcps:region :account :app-assessment/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
assessmentName (string) --
The name of the assessment.
assessmentStatus (string) --
The current status of the assessment for the resiliency policy.
complianceStatus (string) --
The current status of compliance for the resiliency policy.
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.
endTime (datetime) --
The end time for the action.
invoker (string) --
The entity that invoked the assessment.
message (string) --
The message from the assessment run.
resiliencyScore (float) --
The current resiliency score for the application.
startTime (datetime) --
The starting time for the action.
nextToken (string) --
The token for the next set of results, or null if there are no more results.
Describes the status of importing resources to an application version.
See also: AWS API Documentation
Request Syntax
client.describe_draft_app_version_resources_import_status(
appArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
dict
Response Syntax
{
'appArn': 'string',
'appVersion': 'string',
'errorMessage': 'string',
'status': 'Pending'|'InProgress'|'Failed'|'Success',
'statusChangeTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
appArn (string) --
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
appVersion (string) --
The version of the application.
errorMessage (string) --
The returned error message for the request.
status (string) --
The status of the action.
statusChangeTime (datetime) --
The timestamp for when the status last changed.
Creates a Resilience Hub application. A Resilience Hub application is a collection of Amazon Web Services resources structured to prevent and recover Amazon Web Services application disruptions. To describe a Resilience Hub application, you provide an application name, resources from one or more–up to five–CloudFormation stacks, and an appropriate resiliency policy.
<p>After you create a Resilience Hub application, you publish it so that you can run a resiliency assessment on it. You can then use recommendations from the assessment to improve resiliency by running another assessment, comparing results, and then iterating the process until you achieve your goals for recovery time objective (RTO) and recovery point objective (RPO).</p>
See also: AWS API Documentation
Request Syntax
client.create_app(
clientToken='string',
description='string',
name='string',
policyArn='string',
tags={
'string': 'string'
}
)
string
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
This field is autopopulated if not provided.
string
The optional description for an app.
string
[REQUIRED]
The name for the application.
string
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition :dcps:region :account :resiliency-policy/policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
dict
The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
(string) --
(string) --
dict
Response Syntax
{
'app': {
'appArn': 'string',
'complianceStatus': 'PolicyBreached'|'PolicyMet'|'NotAssessed'|'ChangesDetected',
'creationTime': datetime(2015, 1, 1),
'description': 'string',
'lastAppComplianceEvaluationTime': datetime(2015, 1, 1),
'lastResiliencyScoreEvaluationTime': datetime(2015, 1, 1),
'name': 'string',
'policyArn': 'string',
'resiliencyScore': 123.0,
'status': 'Active'|'Deleting',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
app (dict) --
The created application returned as an object with details including compliance status, creation time, description, resiliency score, and more.
appArn (string) --
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
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.
lastAppComplianceEvaluationTime (datetime) --
The timestamp for the most recent compliance evaluation.
lastResiliencyScoreEvaluationTime (datetime) --
The timestamp for the most recent resiliency score evaluation.
name (string) --
The name for the application.
policyArn (string) --
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition :dcps:region :account :resiliency-policy/policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
resiliencyScore (float) --
The current resiliency score for the application.
status (string) --
The status of the action.
tags (dict) --
The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
(string) --
(string) --
Returns the resolution status for the specified resolution identifier for an application version. If resolutionId is not specified, the current resolution status is returned.
See also: AWS API Documentation
Request Syntax
client.describe_app_version_resources_resolution_status(
appArn='string',
appVersion='string',
resolutionId='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
string
[REQUIRED]
The version of the application.
string
The identifier for a specific resolution.
dict
Response Syntax
{
'appArn': 'string',
'appVersion': 'string',
'errorMessage': 'string',
'resolutionId': 'string',
'status': 'Pending'|'InProgress'|'Failed'|'Success'
}
Response Structure
(dict) --
appArn (string) --
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
appVersion (string) --
The version of the application.
errorMessage (string) --
The returned error message for the request.
resolutionId (string) --
The identifier for a specific resolution.
status (string) --
The status of the action.
Creates a resiliency policy for an application.
See also: AWS API Documentation
Request Syntax
client.create_resiliency_policy(
clientToken='string',
dataLocationConstraint='AnyLocation'|'SameContinent'|'SameCountry',
policy={
'string': {
'rpoInSecs': 123,
'rtoInSecs': 123
}
},
policyDescription='string',
policyName='string',
tags={
'string': 'string'
},
tier='MissionCritical'|'Critical'|'Important'|'CoreServices'|'NonCritical'
)
string
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
This field is autopopulated if not provided.
string
Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
dict
[REQUIRED]
The type of resiliency policy to be created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.
(string) --
(dict) --
Defines a failure policy.
rpoInSecs (integer) -- [REQUIRED]
The Recovery Point Objective (RPO), in seconds.
rtoInSecs (integer) -- [REQUIRED]
The Recovery Time Objective (RTO), in seconds.
string
The description for the policy.
string
[REQUIRED]
The name of the policy
dict
The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
(string) --
(string) --
string
[REQUIRED]
The tier for this resiliency policy, ranging from the highest severity (MissionCritical ) to lowest (NonCritical ).
dict
Response Syntax
{
'policy': {
'creationTime': datetime(2015, 1, 1),
'dataLocationConstraint': 'AnyLocation'|'SameContinent'|'SameCountry',
'estimatedCostTier': 'L1'|'L2'|'L3'|'L4',
'policy': {
'string': {
'rpoInSecs': 123,
'rtoInSecs': 123
}
},
'policyArn': 'string',
'policyDescription': 'string',
'policyName': 'string',
'tags': {
'string': 'string'
},
'tier': 'MissionCritical'|'Critical'|'Important'|'CoreServices'|'NonCritical'
}
}
Response Structure
(dict) --
policy (dict) --
The type of resiliency policy that was created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.
creationTime (datetime) --
The timestamp for when the resiliency policy was created.
dataLocationConstraint (string) --
Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
estimatedCostTier (string) --
Specifies the estimated cost tier of the resiliency policy.
policy (dict) --
The resiliency policy.
(string) --
(dict) --
Defines a failure policy.
rpoInSecs (integer) --
The Recovery Point Objective (RPO), in seconds.
rtoInSecs (integer) --
The Recovery Time Objective (RTO), in seconds.
policyArn (string) --
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition :dcps:region :account :resiliency-policy/policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
policyDescription (string) --
The description for the policy.
policyName (string) --
The name of the policy
tags (dict) --
The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
(string) --
(string) --
tier (string) --
The tier for this resiliency policy, ranging from the highest severity (MissionCritical ) to lowest (NonCritical ).
Updates an application.
See also: AWS API Documentation
Request Syntax
client.update_app(
appArn='string',
clearResiliencyPolicyArn=True|False,
description='string',
policyArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
boolean
Specifies if the resiliency policy ARN should be cleared.
string
The optional description for an app.
string
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition :dcps:region :account :resiliency-policy/policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
dict
Response Syntax
{
'app': {
'appArn': 'string',
'complianceStatus': 'PolicyBreached'|'PolicyMet'|'NotAssessed'|'ChangesDetected',
'creationTime': datetime(2015, 1, 1),
'description': 'string',
'lastAppComplianceEvaluationTime': datetime(2015, 1, 1),
'lastResiliencyScoreEvaluationTime': datetime(2015, 1, 1),
'name': 'string',
'policyArn': 'string',
'resiliencyScore': 123.0,
'status': 'Active'|'Deleting',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
app (dict) --
The specified application, returned as an object with details including compliance status, creation time, description, resiliency score, and more.
appArn (string) --
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
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.
lastAppComplianceEvaluationTime (datetime) --
The timestamp for the most recent compliance evaluation.
lastResiliencyScoreEvaluationTime (datetime) --
The timestamp for the most recent resiliency score evaluation.
name (string) --
The name for the application.
policyArn (string) --
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition :dcps:region :account :resiliency-policy/policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
resiliencyScore (float) --
The current resiliency score for the application.
status (string) --
The status of the action.
tags (dict) --
The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
(string) --
(string) --
Lists the compliances for an AWS Resilience Hub component.
See also: AWS API Documentation
Request Syntax
client.list_app_component_compliances(
assessmentArn='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition :dcps: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
{
'componentCompliances': [
{
'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'
},
'message': 'string',
'resiliencyScore': {
'disruptionScore': {
'string': 123.0
},
'score': 123.0
},
'status': 'PolicyBreached'|'PolicyMet'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
componentCompliances (list) --
The compliances for an AWS Resilience Hub application component, returned as an object. This object contains component names, compliances, costs, resiliency scores, outage scores, and more.
(dict) --
Defines the compliance of an application component against the resiliency policy.
appComponentName (string) --
The name of the application component.
compliance (dict) --
The compliance of the application component against the resiliency policy.
(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.
message (string) --
The compliance message.
resiliencyScore (dict) --
The current resiliency score for the application.
disruptionScore (dict) --
The disruption score for a valid key.
(string) --
(float) --
score (float) --
The outage score for a valid key.
status (string) --
The status of the action.
nextToken (string) --
The token for the next set of results, or null if there are no more results.
Lists the resiliency policies for the Resilience Hub applications.
See also: AWS API Documentation
Request Syntax
client.list_resiliency_policies(
maxResults=123,
nextToken='string',
policyName='string'
)
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.
string
The name of the policy
dict
Response Syntax
{
'nextToken': 'string',
'resiliencyPolicies': [
{
'creationTime': datetime(2015, 1, 1),
'dataLocationConstraint': 'AnyLocation'|'SameContinent'|'SameCountry',
'estimatedCostTier': 'L1'|'L2'|'L3'|'L4',
'policy': {
'string': {
'rpoInSecs': 123,
'rtoInSecs': 123
}
},
'policyArn': 'string',
'policyDescription': 'string',
'policyName': 'string',
'tags': {
'string': 'string'
},
'tier': 'MissionCritical'|'Critical'|'Important'|'CoreServices'|'NonCritical'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token for the next set of results, or null if there are no more results.
resiliencyPolicies (list) --
The resiliency policies for the Resilience Hub applications.
(dict) --
Defines a resiliency policy.
creationTime (datetime) --
The timestamp for when the resiliency policy was created.
dataLocationConstraint (string) --
Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
estimatedCostTier (string) --
Specifies the estimated cost tier of the resiliency policy.
policy (dict) --
The resiliency policy.
(string) --
(dict) --
Defines a failure policy.
rpoInSecs (integer) --
The Recovery Point Objective (RPO), in seconds.
rtoInSecs (integer) --
The Recovery Time Objective (RTO), in seconds.
policyArn (string) --
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition :dcps:region :account :resiliency-policy/policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
policyDescription (string) --
The description for the policy.
policyName (string) --
The name of the policy
tags (dict) --
The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
(string) --
(string) --
tier (string) --
The tier for this resiliency policy, ranging from the highest severity (MissionCritical ) to lowest (NonCritical ).