ResilienceHub ************* Client ====== class ResilienceHub.Client A low-level client representing AWS Resilience Hub Resilience Hub helps you proactively prepare and protect your Amazon Web Services applications from disruptions. It offers continual resiliency assessment and validation that integrates into your software development lifecycle. This enables you to uncover resiliency weaknesses, ensure recovery time objective (RTO) and recovery point objective (RPO) targets for your applications are met, and resolve issues before they are released into production. import boto3 client = boto3.client('resiliencehub') These are the available methods: * accept_resource_grouping_recommendations * add_draft_app_version_resource_mappings * batch_update_recommendation_status * can_paginate * close * create_app * create_app_version_app_component * create_app_version_resource * create_recommendation_template * create_resiliency_policy * delete_app * delete_app_assessment * delete_app_input_source * delete_app_version_app_component * delete_app_version_resource * delete_recommendation_template * delete_resiliency_policy * describe_app * describe_app_assessment * describe_app_version * describe_app_version_app_component * describe_app_version_resource * describe_app_version_resources_resolution_status * describe_app_version_template * describe_draft_app_version_resources_import_status * describe_metrics_export * describe_resiliency_policy * describe_resource_grouping_recommendation_task * get_paginator * get_waiter * import_resources_to_draft_app_version * list_alarm_recommendations * list_app_assessment_compliance_drifts * list_app_assessment_resource_drifts * list_app_assessments * list_app_component_compliances * list_app_component_recommendations * list_app_input_sources * list_app_version_app_components * list_app_version_resource_mappings * list_app_version_resources * list_app_versions * list_apps * list_metrics * list_recommendation_templates * list_resiliency_policies * list_resource_grouping_recommendations * list_sop_recommendations * list_suggested_resiliency_policies * list_tags_for_resource * list_test_recommendations * list_unsupported_app_version_resources * publish_app_version * put_draft_app_version_template * reject_resource_grouping_recommendations * remove_draft_app_version_resource_mappings * resolve_app_version_resources * start_app_assessment * start_metrics_export * start_resource_grouping_recommendation_task * tag_resource * untag_resource * update_app * update_app_version * update_app_version_app_component * update_app_version_resource * update_resiliency_policy Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListAppAssessmentResourceDrifts * ListMetrics * ListResourceGroupingRecommendations ResilienceHub / Paginator / ListResourceGroupingRecommendations ListResourceGroupingRecommendations *********************************** class ResilienceHub.Paginator.ListResourceGroupingRecommendations paginator = client.get_paginator('list_resource_grouping_recommendations') paginate(**kwargs) Creates an iterator that will paginate through responses from "ResilienceHub.Client.list_resource_grouping_recommendations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( appArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **appArn** (*string*) -- Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'groupingRecommendations': [ { 'confidenceLevel': 'High'|'Medium', 'creationTime': datetime(2015, 1, 1), 'groupingAppComponent': { 'appComponentId': 'string', 'appComponentName': 'string', 'appComponentType': 'string' }, 'groupingRecommendationId': 'string', 'recommendationReasons': [ 'string', ], 'rejectionReason': 'DistinctBusinessPurpose'|'SeparateDataConcern'|'DistinctUserGroupHandling'|'Other', 'resources': [ { 'logicalResourceId': { 'eksSourceName': 'string', 'identifier': 'string', 'logicalStackName': 'string', 'resourceGroupName': 'string', 'terraformSourceName': 'string' }, 'physicalResourceId': { 'awsAccountId': 'string', 'awsRegion': 'string', 'identifier': 'string', 'type': 'Arn'|'Native' }, 'resourceName': 'string', 'resourceType': 'string', 'sourceAppComponentIds': [ 'string', ] }, ], 'score': 123.0, 'status': 'Accepted'|'Rejected'|'PendingDecision' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **groupingRecommendations** *(list) --* List of resource grouping recommendations generated by Resilience Hub. * *(dict) --* Creates a new grouping recommendation. * **confidenceLevel** *(string) --* Indicates the confidence level of Resilience Hub on the grouping recommendation. * **creationTime** *(datetime) --* Indicates the creation time of the grouping recommendation. * **groupingAppComponent** *(dict) --* Indicates the name of the recommended Application Component (AppComponent). * **appComponentId** *(string) --* Indicates the identifier of an AppComponent. * **appComponentName** *(string) --* Indicates the name of an AppComponent. * **appComponentType** *(string) --* Indicates the type of an AppComponent. * **groupingRecommendationId** *(string) --* Indicates all the reasons available for rejecting a grouping recommendation. * **recommendationReasons** *(list) --* Indicates all the reasons available for rejecting a grouping recommendation. * *(string) --* * **rejectionReason** *(string) --* Indicates the reason you had selected while rejecting a grouping recommendation. * **resources** *(list) --* Indicates the resources that are grouped in a recommended AppComponent. * *(dict) --* Indicates the resource that will be grouped in the recommended Application Component (AppComponent). * **logicalResourceId** *(dict) --* Indicates the logical identifier of the resource. * **eksSourceName** *(string) --* Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to. Note: This parameter accepts values in "eks- cluster/namespace" format. * **identifier** *(string) --* 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. * **terraformSourceName** *(string) --* The name of the Terraform S3 state file this resource belongs to. * **physicalResourceId** *(dict) --* Indicates 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) --* Identifier of the physical resource. * **type** *(string) --* Specifies the type of physical resource identifier. Arn The resource identifier is an Amazon Resource Name (ARN) and it can identify the following list of resources: * "AWS::ECS::Service" * "AWS::EFS::FileSystem" * "AWS::ElasticLoadBalancingV2::LoadBalancer" * "AWS::Lambda::Function" * "AWS::SNS::Topic" Native The resource identifier is an Resilience Hub- native identifier and it can identify the following list of resources: * "AWS::ApiGateway::RestApi" * "AWS::ApiGatewayV2::Api" * "AWS::AutoScaling::AutoScalingGroup" * "AWS::DocDB::DBCluster" * "AWS::DocDB::DBGlobalCluster" * "AWS::DocDB::DBInstance" * "AWS::DynamoDB::GlobalTable" * "AWS::DynamoDB::Table" * "AWS::EC2::EC2Fleet" * "AWS::EC2::Instance" * "AWS::EC2::NatGateway" * "AWS::EC2::Volume" * "AWS::ElasticLoadBalancing::LoadBalancer" * "AWS::RDS::DBCluster" * "AWS::RDS::DBInstance" * "AWS::RDS::GlobalCluster" * "AWS::Route53::RecordSet" * "AWS::S3::Bucket" * "AWS::SQS::Queue" * **resourceName** *(string) --* Indicates the resource name. * **resourceType** *(string) --* Indicates the resource type. * **sourceAppComponentIds** *(list) --* Indicates the identifier of the source AppComponents in which the resources were previously grouped into. * *(string) --* * **score** *(float) --* Indicates the confidence level of the grouping recommendation. * **status** *(string) --* Indicates the status of grouping resources into AppComponents. * **NextToken** *(string) --* A token to resume pagination. ResilienceHub / Paginator / ListAppAssessmentResourceDrifts ListAppAssessmentResourceDrifts ******************************* class ResilienceHub.Paginator.ListAppAssessmentResourceDrifts paginator = client.get_paginator('list_app_assessment_resource_drifts') paginate(**kwargs) Creates an iterator that will paginate through responses from "ResilienceHub.Client.list_app_assessment_resource_drifts()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( assessmentArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **assessmentArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app-assessment/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'resourceDrifts': [ { 'appArn': 'string', 'appVersion': 'string', 'diffType': 'NotEqual'|'Added'|'Removed', 'referenceId': 'string', 'resourceIdentifier': { 'logicalResourceId': { 'eksSourceName': 'string', 'identifier': 'string', 'logicalStackName': 'string', 'resourceGroupName': 'string', 'terraformSourceName': 'string' }, 'resourceType': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **resourceDrifts** *(list) --* Indicates all the resource drifts detected for an assessed entity. * *(dict) --* Indicates the resources that have drifted in the current application version. * **appArn** *(string) --* Amazon Resource Name (ARN) of the application whose resources have drifted. The format for this ARN is: arn: "partition":resiliencehub: "region": "account ":app-assessment/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appVersion** *(string) --* Version of the application whose resources have drifted. * **diffType** *(string) --* Indicates if the resource was added or removed. * **referenceId** *(string) --* Reference identifier of the resource drift. * **resourceIdentifier** *(dict) --* Identifier of the drifted resource. * **logicalResourceId** *(dict) --* Logical identifier of the drifted resource. * **eksSourceName** *(string) --* Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to. Note: This parameter accepts values in "eks- cluster/namespace" format. * **identifier** *(string) --* 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. * **terraformSourceName** *(string) --* The name of the Terraform S3 state file this resource belongs to. * **resourceType** *(string) --* Type of the drifted resource. * **NextToken** *(string) --* A token to resume pagination. ResilienceHub / Paginator / ListMetrics ListMetrics *********** class ResilienceHub.Paginator.ListMetrics paginator = client.get_paginator('list_metrics') paginate(**kwargs) Creates an iterator that will paginate through responses from "ResilienceHub.Client.list_metrics()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( conditions=[ { 'field': 'string', 'operator': 'Equals'|'NotEquals'|'GreaterThen'|'GreaterOrEquals'|'LessThen'|'LessOrEquals', 'value': 'string' }, ], dataSource='string', fields=[ { 'aggregation': 'Min'|'Max'|'Sum'|'Avg'|'Count', 'name': 'string' }, ], sorts=[ { 'ascending': True|False, 'field': 'string' }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **conditions** (*list*) -- Indicates the list of all the conditions that were applied on the metrics. * *(dict) --* Indicates the condition based on which you want to filter the metrics. * **field** *(string) --* **[REQUIRED]** Indicates the field in the metric. * **operator** *(string) --* **[REQUIRED]** Indicates the type of operator or comparison to be used when evaluating a condition against the specified field. * **value** *(string) --* Indicates the value or data against which a condition is evaluated. * **dataSource** (*string*) -- Indicates the data source of the metrics. * **fields** (*list*) -- Indicates the list of fields in the data source. * *(dict) --* Indicates the field or attribute of a resource or data structure on which a condition is being applied or evaluated. * **aggregation** *(string) --* (Optional) Indicates the type of aggregation or summary operation (such as Sum, Average, and so on) to be performed on a particular field or set of data. * **name** *(string) --* **[REQUIRED]** Name of the field. * **sorts** (*list*) -- (Optional) Indicates the order in which you want to sort the fields in the metrics. By default, the fields are sorted in the ascending order. * *(dict) --* Indicates the sorting order of the fields in the metrics. * **ascending** *(boolean) --* Indicates the name or identifier of the field or attribute that should be used as the basis for sorting the metrics. * **field** *(string) --* **[REQUIRED]** Indicates the order in which you want to sort the metrics. By default, the list is sorted in ascending order. To sort the list in descending order, set this field to False. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'rows': [ [ 'string', ], ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **rows** *(list) --* Specifies all the list of metric values for each row of metrics. * *(list) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. ResilienceHub / Client / get_paginator get_paginator ************* ResilienceHub.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. ResilienceHub / Client / describe_app_version_app_component describe_app_version_app_component ********************************** ResilienceHub.Client.describe_app_version_app_component(**kwargs) Describes an Application Component in the Resilience Hub application. See also: AWS API Documentation **Request Syntax** response = client.describe_app_version_app_component( appArn='string', appVersion='string', id='string' ) Parameters: * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appVersion** (*string*) -- **[REQUIRED]** Resilience Hub application version. * **id** (*string*) -- **[REQUIRED]** Identifier of the Application Component. Return type: dict Returns: **Response Syntax** { 'appArn': 'string', 'appComponent': { 'additionalInfo': { 'string': [ 'string', ] }, 'id': 'string', 'name': 'string', 'type': 'string' }, 'appVersion': 'string' } **Response Structure** * *(dict) --* * **appArn** *(string) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appComponent** *(dict) --* List of Application Components that belong to this resource. * **additionalInfo** *(dict) --* Additional configuration parameters for an Resilience Hub application. If you want to implement "additionalInfo" through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters. Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.Key: ""failover-regions""Value: ""[{"region":"", "accounts":[{"id":""}]}]"" * *(string) --* * *(list) --* * *(string) --* * **id** *(string) --* Identifier of the Application Component. * **name** *(string) --* Name of the Application Component. * **type** *(string) --* The type of Application Component. * **appVersion** *(string) --* Resilience Hub application version. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / start_resource_grouping_recommendation_task start_resource_grouping_recommendation_task ******************************************* ResilienceHub.Client.start_resource_grouping_recommendation_task(**kwargs) Starts grouping recommendation task. See also: AWS API Documentation **Request Syntax** response = client.start_resource_grouping_recommendation_task( appArn='string' ) Parameters: **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. Return type: dict Returns: **Response Syntax** { 'appArn': 'string', 'errorMessage': 'string', 'groupingId': 'string', 'status': 'Pending'|'InProgress'|'Failed'|'Success' } **Response Structure** * *(dict) --* * **appArn** *(string) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **errorMessage** *(string) --* Error that occurred while executing a grouping recommendation task. * **groupingId** *(string) --* Identifier of the grouping recommendation task. * **status** *(string) --* Status of the action. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / delete_app_version_app_component delete_app_version_app_component ******************************** ResilienceHub.Client.delete_app_version_app_component(**kwargs) Deletes an Application Component from the Resilience Hub application. Note: * This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the "PublishAppVersion" API. * You will not be able to delete an Application Component if it has resources associated with it. See also: AWS API Documentation **Request Syntax** response = client.delete_app_version_app_component( appArn='string', clientToken='string', id='string' ) Parameters: * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **clientToken** (*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. * **id** (*string*) -- **[REQUIRED]** Identifier of the Application Component. Return type: dict Returns: **Response Syntax** { 'appArn': 'string', 'appComponent': { 'additionalInfo': { 'string': [ 'string', ] }, 'id': 'string', 'name': 'string', 'type': 'string' }, 'appVersion': 'string' } **Response Structure** * *(dict) --* * **appArn** *(string) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appComponent** *(dict) --* List of Application Components that belong to this resource. * **additionalInfo** *(dict) --* Additional configuration parameters for an Resilience Hub application. If you want to implement "additionalInfo" through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters. Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.Key: ""failover-regions""Value: ""[{"region":"", "accounts":[{"id":""}]}]"" * *(string) --* * *(list) --* * *(string) --* * **id** *(string) --* Identifier of the Application Component. * **name** *(string) --* Name of the Application Component. * **type** *(string) --* The type of Application Component. * **appVersion** *(string) --* Resilience Hub application version. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / list_resiliency_policies list_resiliency_policies ************************ ResilienceHub.Client.list_resiliency_policies(**kwargs) Lists the resiliency policies for the Resilience Hub applications. See also: AWS API Documentation **Request Syntax** response = client.list_resiliency_policies( maxResults=123, nextToken='string', policyName='string' ) Parameters: * **maxResults** (*integer*) -- 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. * **nextToken** (*string*) -- Null, or the token from a previous call to get the next set of results. * **policyName** (*string*) -- Name of the resiliency policy. Return type: dict Returns: **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'|'NotApplicable' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* 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. Note: Resilience Hub allows you to provide a value of zero for "rtoInSecs" and "rpoInSecs" of your resiliency policy. But, while assessing your application, the lowest possible assessment result is near zero. Hence, if you provide value zero for "rtoInSecs" and "rpoInSecs", the estimated workload RTO and estimated workload RPO result will be near zero and the **Compliance status** for your application will be set to **Policy breached**. * **creationTime** *(datetime) --* Date and time 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) --* Recovery Point Objective (RPO) in seconds. * **rtoInSecs** *(integer) --* Recovery Time Objective (RTO) in seconds. * **policyArn** *(string) --* Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":resiliency-policy/ "policy-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **policyDescription** *(string) --* Description of the resiliency policy. * **policyName** *(string) --* The name of the policy * **tags** *(dict) --* 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"). **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / delete_app_input_source delete_app_input_source *********************** ResilienceHub.Client.delete_app_input_source(**kwargs) Deletes the input source and all of its imported resources from the Resilience Hub application. See also: AWS API Documentation **Request Syntax** response = client.delete_app_input_source( appArn='string', clientToken='string', eksSourceClusterNamespace={ 'eksClusterArn': 'string', 'namespace': 'string' }, sourceArn='string', terraformSource={ 's3StateFileUrl': 'string' } ) Parameters: * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **clientToken** (*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. * **eksSourceClusterNamespace** (*dict*) -- The namespace on your Amazon Elastic Kubernetes Service cluster that you want to delete from the Resilience Hub application. * **eksClusterArn** *(string) --* **[REQUIRED]** Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. The format for this ARN is: arn: "aws":eks: "region": "account-id":cluster/ "cluster-name". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **namespace** *(string) --* **[REQUIRED]** Name of the namespace that is located on your Amazon Elastic Kubernetes Service cluster. * **sourceArn** (*string*) -- The Amazon Resource Name (ARN) of the imported resource you want to remove from the Resilience Hub application. For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **terraformSource** (*dict*) -- The imported Terraform s3 state file you want to remove from the Resilience Hub application. * **s3StateFileUrl** *(string) --* **[REQUIRED]** The URL of the Terraform s3 state file you need to import. Return type: dict Returns: **Response Syntax** { 'appArn': 'string', 'appInputSource': { 'eksSourceClusterNamespace': { 'eksClusterArn': 'string', 'namespace': 'string' }, 'importType': 'CfnStack'|'Resource'|'AppRegistryApp'|'ResourceGroup'|'Terraform'|'EKS', 'resourceCount': 123, 'sourceArn': 'string', 'sourceName': 'string', 'terraformSource': { 's3StateFileUrl': 'string' } } } **Response Structure** * *(dict) --* * **appArn** *(string) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appInputSource** *(dict) --* Name of the input source from where the application resource is imported from. * **eksSourceClusterNamespace** *(dict) --* The namespace on your Amazon Elastic Kubernetes Service cluster. * **eksClusterArn** *(string) --* Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. The format for this ARN is: arn: "aws":eks: "region": "account-id":cluster/ "cluster-name". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **namespace** *(string) --* Name of the namespace that is located on your Amazon Elastic Kubernetes Service cluster. * **importType** *(string) --* The resource type of the input source. * **resourceCount** *(integer) --* The number of resources. * **sourceArn** *(string) --* The Amazon Resource Name (ARN) of the input source. For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **sourceName** *(string) --* The name of the input source. * **terraformSource** *(dict) --* The name of the Terraform s3 state file. * **s3StateFileUrl** *(string) --* The URL of the Terraform s3 state file you need to import. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / list_app_component_recommendations list_app_component_recommendations ********************************** ResilienceHub.Client.list_app_component_recommendations(**kwargs) Lists the recommendations for an Resilience Hub Application Component. See also: AWS API Documentation **Request Syntax** response = client.list_app_component_recommendations( assessmentArn='string', maxResults=123, nextToken='string' ) Parameters: * **assessmentArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app-assessment/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **maxResults** (*integer*) -- 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. * **nextToken** (*string*) -- Null, or the token from a previous call to get the next set of results. Return type: dict Returns: **Response Syntax** { 'componentRecommendations': [ { 'appComponentName': 'string', 'configRecommendations': [ { 'appComponentName': 'string', 'compliance': { 'string': { 'achievableRpoInSecs': 123, 'achievableRtoInSecs': 123, 'complianceStatus': 'PolicyBreached'|'PolicyMet'|'NotApplicable'|'MissingPolicy', 'currentRpoInSecs': 123, 'currentRtoInSecs': 123, 'message': 'string', 'rpoDescription': 'string', 'rpoReferenceId': 'string', 'rtoDescription': 'string', 'rtoReferenceId': 'string' } }, 'cost': { 'amount': 123.0, 'currency': 'string', 'frequency': 'Hourly'|'Daily'|'Monthly'|'Yearly' }, 'description': 'string', 'haArchitecture': 'MultiSite'|'WarmStandby'|'PilotLight'|'BackupAndRestore'|'NoRecoveryPlan', 'name': 'string', 'optimizationType': 'LeastCost'|'LeastChange'|'BestAZRecovery'|'LeastErrors'|'BestAttainable'|'BestRegionRecovery', 'recommendationCompliance': { 'string': { 'expectedComplianceStatus': 'PolicyBreached'|'PolicyMet'|'NotApplicable'|'MissingPolicy', 'expectedRpoDescription': 'string', 'expectedRpoInSecs': 123, 'expectedRtoDescription': 'string', 'expectedRtoInSecs': 123 } }, 'referenceId': 'string', 'suggestedChanges': [ 'string', ] }, ], 'recommendationStatus': 'BreachedUnattainable'|'BreachedCanMeet'|'MetCanImprove'|'MissingPolicy' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **componentRecommendations** *(list) --* The recommendations for an Resilience Hub Application Component, returned as an object. This object contains the names of the Application Components, configuration recommendations, and recommendation statuses. * *(dict) --* Defines recommendations for an Resilience Hub Application Component, returned as an object. This object contains component names, configuration recommendations, and recommendation statuses. * **appComponentName** *(string) --* Name of the Application Component. * **configRecommendations** *(list) --* List of recommendations. * *(dict) --* Defines a recommendation configuration. * **appComponentName** *(string) --* Name of the Application Component. * **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) --* Reference identifier of the RPO . * **rtoDescription** *(string) --* The RTO description. * **rtoReferenceId** *(string) --* Reference identifier of the RTO. * **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) --* Reference identifier for the recommendation configuration. * **suggestedChanges** *(list) --* List of the suggested configuration changes. * *(string) --* * **recommendationStatus** *(string) --* Status of the recommendation. * **nextToken** *(string) --* Token for the next set of results, or null if there are no more results. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / list_app_version_resource_mappings list_app_version_resource_mappings ********************************** ResilienceHub.Client.list_app_version_resource_mappings(**kwargs) 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** response = client.list_app_version_resource_mappings( appArn='string', appVersion='string', maxResults=123, nextToken='string' ) Parameters: * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appVersion** (*string*) -- **[REQUIRED]** The version of the application. * **maxResults** (*integer*) -- 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. * **nextToken** (*string*) -- Null, or the token from a previous call to get the next set of results. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'resourceMappings': [ { 'appRegistryAppName': 'string', 'eksSourceName': 'string', 'logicalStackName': 'string', 'mappingType': 'CfnStack'|'Resource'|'AppRegistryApp'|'ResourceGroup'|'Terraform'|'EKS', 'physicalResourceId': { 'awsAccountId': 'string', 'awsRegion': 'string', 'identifier': 'string', 'type': 'Arn'|'Native' }, 'resourceGroupName': 'string', 'resourceName': 'string', 'terraformSourceName': 'string' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* 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) --* Name of the application this resource is mapped to when the "mappingType" is "AppRegistryApp". * **eksSourceName** *(string) --* Name of the Amazon Elastic Kubernetes Service cluster and namespace that this resource is mapped to when the "mappingType" is "EKS". Note: This parameter accepts values in "eks- cluster/namespace" format. * **logicalStackName** *(string) --* Name of the CloudFormation stack this resource is mapped to when the "mappingType" is "CfnStack". * **mappingType** *(string) --* Specifies the type of resource mapping. * **physicalResourceId** *(dict) --* Identifier of the physical 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) --* Identifier of the physical resource. * **type** *(string) --* Specifies the type of physical resource identifier. Arn The resource identifier is an Amazon Resource Name (ARN) and it can identify the following list of resources: * "AWS::ECS::Service" * "AWS::EFS::FileSystem" * "AWS::ElasticLoadBalancingV2::LoadBalancer" * "AWS::Lambda::Function" * "AWS::SNS::Topic" Native The resource identifier is an Resilience Hub-native identifier and it can identify the following list of resources: * "AWS::ApiGateway::RestApi" * "AWS::ApiGatewayV2::Api" * "AWS::AutoScaling::AutoScalingGroup" * "AWS::DocDB::DBCluster" * "AWS::DocDB::DBGlobalCluster" * "AWS::DocDB::DBInstance" * "AWS::DynamoDB::GlobalTable" * "AWS::DynamoDB::Table" * "AWS::EC2::EC2Fleet" * "AWS::EC2::Instance" * "AWS::EC2::NatGateway" * "AWS::EC2::Volume" * "AWS::ElasticLoadBalancing::LoadBalancer" * "AWS::RDS::DBCluster" * "AWS::RDS::DBInstance" * "AWS::RDS::GlobalCluster" * "AWS::Route53::RecordSet" * "AWS::S3::Bucket" * "AWS::SQS::Queue" * **resourceGroupName** *(string) --* Name of the Resource Groups that this resource is mapped to when the "mappingType" is "ResourceGroup". * **resourceName** *(string) --* Name of the resource that this resource is mapped to when the "mappingType" is "Resource". * **terraformSourceName** *(string) --* Name of the Terraform source that this resource is mapped to when the "mappingType" is "Terraform". **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / describe_app_assessment describe_app_assessment *********************** ResilienceHub.Client.describe_app_assessment(**kwargs) Describes an assessment for an Resilience Hub application. See also: AWS API Documentation **Request Syntax** response = client.describe_app_assessment( assessmentArn='string' ) Parameters: **assessmentArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: "partition":resiliencehub: "region": "account ":app-assessment/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. Return type: dict Returns: **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'|'NotApplicable'|'MissingPolicy', 'currentRpoInSecs': 123, 'currentRtoInSecs': 123, 'message': 'string', 'rpoDescription': 'string', 'rpoReferenceId': 'string', 'rtoDescription': 'string', 'rtoReferenceId': 'string' } }, 'complianceStatus': 'PolicyBreached'|'PolicyMet'|'NotApplicable'|'MissingPolicy', 'cost': { 'amount': 123.0, 'currency': 'string', 'frequency': 'Hourly'|'Daily'|'Monthly'|'Yearly' }, 'driftStatus': 'NotChecked'|'NotDetected'|'Detected', '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'|'NotApplicable' }, 'resiliencyScore': { 'componentScore': { 'string': { 'excludedCount': 123, 'outstandingCount': 123, 'possibleScore': 123.0, 'score': 123.0 } }, 'disruptionScore': { 'string': 123.0 }, 'score': 123.0 }, 'resourceErrorsDetails': { 'hasMoreErrors': True|False, 'resourceErrors': [ { 'logicalResourceId': 'string', 'physicalResourceId': 'string', 'reason': 'string' }, ] }, 'startTime': datetime(2015, 1, 1), 'summary': { 'riskRecommendations': [ { 'appComponents': [ 'string', ], 'recommendation': 'string', 'risk': 'string' }, ], 'summary': 'string' }, 'tags': { 'string': 'string' }, 'versionName': 'string' } } **Response Structure** * *(dict) --* * **assessment** *(dict) --* The assessment for an 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) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appVersion** *(string) --* Version of an application. * **assessmentArn** *(string) --* Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app-assessment/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **assessmentName** *(string) --* Name of the assessment. * **assessmentStatus** *(string) --* Current status of the assessment for the resiliency policy. * **compliance** *(dict) --* 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) --* Reference identifier of the RPO . * **rtoDescription** *(string) --* The RTO description. * **rtoReferenceId** *(string) --* Reference identifier of the RTO. * **complianceStatus** *(string) --* Current status of the compliance for the resiliency policy. * **cost** *(dict) --* Cost for the application. * **amount** *(float) --* The cost amount. * **currency** *(string) --* The cost currency, for example "USD". * **frequency** *(string) --* The cost frequency. * **driftStatus** *(string) --* Indicates if compliance drifts (deviations) were detected while running an assessment for your application. * **endTime** *(datetime) --* 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) --* Resiliency policy of an application. * **creationTime** *(datetime) --* Date and time 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) --* Recovery Point Objective (RPO) in seconds. * **rtoInSecs** *(integer) --* Recovery Time Objective (RTO) in seconds. * **policyArn** *(string) --* Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":resiliency-policy/ "policy-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **policyDescription** *(string) --* Description of the resiliency policy. * **policyName** *(string) --* The name of the policy * **tags** *(dict) --* 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) --* Current resiliency score for an application. * **componentScore** *(dict) --* The score generated by Resilience Hub for the scoring component after running an assessment. For example, if the "score" is 25 points, it indicates the overall score of your application generated by Resilience Hub after running an assessment. * *(string) --* * *(dict) --* Resiliency score of each scoring component. For more information about scoring component, see Calculating resiliency score. * **excludedCount** *(integer) --* Number of recommendations that were excluded from the assessment. For example, if the "excludedCount" for Alarms coverage scoring component is 7, it indicates that 7 Amazon CloudWatch alarms are excluded from the assessment. * **outstandingCount** *(integer) --* Number of recommendations that must be implemented to obtain the maximum possible score for the scoring component. For SOPs, alarms, and tests, these are the number of recommendations that must be implemented. For compliance, these are the number of Application Components that have breached the resiliency policy. For example, if the "outstandingCount" for Alarms coverage scoring component is 5, it indicates that 5 Amazon CloudWatch alarms need to be implemented to achieve the maximum possible score. * **possibleScore** *(float) --* Maximum possible score that can be obtained for the scoring component. For example, if the "possibleScore" is 20 points, it indicates the maximum possible score you can achieve for the scoring component when you run a new assessment after implementing all the Resilience Hub recommendations. * **score** *(float) --* Resiliency score points given for the scoring component. The score is always less than or equal to the "possibleScore". * **disruptionScore** *(dict) --* The disruption score for a valid key. * *(string) --* * *(float) --* * **score** *(float) --* The outage score for a valid key. * **resourceErrorsDetails** *(dict) --* A resource error object containing a list of errors retrieving an application's resources. * **hasMoreErrors** *(boolean) --* This indicates if there are more errors not listed in the "resourceErrors" list. * **resourceErrors** *(list) --* A list of errors retrieving an application's resources. * *(dict) --* Defines application resource errors. * **logicalResourceId** *(string) --* Identifier of the logical resource. * **physicalResourceId** *(string) --* Identifier of the physical resource. * **reason** *(string) --* This is the error message. * **startTime** *(datetime) --* Starting time for the action. * **summary** *(dict) --* Indicates the AI-generated summary for the Resilience Hub assessment, providing a concise overview that highlights the top risks and recommendations. Note: This property is available only in the US East (N. Virginia) Region. * **riskRecommendations** *(list) --* Indicates the top risks and recommendations identified by the Resilience Hub assessment, each representing a specific risk and the corresponding recommendation to address it. Note: This property is available only in the US East (N. Virginia) Region. * *(dict) --* Indicates a specific risk identified in the Resilience Hub assessment and the corresponding recommendation provided to address that risk. Note: The assessment summary generated by large language models (LLMs) on Amazon Bedrock are only suggestions. The current level of generative AI technology is not perfect and LLMs are not infallible. Bias and incorrect answers, although rare, should be expected. Review each recommendation in the assessment summary before you use the output from an LLM. Note: This property is available only in the US East (N. Virginia) Region. * **appComponents** *(list) --* Indicates the Application Components (AppComponents) that were assessed as part of the assessment and are associated with the identified risk and recommendation. Note: This property is available only in the US East (N. Virginia) Region. * *(string) --* * **recommendation** *(string) --* Indicates the recommendation provided by the Resilience Hub to address the identified risks in the application. Note: This property is available only in the US East (N. Virginia) Region. * **risk** *(string) --* Indicates the description of the potential risk identified in the application as part of the Resilience Hub assessment. Note: This property is available only in the US East (N. Virginia) Region. * **summary** *(string) --* Indicates a concise summary that provides an overview of the Resilience Hub assessment. Note: This property is available only in the US East (N. Virginia) Region. * **tags** *(dict) --* 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) --* * **versionName** *(string) --* Version name of the published application. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / can_paginate can_paginate ************ ResilienceHub.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. ResilienceHub / Client / update_resiliency_policy update_resiliency_policy ************************ ResilienceHub.Client.update_resiliency_policy(**kwargs) Updates a resiliency policy. Note: Resilience Hub allows you to provide a value of zero for "rtoInSecs" and "rpoInSecs" of your resiliency policy. But, while assessing your application, the lowest possible assessment result is near zero. Hence, if you provide value zero for "rtoInSecs" and "rpoInSecs", the estimated workload RTO and estimated workload RPO result will be near zero and the **Compliance status** for your application will be set to **Policy breached**. See also: AWS API Documentation **Request Syntax** response = 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'|'NotApplicable' ) Parameters: * **dataLocationConstraint** (*string*) -- Specifies a high- level geographical location constraint for where your resilience policy data can be stored. * **policy** (*dict*) -- 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]** Recovery Point Objective (RPO) in seconds. * **rtoInSecs** *(integer) --* **[REQUIRED]** Recovery Time Objective (RTO) in seconds. * **policyArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":resiliency-policy/ "policy-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **policyDescription** (*string*) -- Description of the resiliency policy. * **policyName** (*string*) -- Name of the resiliency policy. * **tier** (*string*) -- The tier for this resiliency policy, ranging from the highest severity ( "MissionCritical") to lowest ( "NonCritical"). Return type: dict Returns: **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'|'NotApplicable' } } **Response Structure** * *(dict) --* * **policy** *(dict) --* The resiliency policy that was updated, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds. * **creationTime** *(datetime) --* Date and time 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) --* Recovery Point Objective (RPO) in seconds. * **rtoInSecs** *(integer) --* Recovery Time Objective (RTO) in seconds. * **policyArn** *(string) --* Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":resiliency-policy/ "policy-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **policyDescription** *(string) --* Description of the resiliency policy. * **policyName** *(string) --* The name of the policy * **tags** *(dict) --* 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"). **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / reject_resource_grouping_recommendations reject_resource_grouping_recommendations **************************************** ResilienceHub.Client.reject_resource_grouping_recommendations(**kwargs) Rejects resource grouping recommendations. See also: AWS API Documentation **Request Syntax** response = client.reject_resource_grouping_recommendations( appArn='string', entries=[ { 'groupingRecommendationId': 'string', 'rejectionReason': 'DistinctBusinessPurpose'|'SeparateDataConcern'|'DistinctUserGroupHandling'|'Other' }, ] ) Parameters: * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **entries** (*list*) -- **[REQUIRED]** List of resource grouping recommendations you have selected to exclude from your application. * *(dict) --* Indicates the rejected grouping recommendation. * **groupingRecommendationId** *(string) --* **[REQUIRED]** Indicates the identifier of the grouping recommendation. * **rejectionReason** *(string) --* Indicates the reason you had selected while rejecting a grouping recommendation. Return type: dict Returns: **Response Syntax** { 'appArn': 'string', 'failedEntries': [ { 'errorMessage': 'string', 'groupingRecommendationId': 'string' }, ] } **Response Structure** * *(dict) --* * **appArn** *(string) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **failedEntries** *(list) --* List of resource grouping recommendations that failed to get excluded in your application. * *(dict) --* Indicates the accepted grouping recommendation whose implementation failed. * **errorMessage** *(string) --* Indicates the error that occurred while implementing a grouping recommendation. * **groupingRecommendationId** *(string) --* Indicates the identifier of the grouping recommendation. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / list_resource_grouping_recommendations list_resource_grouping_recommendations ************************************** ResilienceHub.Client.list_resource_grouping_recommendations(**kwargs) Lists the resource grouping recommendations suggested by Resilience Hub for your application. See also: AWS API Documentation **Request Syntax** response = client.list_resource_grouping_recommendations( appArn='string', maxResults=123, nextToken='string' ) Parameters: * **appArn** (*string*) -- Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **maxResults** (*integer*) -- Maximum number of grouping recommendations to be displayed per Resilience Hub application. * **nextToken** (*string*) -- Null, or the token from a previous call to get the next set of results. Return type: dict Returns: **Response Syntax** { 'groupingRecommendations': [ { 'confidenceLevel': 'High'|'Medium', 'creationTime': datetime(2015, 1, 1), 'groupingAppComponent': { 'appComponentId': 'string', 'appComponentName': 'string', 'appComponentType': 'string' }, 'groupingRecommendationId': 'string', 'recommendationReasons': [ 'string', ], 'rejectionReason': 'DistinctBusinessPurpose'|'SeparateDataConcern'|'DistinctUserGroupHandling'|'Other', 'resources': [ { 'logicalResourceId': { 'eksSourceName': 'string', 'identifier': 'string', 'logicalStackName': 'string', 'resourceGroupName': 'string', 'terraformSourceName': 'string' }, 'physicalResourceId': { 'awsAccountId': 'string', 'awsRegion': 'string', 'identifier': 'string', 'type': 'Arn'|'Native' }, 'resourceName': 'string', 'resourceType': 'string', 'sourceAppComponentIds': [ 'string', ] }, ], 'score': 123.0, 'status': 'Accepted'|'Rejected'|'PendingDecision' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **groupingRecommendations** *(list) --* List of resource grouping recommendations generated by Resilience Hub. * *(dict) --* Creates a new grouping recommendation. * **confidenceLevel** *(string) --* Indicates the confidence level of Resilience Hub on the grouping recommendation. * **creationTime** *(datetime) --* Indicates the creation time of the grouping recommendation. * **groupingAppComponent** *(dict) --* Indicates the name of the recommended Application Component (AppComponent). * **appComponentId** *(string) --* Indicates the identifier of an AppComponent. * **appComponentName** *(string) --* Indicates the name of an AppComponent. * **appComponentType** *(string) --* Indicates the type of an AppComponent. * **groupingRecommendationId** *(string) --* Indicates all the reasons available for rejecting a grouping recommendation. * **recommendationReasons** *(list) --* Indicates all the reasons available for rejecting a grouping recommendation. * *(string) --* * **rejectionReason** *(string) --* Indicates the reason you had selected while rejecting a grouping recommendation. * **resources** *(list) --* Indicates the resources that are grouped in a recommended AppComponent. * *(dict) --* Indicates the resource that will be grouped in the recommended Application Component (AppComponent). * **logicalResourceId** *(dict) --* Indicates the logical identifier of the resource. * **eksSourceName** *(string) --* Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to. Note: This parameter accepts values in "eks- cluster/namespace" format. * **identifier** *(string) --* 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. * **terraformSourceName** *(string) --* The name of the Terraform S3 state file this resource belongs to. * **physicalResourceId** *(dict) --* Indicates 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) --* Identifier of the physical resource. * **type** *(string) --* Specifies the type of physical resource identifier. Arn The resource identifier is an Amazon Resource Name (ARN) and it can identify the following list of resources: * "AWS::ECS::Service" * "AWS::EFS::FileSystem" * "AWS::ElasticLoadBalancingV2::LoadBalancer" * "AWS::Lambda::Function" * "AWS::SNS::Topic" Native The resource identifier is an Resilience Hub- native identifier and it can identify the following list of resources: * "AWS::ApiGateway::RestApi" * "AWS::ApiGatewayV2::Api" * "AWS::AutoScaling::AutoScalingGroup" * "AWS::DocDB::DBCluster" * "AWS::DocDB::DBGlobalCluster" * "AWS::DocDB::DBInstance" * "AWS::DynamoDB::GlobalTable" * "AWS::DynamoDB::Table" * "AWS::EC2::EC2Fleet" * "AWS::EC2::Instance" * "AWS::EC2::NatGateway" * "AWS::EC2::Volume" * "AWS::ElasticLoadBalancing::LoadBalancer" * "AWS::RDS::DBCluster" * "AWS::RDS::DBInstance" * "AWS::RDS::GlobalCluster" * "AWS::Route53::RecordSet" * "AWS::S3::Bucket" * "AWS::SQS::Queue" * **resourceName** *(string) --* Indicates the resource name. * **resourceType** *(string) --* Indicates the resource type. * **sourceAppComponentIds** *(list) --* Indicates the identifier of the source AppComponents in which the resources were previously grouped into. * *(string) --* * **score** *(float) --* Indicates the confidence level of the grouping recommendation. * **status** *(string) --* Indicates the status of grouping resources into AppComponents. * **nextToken** *(string) --* Null, or the token from a previous call to get the next set of results. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / resolve_app_version_resources resolve_app_version_resources ***************************** ResilienceHub.Client.resolve_app_version_resources(**kwargs) Resolves the resources for an application version. See also: AWS API Documentation **Request Syntax** response = client.resolve_app_version_resources( appArn='string', appVersion='string' ) Parameters: * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appVersion** (*string*) -- **[REQUIRED]** The version of the application. Return type: dict Returns: **Response Syntax** { 'appArn': 'string', 'appVersion': 'string', 'resolutionId': 'string', 'status': 'Pending'|'InProgress'|'Failed'|'Success' } **Response Structure** * *(dict) --* * **appArn** *(string) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appVersion** *(string) --* The version of the application. * **resolutionId** *(string) --* The identifier for a specific resolution. * **status** *(string) --* Status of the action. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / list_app_assessments list_app_assessments ******************** ResilienceHub.Client.list_app_assessments(**kwargs) Lists the assessments for an Resilience Hub application. You can use request parameters to refine the results for the response object. See also: AWS API Documentation **Request Syntax** response = client.list_app_assessments( appArn='string', assessmentName='string', assessmentStatus=[ 'Pending'|'InProgress'|'Failed'|'Success', ], complianceStatus='PolicyBreached'|'PolicyMet'|'NotApplicable'|'MissingPolicy', invoker='User'|'System', maxResults=123, nextToken='string', reverseOrder=True|False ) Parameters: * **appArn** (*string*) -- Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **assessmentName** (*string*) -- The name for the assessment. * **assessmentStatus** (*list*) -- The current status of the assessment for the resiliency policy. * *(string) --* * **complianceStatus** (*string*) -- The current status of compliance for the resiliency policy. * **invoker** (*string*) -- Specifies the entity that invoked a specific assessment, either a "User" or the "System". * **maxResults** (*integer*) -- 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. * **nextToken** (*string*) -- Null, or the token from a previous call to get the next set of results. * **reverseOrder** (*boolean*) -- The default is to sort by ascending **startTime**. To sort by descending **startTime**, set reverseOrder to "true". Return type: dict Returns: **Response Syntax** { 'assessmentSummaries': [ { 'appArn': 'string', 'appVersion': 'string', 'assessmentArn': 'string', 'assessmentName': 'string', 'assessmentStatus': 'Pending'|'InProgress'|'Failed'|'Success', 'complianceStatus': 'PolicyBreached'|'PolicyMet'|'NotApplicable'|'MissingPolicy', 'cost': { 'amount': 123.0, 'currency': 'string', 'frequency': 'Hourly'|'Daily'|'Monthly'|'Yearly' }, 'driftStatus': 'NotChecked'|'NotDetected'|'Detected', 'endTime': datetime(2015, 1, 1), 'invoker': 'User'|'System', 'message': 'string', 'resiliencyScore': 123.0, 'startTime': datetime(2015, 1, 1), 'versionName': 'string' }, ], '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) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appVersion** *(string) --* Version of an application. * **assessmentArn** *(string) --* Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app-assessment/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **assessmentName** *(string) --* Name of the assessment. * **assessmentStatus** *(string) --* Current status of the assessment for the resiliency policy. * **complianceStatus** *(string) --* Current status of compliance for the resiliency policy. * **cost** *(dict) --* Cost for an application. * **amount** *(float) --* The cost amount. * **currency** *(string) --* The cost currency, for example "USD". * **frequency** *(string) --* The cost frequency. * **driftStatus** *(string) --* Indicates if compliance drifts (deviations) were detected while running an assessment for your application. * **endTime** *(datetime) --* End time for the action. * **invoker** *(string) --* Entity that invoked the assessment. * **message** *(string) --* Message from the assessment run. * **resiliencyScore** *(float) --* Current resiliency score for the application. * **startTime** *(datetime) --* Starting time for the action. * **versionName** *(string) --* Name of an application version. * **nextToken** *(string) --* Token for the next set of results, or null if there are no more results. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / list_app_assessment_resource_drifts list_app_assessment_resource_drifts *********************************** ResilienceHub.Client.list_app_assessment_resource_drifts(**kwargs) List of resource drifts that were detected while running an assessment. See also: AWS API Documentation **Request Syntax** response = client.list_app_assessment_resource_drifts( assessmentArn='string', maxResults=123, nextToken='string' ) Parameters: * **assessmentArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app-assessment/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **maxResults** (*integer*) -- Maximum number of drift 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. * **nextToken** (*string*) -- Null, or the token from a previous call to get the next set of results. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'resourceDrifts': [ { 'appArn': 'string', 'appVersion': 'string', 'diffType': 'NotEqual'|'Added'|'Removed', 'referenceId': 'string', 'resourceIdentifier': { 'logicalResourceId': { 'eksSourceName': 'string', 'identifier': 'string', 'logicalStackName': 'string', 'resourceGroupName': 'string', 'terraformSourceName': 'string' }, 'resourceType': 'string' } }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* Null, or the token from a previous call to get the next set of results. * **resourceDrifts** *(list) --* Indicates all the resource drifts detected for an assessed entity. * *(dict) --* Indicates the resources that have drifted in the current application version. * **appArn** *(string) --* Amazon Resource Name (ARN) of the application whose resources have drifted. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app- assessment/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appVersion** *(string) --* Version of the application whose resources have drifted. * **diffType** *(string) --* Indicates if the resource was added or removed. * **referenceId** *(string) --* Reference identifier of the resource drift. * **resourceIdentifier** *(dict) --* Identifier of the drifted resource. * **logicalResourceId** *(dict) --* Logical identifier of the drifted resource. * **eksSourceName** *(string) --* Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to. Note: This parameter accepts values in "eks- cluster/namespace" format. * **identifier** *(string) --* 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. * **terraformSourceName** *(string) --* The name of the Terraform S3 state file this resource belongs to. * **resourceType** *(string) --* Type of the drifted resource. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / update_app_version_app_component update_app_version_app_component ******************************** ResilienceHub.Client.update_app_version_app_component(**kwargs) Updates an existing Application Component in the Resilience Hub application. Note: This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the "PublishAppVersion" API. See also: AWS API Documentation **Request Syntax** response = client.update_app_version_app_component( additionalInfo={ 'string': [ 'string', ] }, appArn='string', id='string', name='string', type='string' ) Parameters: * **additionalInfo** (*dict*) -- Currently, there is no supported additional information for Application Components. * *(string) --* * *(list) --* * *(string) --* * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **id** (*string*) -- **[REQUIRED]** Identifier of the Application Component. * **name** (*string*) -- Name of the Application Component. * **type** (*string*) -- Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent. Return type: dict Returns: **Response Syntax** { 'appArn': 'string', 'appComponent': { 'additionalInfo': { 'string': [ 'string', ] }, 'id': 'string', 'name': 'string', 'type': 'string' }, 'appVersion': 'string' } **Response Structure** * *(dict) --* * **appArn** *(string) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appComponent** *(dict) --* List of Application Components that belong to this resource. * **additionalInfo** *(dict) --* Additional configuration parameters for an Resilience Hub application. If you want to implement "additionalInfo" through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters. Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.Key: ""failover-regions""Value: ""[{"region":"", "accounts":[{"id":""}]}]"" * *(string) --* * *(list) --* * *(string) --* * **id** *(string) --* Identifier of the Application Component. * **name** *(string) --* Name of the Application Component. * **type** *(string) --* The type of Application Component. * **appVersion** *(string) --* Resilience Hub application version. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / start_metrics_export start_metrics_export ******************** ResilienceHub.Client.start_metrics_export(**kwargs) Initiates the export task of metrics. See also: AWS API Documentation **Request Syntax** response = client.start_metrics_export( bucketName='string', clientToken='string' ) Parameters: * **bucketName** (*string*) -- (Optional) Specifies the name of the Amazon Simple Storage Service bucket where the exported metrics will be stored. * **clientToken** (*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. Return type: dict Returns: **Response Syntax** { 'metricsExportId': 'string', 'status': 'Pending'|'InProgress'|'Failed'|'Success' } **Response Structure** * *(dict) --* * **metricsExportId** *(string) --* Identifier of the metrics export task. * **status** *(string) --* Indicates the status of the metrics export task. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ServiceQuotaExceededException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / add_draft_app_version_resource_mappings add_draft_app_version_resource_mappings *************************************** ResilienceHub.Client.add_draft_app_version_resource_mappings(**kwargs) Adds the source of resource-maps to the draft version of an application. During assessment, Resilience Hub will use these resource-maps to resolve the latest physical ID for each resource in the application template. For more information about different types of resources supported by Resilience Hub and how to add them in your application, see Step 2: How is your application managed? in the Resilience Hub User Guide. See also: AWS API Documentation **Request Syntax** response = client.add_draft_app_version_resource_mappings( appArn='string', resourceMappings=[ { 'appRegistryAppName': 'string', 'eksSourceName': 'string', 'logicalStackName': 'string', 'mappingType': 'CfnStack'|'Resource'|'AppRegistryApp'|'ResourceGroup'|'Terraform'|'EKS', 'physicalResourceId': { 'awsAccountId': 'string', 'awsRegion': 'string', 'identifier': 'string', 'type': 'Arn'|'Native' }, 'resourceGroupName': 'string', 'resourceName': 'string', 'terraformSourceName': 'string' }, ] ) Parameters: * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **resourceMappings** (*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) --* Name of the application this resource is mapped to when the "mappingType" is "AppRegistryApp". * **eksSourceName** *(string) --* Name of the Amazon Elastic Kubernetes Service cluster and namespace that this resource is mapped to when the "mappingType" is "EKS". Note: This parameter accepts values in "eks-cluster/namespace" format. * **logicalStackName** *(string) --* Name of the CloudFormation stack this resource is mapped to when the "mappingType" is "CfnStack". * **mappingType** *(string) --* **[REQUIRED]** Specifies the type of resource mapping. * **physicalResourceId** *(dict) --* **[REQUIRED]** Identifier of the physical 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]** 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) and it can identify the following list of resources: * "AWS::ECS::Service" * "AWS::EFS::FileSystem" * "AWS::ElasticLoadBalancingV2::LoadBalancer" * "AWS::Lambda::Function" * "AWS::SNS::Topic" Native The resource identifier is an Resilience Hub-native identifier and it can identify the following list of resources: * "AWS::ApiGateway::RestApi" * "AWS::ApiGatewayV2::Api" * "AWS::AutoScaling::AutoScalingGroup" * "AWS::DocDB::DBCluster" * "AWS::DocDB::DBGlobalCluster" * "AWS::DocDB::DBInstance" * "AWS::DynamoDB::GlobalTable" * "AWS::DynamoDB::Table" * "AWS::EC2::EC2Fleet" * "AWS::EC2::Instance" * "AWS::EC2::NatGateway" * "AWS::EC2::Volume" * "AWS::ElasticLoadBalancing::LoadBalancer" * "AWS::RDS::DBCluster" * "AWS::RDS::DBInstance" * "AWS::RDS::GlobalCluster" * "AWS::Route53::RecordSet" * "AWS::S3::Bucket" * "AWS::SQS::Queue" * **resourceGroupName** *(string) --* Name of the Resource Groups that this resource is mapped to when the "mappingType" is "ResourceGroup". * **resourceName** *(string) --* Name of the resource that this resource is mapped to when the "mappingType" is "Resource". * **terraformSourceName** *(string) --* Name of the Terraform source that this resource is mapped to when the "mappingType" is "Terraform". Return type: dict Returns: **Response Syntax** { 'appArn': 'string', 'appVersion': 'string', 'resourceMappings': [ { 'appRegistryAppName': 'string', 'eksSourceName': 'string', 'logicalStackName': 'string', 'mappingType': 'CfnStack'|'Resource'|'AppRegistryApp'|'ResourceGroup'|'Terraform'|'EKS', 'physicalResourceId': { 'awsAccountId': 'string', 'awsRegion': 'string', 'identifier': 'string', 'type': 'Arn'|'Native' }, 'resourceGroupName': 'string', 'resourceName': 'string', 'terraformSourceName': 'string' }, ] } **Response Structure** * *(dict) --* * **appArn** *(string) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appVersion** *(string) --* The version of the application. * **resourceMappings** *(list) --* List of sources that are used to map a logical resource from the template to a physical resource. You can use sources such as CloudFormation, Terraform state files, AppRegistry applications, or Amazon EKS. * *(dict) --* Defines a resource mapping. * **appRegistryAppName** *(string) --* Name of the application this resource is mapped to when the "mappingType" is "AppRegistryApp". * **eksSourceName** *(string) --* Name of the Amazon Elastic Kubernetes Service cluster and namespace that this resource is mapped to when the "mappingType" is "EKS". Note: This parameter accepts values in "eks- cluster/namespace" format. * **logicalStackName** *(string) --* Name of the CloudFormation stack this resource is mapped to when the "mappingType" is "CfnStack". * **mappingType** *(string) --* Specifies the type of resource mapping. * **physicalResourceId** *(dict) --* Identifier of the physical 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) --* Identifier of the physical resource. * **type** *(string) --* Specifies the type of physical resource identifier. Arn The resource identifier is an Amazon Resource Name (ARN) and it can identify the following list of resources: * "AWS::ECS::Service" * "AWS::EFS::FileSystem" * "AWS::ElasticLoadBalancingV2::LoadBalancer" * "AWS::Lambda::Function" * "AWS::SNS::Topic" Native The resource identifier is an Resilience Hub-native identifier and it can identify the following list of resources: * "AWS::ApiGateway::RestApi" * "AWS::ApiGatewayV2::Api" * "AWS::AutoScaling::AutoScalingGroup" * "AWS::DocDB::DBCluster" * "AWS::DocDB::DBGlobalCluster" * "AWS::DocDB::DBInstance" * "AWS::DynamoDB::GlobalTable" * "AWS::DynamoDB::Table" * "AWS::EC2::EC2Fleet" * "AWS::EC2::Instance" * "AWS::EC2::NatGateway" * "AWS::EC2::Volume" * "AWS::ElasticLoadBalancing::LoadBalancer" * "AWS::RDS::DBCluster" * "AWS::RDS::DBInstance" * "AWS::RDS::GlobalCluster" * "AWS::Route53::RecordSet" * "AWS::S3::Bucket" * "AWS::SQS::Queue" * **resourceGroupName** *(string) --* Name of the Resource Groups that this resource is mapped to when the "mappingType" is "ResourceGroup". * **resourceName** *(string) --* Name of the resource that this resource is mapped to when the "mappingType" is "Resource". * **terraformSourceName** *(string) --* Name of the Terraform source that this resource is mapped to when the "mappingType" is "Terraform". **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ServiceQuotaExceededException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / delete_app_assessment delete_app_assessment ********************* ResilienceHub.Client.delete_app_assessment(**kwargs) Deletes an Resilience Hub application assessment. This is a destructive action that can't be undone. See also: AWS API Documentation **Request Syntax** response = client.delete_app_assessment( assessmentArn='string', clientToken='string' ) Parameters: * **assessmentArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app-assessment/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **clientToken** (*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. Return type: dict Returns: **Response Syntax** { 'assessmentArn': 'string', 'assessmentStatus': 'Pending'|'InProgress'|'Failed'|'Success' } **Response Structure** * *(dict) --* * **assessmentArn** *(string) --* Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app-assessment/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **assessmentStatus** *(string) --* The current status of the assessment for the resiliency policy. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / import_resources_to_draft_app_version import_resources_to_draft_app_version ************************************* ResilienceHub.Client.import_resources_to_draft_app_version(**kwargs) Imports resources to Resilience Hub application draft version from different input sources. For more information about the input sources supported by Resilience Hub, see Discover the structure and describe your Resilience Hub application. See also: AWS API Documentation **Request Syntax** response = client.import_resources_to_draft_app_version( appArn='string', eksSources=[ { 'eksClusterArn': 'string', 'namespaces': [ 'string', ] }, ], importStrategy='AddOnly'|'ReplaceAll', sourceArns=[ 'string', ], terraformSources=[ { 's3StateFileUrl': 'string' }, ] ) Parameters: * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **eksSources** (*list*) -- The input sources of the Amazon Elastic Kubernetes Service resources you need to import. * *(dict) --* The input source of the Amazon Elastic Kubernetes Service cluster. * **eksClusterArn** *(string) --* **[REQUIRED]** Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. The format for this ARN is: arn: "aws":eks: "region": "account-id":cluster/ "cluster- name". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **namespaces** *(list) --* **[REQUIRED]** The list of namespaces located on your Amazon Elastic Kubernetes Service cluster. * *(string) --* * **importStrategy** (*string*) -- The import strategy you would like to set to import resources into Resilience Hub application. * **sourceArns** (*list*) -- The Amazon Resource Names (ARNs) for the resources. * *(string) --* * **terraformSources** (*list*) -- A list of terraform file s3 URLs you need to import. * *(dict) --* The Terraform s3 state file you need to import. * **s3StateFileUrl** *(string) --* **[REQUIRED]** The URL of the Terraform s3 state file you need to import. Return type: dict Returns: **Response Syntax** { 'appArn': 'string', 'appVersion': 'string', 'eksSources': [ { 'eksClusterArn': 'string', 'namespaces': [ 'string', ] }, ], 'sourceArns': [ 'string', ], 'status': 'Pending'|'InProgress'|'Failed'|'Success', 'terraformSources': [ { 's3StateFileUrl': 'string' }, ] } **Response Structure** * *(dict) --* * **appArn** *(string) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appVersion** *(string) --* The version of the application. * **eksSources** *(list) --* The input sources of the Amazon Elastic Kubernetes Service resources you have imported. * *(dict) --* The input source of the Amazon Elastic Kubernetes Service cluster. * **eksClusterArn** *(string) --* Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. The format for this ARN is: arn: "aws":eks: "region": "account-id":cluster/ "cluster-name". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **namespaces** *(list) --* The list of namespaces located on your Amazon Elastic Kubernetes Service cluster. * *(string) --* * **sourceArns** *(list) --* The Amazon Resource Names (ARNs) for the resources you have imported. * *(string) --* * **status** *(string) --* Status of the action. * **terraformSources** *(list) --* A list of terraform file s3 URLs you have imported. * *(dict) --* The Terraform s3 state file you need to import. * **s3StateFileUrl** *(string) --* The URL of the Terraform s3 state file you need to import. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ServiceQuotaExceededException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / create_recommendation_template create_recommendation_template ****************************** ResilienceHub.Client.create_recommendation_template(**kwargs) Creates a new recommendation template for the Resilience Hub application. See also: AWS API Documentation **Request Syntax** response = client.create_recommendation_template( assessmentArn='string', bucketName='string', clientToken='string', format='CfnYaml'|'CfnJson', name='string', recommendationIds=[ 'string', ], recommendationTypes=[ 'Alarm'|'Sop'|'Test', ], tags={ 'string': 'string' } ) Parameters: * **assessmentArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app-assessment/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **bucketName** (*string*) -- The name of the Amazon S3 bucket that will contain the recommendation template. * **clientToken** (*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. * **format** (*string*) -- The format for the recommendation template. CfnJson The template is CloudFormation JSON. CfnYaml The template is CloudFormation YAML. * **name** (*string*) -- **[REQUIRED]** The name for the recommendation template. * **recommendationIds** (*list*) -- Identifiers for the recommendations used to create a recommendation template. * *(string) --* * **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) --* * **tags** (*dict*) -- 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) --* Return type: dict Returns: **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) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **assessmentArn** *(string) --* Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app-assessment/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **endTime** *(datetime) --* The end time for the action. * **format** *(string) --* Format of the recommendation template. CfnJson The template is CloudFormation JSON. CfnYaml The template is CloudFormation YAML. * **message** *(string) --* Message for the recommendation template. * **name** *(string) --* 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) --* 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) --* Status of the action. * **tags** *(dict) --* 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. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ServiceQuotaExceededException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / list_tags_for_resource list_tags_for_resource ********************** ResilienceHub.Client.list_tags_for_resource(**kwargs) Lists the tags for your resources in your Resilience Hub applications. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( resourceArn='string' ) Parameters: **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) for a specific resource in your Resilience Hub application. Return type: dict Returns: **Response Syntax** { 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **tags** *(dict) --* 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) --* **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / untag_resource untag_resource ************** ResilienceHub.Client.untag_resource(**kwargs) Removes one or more tags from a resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( resourceArn='string', tagKeys=[ 'string', ] ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the resource. * **tagKeys** (*list*) -- **[REQUIRED]** The keys of the tags you want to remove. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / list_suggested_resiliency_policies list_suggested_resiliency_policies ********************************** ResilienceHub.Client.list_suggested_resiliency_policies(**kwargs) Lists the suggested resiliency policies for the Resilience Hub applications. See also: AWS API Documentation **Request Syntax** response = client.list_suggested_resiliency_policies( maxResults=123, nextToken='string' ) Parameters: * **maxResults** (*integer*) -- 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. * **nextToken** (*string*) -- Null, or the token from a previous call to get the next set of results. Return type: dict Returns: **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'|'NotApplicable' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* 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. Note: Resilience Hub allows you to provide a value of zero for "rtoInSecs" and "rpoInSecs" of your resiliency policy. But, while assessing your application, the lowest possible assessment result is near zero. Hence, if you provide value zero for "rtoInSecs" and "rpoInSecs", the estimated workload RTO and estimated workload RPO result will be near zero and the **Compliance status** for your application will be set to **Policy breached**. * **creationTime** *(datetime) --* Date and time 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) --* Recovery Point Objective (RPO) in seconds. * **rtoInSecs** *(integer) --* Recovery Time Objective (RTO) in seconds. * **policyArn** *(string) --* Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":resiliency-policy/ "policy-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **policyDescription** *(string) --* Description of the resiliency policy. * **policyName** *(string) --* The name of the policy * **tags** *(dict) --* 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"). **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / get_waiter get_waiter ********** ResilienceHub.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" ResilienceHub / Client / describe_app_version_resources_resolution_status describe_app_version_resources_resolution_status ************************************************ ResilienceHub.Client.describe_app_version_resources_resolution_status(**kwargs) 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** response = client.describe_app_version_resources_resolution_status( appArn='string', appVersion='string', resolutionId='string' ) Parameters: * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appVersion** (*string*) -- **[REQUIRED]** The version of the application. * **resolutionId** (*string*) -- The identifier for a specific resolution. Return type: dict Returns: **Response Syntax** { 'appArn': 'string', 'appVersion': 'string', 'errorMessage': 'string', 'resolutionId': 'string', 'status': 'Pending'|'InProgress'|'Failed'|'Success' } **Response Structure** * *(dict) --* * **appArn** *(string) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **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) --* Status of the action. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / put_draft_app_version_template put_draft_app_version_template ****************************** ResilienceHub.Client.put_draft_app_version_template(**kwargs) Adds or updates the app template for an Resilience Hub application draft version. See also: AWS API Documentation **Request Syntax** response = client.put_draft_app_version_template( appArn='string', appTemplateBody='string' ) Parameters: * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appTemplateBody** (*string*) -- **[REQUIRED]** A JSON string that provides information about your application structure. To learn more about the "appTemplateBody" template, see the sample template provided in the *Examples* section. The "appTemplateBody" JSON string has the following structure: * "resources" The list of logical resources that must be included in the Resilience Hub application. Type: Array Note: Don't add the resources that you want to exclude. Each "resources" array item includes the following fields: * "logicalResourceId" Logical identifier of the resource. Type: Object Each "logicalResourceId" object includes the following fields: * "identifier" Identifier of the resource. Type: String * "logicalStackName" The name of the CloudFormation stack this resource belongs to. Type: String * "resourceGroupName" The name of the resource group this resource belongs to. Type: String * "terraformSourceName" The name of the Terraform S3 state file this resource belongs to. Type: String * "eksSourceName" Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to. Note: This parameter accepts values in "eks- cluster/namespace" format. Type: String * "type" The type of resource. Type: string * "name" The name of the resource. Type: String * "additionalInfo" Additional configuration parameters for an Resilience Hub application. If you want to implement "additionalInfo" through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters. Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: ""failover-regions"" Value: ""[{"region":"", "accounts":[{"id":""}]}]"" * "appComponents" List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added. Type: Array Each "appComponents" array item includes the following fields: * "name" Name of the Application Component. Type: String * "type" Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent. Type: String * "resourceNames" The list of included resources that are assigned to the Application Component. Type: Array of strings * "additionalInfo" Additional configuration parameters for an Resilience Hub application. If you want to implement "additionalInfo" through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters. Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: ""failover-regions"" Value: ""[{"region":"", "accounts":[{"id":""}]}]"" * "excludedResources" The list of logical resource identifiers to be excluded from the application. Type: Array Note: Don't add the resources that you want to include. Each "excludedResources" array item includes the following fields: * "logicalResourceIds" Logical identifier of the resource. Type: Object Note: You can configure only one of the following fields: * "logicalStackName" * "resourceGroupName" * "terraformSourceName" * "eksSourceName" Each "logicalResourceIds" object includes the following fields: * "identifier" Identifier of the resource. Type: String * "logicalStackName" The name of the CloudFormation stack this resource belongs to. Type: String * "resourceGroupName" The name of the resource group this resource belongs to. Type: String * "terraformSourceName" The name of the Terraform S3 state file this resource belongs to. Type: String * "eksSourceName" Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to. Note: This parameter accepts values in "eks- cluster/namespace" format. Type: String * "version" Resilience Hub application version. * "additionalInfo" Additional configuration parameters for an Resilience Hub application. If you want to implement "additionalInfo" through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters. Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: ""failover-regions"" Value: ""[{"region":"", "accounts":[{"id":""}]}]"" Return type: dict Returns: **Response Syntax** { 'appArn': 'string', 'appVersion': 'string' } **Response Structure** * *(dict) --* * **appArn** *(string) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appVersion** *(string) --* The version of the application. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / create_resiliency_policy create_resiliency_policy ************************ ResilienceHub.Client.create_resiliency_policy(**kwargs) Creates a resiliency policy for an application. Note: Resilience Hub allows you to provide a value of zero for "rtoInSecs" and "rpoInSecs" of your resiliency policy. But, while assessing your application, the lowest possible assessment result is near zero. Hence, if you provide value zero for "rtoInSecs" and "rpoInSecs", the estimated workload RTO and estimated workload RPO result will be near zero and the **Compliance status** for your application will be set to **Policy breached**. See also: AWS API Documentation **Request Syntax** response = 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'|'NotApplicable' ) Parameters: * **clientToken** (*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. * **dataLocationConstraint** (*string*) -- Specifies a high- level geographical location constraint for where your resilience policy data can be stored. * **policy** (*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]** Recovery Point Objective (RPO) in seconds. * **rtoInSecs** *(integer) --* **[REQUIRED]** Recovery Time Objective (RTO) in seconds. * **policyDescription** (*string*) -- Description of the resiliency policy. * **policyName** (*string*) -- **[REQUIRED]** Name of the resiliency policy. * **tags** (*dict*) -- 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*) -- **[REQUIRED]** The tier for this resiliency policy, ranging from the highest severity ( "MissionCritical") to lowest ( "NonCritical"). Return type: dict Returns: **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'|'NotApplicable' } } **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) --* Date and time 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) --* Recovery Point Objective (RPO) in seconds. * **rtoInSecs** *(integer) --* Recovery Time Objective (RTO) in seconds. * **policyArn** *(string) --* Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":resiliency-policy/ "policy-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **policyDescription** *(string) --* Description of the resiliency policy. * **policyName** *(string) --* The name of the policy * **tags** *(dict) --* 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"). **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ServiceQuotaExceededException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / create_app create_app ********** ResilienceHub.Client.create_app(**kwargs) Creates an Resilience Hub application. An 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 CloudFormation stacks, Resource Groups, Terraform state files, AppRegistry applications, and an appropriate resiliency policy. In addition, you can also add resources that are located on Amazon Elastic Kubernetes Service (Amazon EKS) clusters as optional resources. For more information about the number of resources supported per application, see Service quotas. After you create an 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). See also: AWS API Documentation **Request Syntax** response = client.create_app( assessmentSchedule='Disabled'|'Daily', awsApplicationArn='string', clientToken='string', description='string', eventSubscriptions=[ { 'eventType': 'ScheduledAssessmentFailure'|'DriftDetected', 'name': 'string', 'snsTopicArn': 'string' }, ], name='string', permissionModel={ 'crossAccountRoleArns': [ 'string', ], 'invokerRoleName': 'string', 'type': 'LegacyIAMUser'|'RoleBased' }, policyArn='string', tags={ 'string': 'string' } ) Parameters: * **assessmentSchedule** (*string*) -- Assessment execution schedule with 'Daily' or 'Disabled' values. * **awsApplicationArn** (*string*) -- Amazon Resource Name (ARN) of Resource Groups group that is integrated with an AppRegistry application. For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **clientToken** (*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. * **description** (*string*) -- The optional description for an app. * **eventSubscriptions** (*list*) -- The list of events you would like to subscribe and get notification for. Currently, Resilience Hub supports only **Drift detected** and **Scheduled assessment failure** events notification. * *(dict) --* Indicates an event you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for **Drift detected** and **Scheduled assessment failure** events. * **eventType** *(string) --* **[REQUIRED]** The type of event you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for **Drift detected** ( "DriftDetected") and **Scheduled assessment failure** ( "ScheduledAssessmentFailure") events. * **name** *(string) --* **[REQUIRED]** Unique name to identify an event subscription. * **snsTopicArn** *(string) --* Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic. The format for this ARN is: "arn:partition:sns:region:account:topic-name". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **name** (*string*) -- **[REQUIRED]** Name of the application. * **permissionModel** (*dict*) -- Defines the roles and credentials that Resilience Hub would use while creating the application, importing its resources, and running an assessment. * **crossAccountRoleArns** *(list) --* Defines a list of role Amazon Resource Names (ARNs) to be used in other accounts. These ARNs are used for querying purposes while importing resources and assessing your application. Note: * These ARNs are required only when your resources are in other accounts and you have different role name in these accounts. Else, the invoker role name will be used in the other accounts. * These roles must have a trust policy with "iam:AssumeRole" permission to the invoker role in the primary account. * *(string) --* * **invokerRoleName** *(string) --* Existing Amazon Web Services IAM role name in the primary Amazon Web Services account that will be assumed by Resilience Hub Service Principle to obtain a read-only access to your application resources while running an assessment. If your IAM role includes a path, you must include the path in the "invokerRoleName" parameter. For example, if your IAM role's ARN is "arn:aws:iam:123456789012:role/my-path/role- name", you should pass "my-path/role-name". Note: * You must have "iam:passRole" permission for this role while creating or updating the application. * Currently, "invokerRoleName" accepts only "[A-Za-z0-9_+=,.@-]" characters. * **type** *(string) --* **[REQUIRED]** Defines how Resilience Hub scans your resources. It can scan for the resources by using a pre-existing role in your Amazon Web Services account, or by using the credentials of the current IAM user. * **policyArn** (*string*) -- Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":resiliency- policy/ "policy-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **tags** (*dict*) -- 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) --* Return type: dict Returns: **Response Syntax** { 'app': { 'appArn': 'string', 'assessmentSchedule': 'Disabled'|'Daily', 'awsApplicationArn': 'string', 'complianceStatus': 'PolicyBreached'|'PolicyMet'|'NotAssessed'|'ChangesDetected'|'NotApplicable'|'MissingPolicy', 'creationTime': datetime(2015, 1, 1), 'description': 'string', 'driftStatus': 'NotChecked'|'NotDetected'|'Detected', 'eventSubscriptions': [ { 'eventType': 'ScheduledAssessmentFailure'|'DriftDetected', 'name': 'string', 'snsTopicArn': 'string' }, ], 'lastAppComplianceEvaluationTime': datetime(2015, 1, 1), 'lastDriftEvaluationTime': datetime(2015, 1, 1), 'lastResiliencyScoreEvaluationTime': datetime(2015, 1, 1), 'name': 'string', 'permissionModel': { 'crossAccountRoleArns': [ 'string', ], 'invokerRoleName': 'string', 'type': 'LegacyIAMUser'|'RoleBased' }, 'policyArn': 'string', 'resiliencyScore': 123.0, 'rpoInSecs': 123, 'rtoInSecs': 123, '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) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **assessmentSchedule** *(string) --* Assessment execution schedule with 'Daily' or 'Disabled' values. * **awsApplicationArn** *(string) --* Amazon Resource Name (ARN) of Resource Groups group that is integrated with an AppRegistry application. For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **complianceStatus** *(string) --* Current status of compliance for the resiliency policy. * **creationTime** *(datetime) --* Date and time when the application was created. * **description** *(string) --* Optional description for an application. * **driftStatus** *(string) --* Indicates if compliance drifts (deviations) were detected while running an assessment for your application. * **eventSubscriptions** *(list) --* The list of events you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for **Drift detected** and **Scheduled assessment failure** events. * *(dict) --* Indicates an event you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for **Drift detected** and **Scheduled assessment failure** events. * **eventType** *(string) --* The type of event you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for **Drift detected** ( "DriftDetected") and **Scheduled assessment failure** ( "ScheduledAssessmentFailure") events. * **name** *(string) --* Unique name to identify an event subscription. * **snsTopicArn** *(string) --* Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic. The format for this ARN is: "arn:partition:sns:region:account:topic-name". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **lastAppComplianceEvaluationTime** *(datetime) --* Date and time the most recent compliance evaluation. * **lastDriftEvaluationTime** *(datetime) --* Indicates the last time that a drift was evaluated. * **lastResiliencyScoreEvaluationTime** *(datetime) --* Date and time the most recent resiliency score evaluation. * **name** *(string) --* Name for the application. * **permissionModel** *(dict) --* Defines the roles and credentials that Resilience Hub would use while creating the application, importing its resources, and running an assessment. * **crossAccountRoleArns** *(list) --* Defines a list of role Amazon Resource Names (ARNs) to be used in other accounts. These ARNs are used for querying purposes while importing resources and assessing your application. Note: * These ARNs are required only when your resources are in other accounts and you have different role name in these accounts. Else, the invoker role name will be used in the other accounts. * These roles must have a trust policy with "iam:AssumeRole" permission to the invoker role in the primary account. * *(string) --* * **invokerRoleName** *(string) --* Existing Amazon Web Services IAM role name in the primary Amazon Web Services account that will be assumed by Resilience Hub Service Principle to obtain a read- only access to your application resources while running an assessment. If your IAM role includes a path, you must include the path in the "invokerRoleName" parameter. For example, if your IAM role's ARN is "arn:aws:iam:123456789012:role /my-path/role-name", you should pass "my-path/role- name". Note: * You must have "iam:passRole" permission for this role while creating or updating the application. * Currently, "invokerRoleName" accepts only "[A-Za-z0-9_+=,.@-]" characters. * **type** *(string) --* Defines how Resilience Hub scans your resources. It can scan for the resources by using a pre-existing role in your Amazon Web Services account, or by using the credentials of the current IAM user. * **policyArn** *(string) --* Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":resiliency-policy/ "policy-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **resiliencyScore** *(float) --* Current resiliency score for the application. * **rpoInSecs** *(integer) --* Recovery Point Objective (RPO) in seconds. * **rtoInSecs** *(integer) --* Recovery Time Objective (RTO) in seconds. * **status** *(string) --* Status of the application. * **tags** *(dict) --* 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) --* **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ServiceQuotaExceededException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / remove_draft_app_version_resource_mappings remove_draft_app_version_resource_mappings ****************************************** ResilienceHub.Client.remove_draft_app_version_resource_mappings(**kwargs) Removes resource mappings from a draft application version. See also: AWS API Documentation **Request Syntax** response = client.remove_draft_app_version_resource_mappings( appArn='string', appRegistryAppNames=[ 'string', ], eksSourceNames=[ 'string', ], logicalStackNames=[ 'string', ], resourceGroupNames=[ 'string', ], resourceNames=[ 'string', ], terraformSourceNames=[ 'string', ] ) Parameters: * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appRegistryAppNames** (*list*) -- The names of the registered applications you want to remove from the resource mappings. * *(string) --* * **eksSourceNames** (*list*) -- The names of the Amazon Elastic Kubernetes Service clusters and namespaces you want to remove from the resource mappings. Note: This parameter accepts values in "eks-cluster/namespace" format. * *(string) --* * **logicalStackNames** (*list*) -- The names of the CloudFormation stacks you want to remove from the resource mappings. * *(string) --* * **resourceGroupNames** (*list*) -- The names of the resource groups you want to remove from the resource mappings. * *(string) --* * **resourceNames** (*list*) -- The names of the resources you want to remove from the resource mappings. * *(string) --* * **terraformSourceNames** (*list*) -- The names of the Terraform sources you want to remove from the resource mappings. * *(string) --* Return type: dict Returns: **Response Syntax** { 'appArn': 'string', 'appVersion': 'string' } **Response Structure** * *(dict) --* * **appArn** *(string) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appVersion** *(string) --* The version of the application. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / list_alarm_recommendations list_alarm_recommendations ************************** ResilienceHub.Client.list_alarm_recommendations(**kwargs) Lists the alarm recommendations for an Resilience Hub application. See also: AWS API Documentation **Request Syntax** response = client.list_alarm_recommendations( assessmentArn='string', maxResults=123, nextToken='string' ) Parameters: * **assessmentArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app-assessment/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **maxResults** (*integer*) -- 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. * **nextToken** (*string*) -- Null, or the token from a previous call to get the next set of results. Return type: dict Returns: **Response Syntax** { 'alarmRecommendations': [ { 'appComponentName': 'string', 'appComponentNames': [ 'string', ], 'description': 'string', 'items': [ { 'alreadyImplemented': True|False, 'discoveredAlarm': { 'alarmArn': 'string', 'source': 'string' }, 'excludeReason': 'AlreadyImplemented'|'NotRelevant'|'ComplexityOfImplementation', 'excluded': True|False, 'latestDiscoveredExperiment': { 'experimentArn': 'string', 'experimentTemplateId': 'string' }, 'resourceId': 'string', 'targetAccountId': 'string', 'targetRegion': 'string' }, ], 'name': 'string', 'prerequisite': 'string', 'recommendationId': 'string', 'recommendationStatus': 'Implemented'|'Inactive'|'NotImplemented'|'Excluded', 'referenceId': 'string', 'type': 'Metric'|'Composite'|'Canary'|'Logs'|'Event' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **alarmRecommendations** *(list) --* The alarm recommendations for an 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) --* Application Component name for the CloudWatch alarm recommendation. This name is saved as the first item in the "appComponentNames" list. * **appComponentNames** *(list) --* List of Application Component names for the CloudWatch alarm recommendation. * *(string) --* * **description** *(string) --* Description of the alarm recommendation. * **items** *(list) --* List of CloudWatch alarm recommendations. * *(dict) --* Defines a recommendation. * **alreadyImplemented** *(boolean) --* Specifies if the recommendation has already been implemented. * **discoveredAlarm** *(dict) --* Indicates the previously implemented Amazon CloudWatch alarm discovered by Resilience Hub. * **alarmArn** *(string) --* Amazon Resource Name (ARN) of the Amazon CloudWatch alarm. * **source** *(string) --* Indicates the source of the Amazon CloudWatch alarm. That is, it indicates if the alarm was created using Resilience Hub recommendation ( "AwsResilienceHub"), or if you had created the alarm in Amazon CloudWatch ( "Customer"). * **excludeReason** *(string) --* Indicates the reason for excluding an operational recommendation. * **excluded** *(boolean) --* Indicates if an operational recommendation item is excluded. * **latestDiscoveredExperiment** *(dict) --* Indicates the experiment created in FIS that was discovered by Resilience Hub, which matches the recommendation. * **experimentArn** *(string) --* Amazon Resource Name (ARN) of the FIS experiment. * **experimentTemplateId** *(string) --* Identifier of the FIS experiment template. * **resourceId** *(string) --* Identifier of the resource. * **targetAccountId** *(string) --* Identifier of the target account. * **targetRegion** *(string) --* The target region. * **name** *(string) --* Name of the alarm recommendation. * **prerequisite** *(string) --* The prerequisite for the alarm recommendation. * **recommendationId** *(string) --* Identifier of the alarm recommendation. * **recommendationStatus** *(string) --* Status of the recommended Amazon CloudWatch alarm. * **referenceId** *(string) --* Reference identifier of the alarm recommendation. * **type** *(string) --* Type of alarm recommendation. * **nextToken** *(string) --* Token for the next set of results, or null if there are no more results. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / delete_resiliency_policy delete_resiliency_policy ************************ ResilienceHub.Client.delete_resiliency_policy(**kwargs) Deletes a resiliency policy. This is a destructive action that can't be undone. See also: AWS API Documentation **Request Syntax** response = client.delete_resiliency_policy( clientToken='string', policyArn='string' ) Parameters: * **clientToken** (*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. * **policyArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":resiliency-policy/ "policy-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. Return type: dict Returns: **Response Syntax** { 'policyArn': 'string' } **Response Structure** * *(dict) --* * **policyArn** *(string) --* Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":resiliency-policy/ "policy-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / create_app_version_resource create_app_version_resource *************************** ResilienceHub.Client.create_app_version_resource(**kwargs) Adds a resource to the Resilience Hub application and assigns it to the specified Application Components. If you specify a new Application Component, Resilience Hub will automatically create the Application Component. Note: * This action has no effect outside Resilience Hub. * This API updates the Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the Resilience Hub application using the "PublishAppVersion" API. * To update application version with new "physicalResourceID", you must call "ResolveAppVersionResources" API. See also: AWS API Documentation **Request Syntax** response = client.create_app_version_resource( additionalInfo={ 'string': [ 'string', ] }, appArn='string', appComponents=[ 'string', ], awsAccountId='string', awsRegion='string', clientToken='string', logicalResourceId={ 'eksSourceName': 'string', 'identifier': 'string', 'logicalStackName': 'string', 'resourceGroupName': 'string', 'terraformSourceName': 'string' }, physicalResourceId='string', resourceName='string', resourceType='string' ) Parameters: * **additionalInfo** (*dict*) -- Currently, there is no supported additional information for resources. * *(string) --* * *(list) --* * *(string) --* * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appComponents** (*list*) -- **[REQUIRED]** List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added. * *(string) --* * **awsAccountId** (*string*) -- Amazon Web Services account that owns the physical resource. * **awsRegion** (*string*) -- Amazon Web Services region that owns the physical resource. * **clientToken** (*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. * **logicalResourceId** (*dict*) -- **[REQUIRED]** Logical identifier of the resource. * **eksSourceName** *(string) --* Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to. Note: This parameter accepts values in "eks-cluster/namespace" format. * **identifier** *(string) --* **[REQUIRED]** 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. * **terraformSourceName** *(string) --* The name of the Terraform S3 state file this resource belongs to. * **physicalResourceId** (*string*) -- **[REQUIRED]** Physical identifier of the resource. * **resourceName** (*string*) -- Name of the resource. * **resourceType** (*string*) -- **[REQUIRED]** Type of resource. Return type: dict Returns: **Response Syntax** { 'appArn': 'string', 'appVersion': 'string', 'physicalResource': { 'additionalInfo': { 'string': [ 'string', ] }, 'appComponents': [ { 'additionalInfo': { 'string': [ 'string', ] }, 'id': 'string', 'name': 'string', 'type': 'string' }, ], 'excluded': True|False, 'logicalResourceId': { 'eksSourceName': 'string', 'identifier': 'string', 'logicalStackName': 'string', 'resourceGroupName': 'string', 'terraformSourceName': 'string' }, 'parentResourceName': 'string', 'physicalResourceId': { 'awsAccountId': 'string', 'awsRegion': 'string', 'identifier': 'string', 'type': 'Arn'|'Native' }, 'resourceName': 'string', 'resourceType': 'string', 'sourceType': 'AppTemplate'|'Discovered' } } **Response Structure** * *(dict) --* * **appArn** *(string) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appVersion** *(string) --* Resilience Hub application version. * **physicalResource** *(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. * **additionalInfo** *(dict) --* Additional configuration parameters for an Resilience Hub application. If you want to implement "additionalInfo" through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters. Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.Key: ""failover-regions""Value: ""[{"region":"", "accounts":[{"id":""}]}]"" * *(string) --* * *(list) --* * *(string) --* * **appComponents** *(list) --* The application components that belong to this resource. * *(dict) --* Defines an Application Component. * **additionalInfo** *(dict) --* Additional configuration parameters for an Resilience Hub application. If you want to implement "additionalInfo" through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters. Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.Key: ""failover- regions""Value: ""[{"region":"", "accounts":[{"id":""}]}]"" * *(string) --* * *(list) --* * *(string) --* * **id** *(string) --* Identifier of the Application Component. * **name** *(string) --* Name of the Application Component. * **type** *(string) --* The type of Application Component. * **excluded** *(boolean) --* Indicates if a resource is included or excluded from the assessment. * **logicalResourceId** *(dict) --* Logical identifier of the resource. * **eksSourceName** *(string) --* Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to. Note: This parameter accepts values in "eks- cluster/namespace" format. * **identifier** *(string) --* 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. * **terraformSourceName** *(string) --* The name of the Terraform S3 state file this resource belongs to. * **parentResourceName** *(string) --* Name of the parent resource. * **physicalResourceId** *(dict) --* Identifier of the physical 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) --* Identifier of the physical resource. * **type** *(string) --* Specifies the type of physical resource identifier. Arn The resource identifier is an Amazon Resource Name (ARN) and it can identify the following list of resources: * "AWS::ECS::Service" * "AWS::EFS::FileSystem" * "AWS::ElasticLoadBalancingV2::LoadBalancer" * "AWS::Lambda::Function" * "AWS::SNS::Topic" Native The resource identifier is an Resilience Hub-native identifier and it can identify the following list of resources: * "AWS::ApiGateway::RestApi" * "AWS::ApiGatewayV2::Api" * "AWS::AutoScaling::AutoScalingGroup" * "AWS::DocDB::DBCluster" * "AWS::DocDB::DBGlobalCluster" * "AWS::DocDB::DBInstance" * "AWS::DynamoDB::GlobalTable" * "AWS::DynamoDB::Table" * "AWS::EC2::EC2Fleet" * "AWS::EC2::Instance" * "AWS::EC2::NatGateway" * "AWS::EC2::Volume" * "AWS::ElasticLoadBalancing::LoadBalancer" * "AWS::RDS::DBCluster" * "AWS::RDS::DBInstance" * "AWS::RDS::GlobalCluster" * "AWS::Route53::RecordSet" * "AWS::S3::Bucket" * "AWS::SQS::Queue" * **resourceName** *(string) --* The name of the resource. * **resourceType** *(string) --* Type of resource. * **sourceType** *(string) --* Type of input source. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ServiceQuotaExceededException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / accept_resource_grouping_recommendations accept_resource_grouping_recommendations **************************************** ResilienceHub.Client.accept_resource_grouping_recommendations(**kwargs) Accepts the resource grouping recommendations suggested by Resilience Hub for your application. See also: AWS API Documentation **Request Syntax** response = client.accept_resource_grouping_recommendations( appArn='string', entries=[ { 'groupingRecommendationId': 'string' }, ] ) Parameters: * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **entries** (*list*) -- **[REQUIRED]** List of resource grouping recommendations you want to include in your application. * *(dict) --* Indicates the grouping recommendation you have accepted to include in your application. * **groupingRecommendationId** *(string) --* **[REQUIRED]** Indicates the identifier of the grouping recommendation. Return type: dict Returns: **Response Syntax** { 'appArn': 'string', 'failedEntries': [ { 'errorMessage': 'string', 'groupingRecommendationId': 'string' }, ] } **Response Structure** * *(dict) --* * **appArn** *(string) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **failedEntries** *(list) --* List of resource grouping recommendations that could not be included in your application. * *(dict) --* Indicates the accepted grouping recommendation whose implementation failed. * **errorMessage** *(string) --* Indicates the error that occurred while implementing a grouping recommendation. * **groupingRecommendationId** *(string) --* Indicates the identifier of the grouping recommendation. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / update_app_version update_app_version ****************** ResilienceHub.Client.update_app_version(**kwargs) Updates the Resilience Hub application version. Note: This API updates the Resilience Hub application draft version. To use this information for running resiliency assessments, you must publish the Resilience Hub application using the "PublishAppVersion" API. See also: AWS API Documentation **Request Syntax** response = client.update_app_version( additionalInfo={ 'string': [ 'string', ] }, appArn='string' ) Parameters: * **additionalInfo** (*dict*) -- Additional configuration parameters for an Resilience Hub application. If you want to implement "additionalInfo" through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters. Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.Key: ""failover-regions""Value: ""[{"region":"", "accounts":[{"id":""}]}]"" * *(string) --* * *(list) --* * *(string) --* * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. Return type: dict Returns: **Response Syntax** { 'additionalInfo': { 'string': [ 'string', ] }, 'appArn': 'string', 'appVersion': 'string' } **Response Structure** * *(dict) --* * **additionalInfo** *(dict) --* Additional configuration parameters for an Resilience Hub application. If you want to implement "additionalInfo" through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters. Note: Currently, this parameter supports only failover region and account. * *(string) --* * *(list) --* * *(string) --* * **appArn** *(string) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appVersion** *(string) --* Resilience Hub application version. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / list_app_component_compliances list_app_component_compliances ****************************** ResilienceHub.Client.list_app_component_compliances(**kwargs) Lists the compliances for an Resilience Hub Application Component. See also: AWS API Documentation **Request Syntax** response = client.list_app_component_compliances( assessmentArn='string', maxResults=123, nextToken='string' ) Parameters: * **assessmentArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app-assessment/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **maxResults** (*integer*) -- 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. * **nextToken** (*string*) -- Null, or the token from a previous call to get the next set of results. Return type: dict Returns: **Response Syntax** { 'componentCompliances': [ { 'appComponentName': 'string', 'compliance': { 'string': { 'achievableRpoInSecs': 123, 'achievableRtoInSecs': 123, 'complianceStatus': 'PolicyBreached'|'PolicyMet'|'NotApplicable'|'MissingPolicy', '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': { 'componentScore': { 'string': { 'excludedCount': 123, 'outstandingCount': 123, 'possibleScore': 123.0, 'score': 123.0 } }, 'disruptionScore': { 'string': 123.0 }, 'score': 123.0 }, 'status': 'PolicyBreached'|'PolicyMet'|'NotApplicable'|'MissingPolicy' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **componentCompliances** *(list) --* The compliances for an Resilience Hub Application Component, returned as an object. This object contains the names of the Application Components, compliances, costs, resiliency scores, outage scores, and more. * *(dict) --* Defines the compliance of an Application Component against the resiliency policy. * **appComponentName** *(string) --* 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) --* Reference identifier of the RPO . * **rtoDescription** *(string) --* The RTO description. * **rtoReferenceId** *(string) --* Reference identifier of the RTO. * **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. * **componentScore** *(dict) --* The score generated by Resilience Hub for the scoring component after running an assessment. For example, if the "score" is 25 points, it indicates the overall score of your application generated by Resilience Hub after running an assessment. * *(string) --* * *(dict) --* Resiliency score of each scoring component. For more information about scoring component, see Calculating resiliency score. * **excludedCount** *(integer) --* Number of recommendations that were excluded from the assessment. For example, if the "excludedCount" for Alarms coverage scoring component is 7, it indicates that 7 Amazon CloudWatch alarms are excluded from the assessment. * **outstandingCount** *(integer) --* Number of recommendations that must be implemented to obtain the maximum possible score for the scoring component. For SOPs, alarms, and tests, these are the number of recommendations that must be implemented. For compliance, these are the number of Application Components that have breached the resiliency policy. For example, if the "outstandingCount" for Alarms coverage scoring component is 5, it indicates that 5 Amazon CloudWatch alarms need to be implemented to achieve the maximum possible score. * **possibleScore** *(float) --* Maximum possible score that can be obtained for the scoring component. For example, if the "possibleScore" is 20 points, it indicates the maximum possible score you can achieve for the scoring component when you run a new assessment after implementing all the Resilience Hub recommendations. * **score** *(float) --* Resiliency score points given for the scoring component. The score is always less than or equal to the "possibleScore". * **disruptionScore** *(dict) --* The disruption score for a valid key. * *(string) --* * *(float) --* * **score** *(float) --* The outage score for a valid key. * **status** *(string) --* Status of the action. * **nextToken** *(string) --* Token for the next set of results, or null if there are no more results. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / describe_app describe_app ************ ResilienceHub.Client.describe_app(**kwargs) Describes an Resilience Hub application. See also: AWS API Documentation **Request Syntax** response = client.describe_app( appArn='string' ) Parameters: **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. Return type: dict Returns: **Response Syntax** { 'app': { 'appArn': 'string', 'assessmentSchedule': 'Disabled'|'Daily', 'awsApplicationArn': 'string', 'complianceStatus': 'PolicyBreached'|'PolicyMet'|'NotAssessed'|'ChangesDetected'|'NotApplicable'|'MissingPolicy', 'creationTime': datetime(2015, 1, 1), 'description': 'string', 'driftStatus': 'NotChecked'|'NotDetected'|'Detected', 'eventSubscriptions': [ { 'eventType': 'ScheduledAssessmentFailure'|'DriftDetected', 'name': 'string', 'snsTopicArn': 'string' }, ], 'lastAppComplianceEvaluationTime': datetime(2015, 1, 1), 'lastDriftEvaluationTime': datetime(2015, 1, 1), 'lastResiliencyScoreEvaluationTime': datetime(2015, 1, 1), 'name': 'string', 'permissionModel': { 'crossAccountRoleArns': [ 'string', ], 'invokerRoleName': 'string', 'type': 'LegacyIAMUser'|'RoleBased' }, 'policyArn': 'string', 'resiliencyScore': 123.0, 'rpoInSecs': 123, 'rtoInSecs': 123, '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) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **assessmentSchedule** *(string) --* Assessment execution schedule with 'Daily' or 'Disabled' values. * **awsApplicationArn** *(string) --* Amazon Resource Name (ARN) of Resource Groups group that is integrated with an AppRegistry application. For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **complianceStatus** *(string) --* Current status of compliance for the resiliency policy. * **creationTime** *(datetime) --* Date and time when the application was created. * **description** *(string) --* Optional description for an application. * **driftStatus** *(string) --* Indicates if compliance drifts (deviations) were detected while running an assessment for your application. * **eventSubscriptions** *(list) --* The list of events you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for **Drift detected** and **Scheduled assessment failure** events. * *(dict) --* Indicates an event you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for **Drift detected** and **Scheduled assessment failure** events. * **eventType** *(string) --* The type of event you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for **Drift detected** ( "DriftDetected") and **Scheduled assessment failure** ( "ScheduledAssessmentFailure") events. * **name** *(string) --* Unique name to identify an event subscription. * **snsTopicArn** *(string) --* Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic. The format for this ARN is: "arn:partition:sns:region:account:topic-name". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **lastAppComplianceEvaluationTime** *(datetime) --* Date and time the most recent compliance evaluation. * **lastDriftEvaluationTime** *(datetime) --* Indicates the last time that a drift was evaluated. * **lastResiliencyScoreEvaluationTime** *(datetime) --* Date and time the most recent resiliency score evaluation. * **name** *(string) --* Name for the application. * **permissionModel** *(dict) --* Defines the roles and credentials that Resilience Hub would use while creating the application, importing its resources, and running an assessment. * **crossAccountRoleArns** *(list) --* Defines a list of role Amazon Resource Names (ARNs) to be used in other accounts. These ARNs are used for querying purposes while importing resources and assessing your application. Note: * These ARNs are required only when your resources are in other accounts and you have different role name in these accounts. Else, the invoker role name will be used in the other accounts. * These roles must have a trust policy with "iam:AssumeRole" permission to the invoker role in the primary account. * *(string) --* * **invokerRoleName** *(string) --* Existing Amazon Web Services IAM role name in the primary Amazon Web Services account that will be assumed by Resilience Hub Service Principle to obtain a read- only access to your application resources while running an assessment. If your IAM role includes a path, you must include the path in the "invokerRoleName" parameter. For example, if your IAM role's ARN is "arn:aws:iam:123456789012:role /my-path/role-name", you should pass "my-path/role- name". Note: * You must have "iam:passRole" permission for this role while creating or updating the application. * Currently, "invokerRoleName" accepts only "[A-Za-z0-9_+=,.@-]" characters. * **type** *(string) --* Defines how Resilience Hub scans your resources. It can scan for the resources by using a pre-existing role in your Amazon Web Services account, or by using the credentials of the current IAM user. * **policyArn** *(string) --* Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":resiliency-policy/ "policy-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **resiliencyScore** *(float) --* Current resiliency score for the application. * **rpoInSecs** *(integer) --* Recovery Point Objective (RPO) in seconds. * **rtoInSecs** *(integer) --* Recovery Time Objective (RTO) in seconds. * **status** *(string) --* Status of the application. * **tags** *(dict) --* 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) --* **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / list_test_recommendations list_test_recommendations ************************* ResilienceHub.Client.list_test_recommendations(**kwargs) Lists the test recommendations for the Resilience Hub application. See also: AWS API Documentation **Request Syntax** response = client.list_test_recommendations( assessmentArn='string', maxResults=123, nextToken='string' ) Parameters: * **assessmentArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app-assessment/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **maxResults** (*integer*) -- 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. * **nextToken** (*string*) -- Null, or the token from a previous call to get the next set of results. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'testRecommendations': [ { 'appComponentId': 'string', 'appComponentName': 'string', 'dependsOnAlarms': [ 'string', ], 'description': 'string', 'intent': 'string', 'items': [ { 'alreadyImplemented': True|False, 'discoveredAlarm': { 'alarmArn': 'string', 'source': 'string' }, 'excludeReason': 'AlreadyImplemented'|'NotRelevant'|'ComplexityOfImplementation', 'excluded': True|False, 'latestDiscoveredExperiment': { 'experimentArn': 'string', 'experimentTemplateId': 'string' }, 'resourceId': 'string', 'targetAccountId': 'string', 'targetRegion': 'string' }, ], 'name': 'string', 'prerequisite': 'string', 'recommendationId': 'string', 'recommendationStatus': 'Implemented'|'Inactive'|'NotImplemented'|'Excluded', 'referenceId': 'string', 'risk': 'Small'|'Medium'|'High', 'type': 'Software'|'Hardware'|'AZ'|'Region' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* 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. * **appComponentId** *(string) --* Indicates the identifier of the AppComponent. * **appComponentName** *(string) --* Name of the Application Component. * **dependsOnAlarms** *(list) --* A list of recommended alarms that are used in the test and must be exported before or with the test. * *(string) --* * **description** *(string) --* Description for the test recommendation. * **intent** *(string) --* 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. * **discoveredAlarm** *(dict) --* Indicates the previously implemented Amazon CloudWatch alarm discovered by Resilience Hub. * **alarmArn** *(string) --* Amazon Resource Name (ARN) of the Amazon CloudWatch alarm. * **source** *(string) --* Indicates the source of the Amazon CloudWatch alarm. That is, it indicates if the alarm was created using Resilience Hub recommendation ( "AwsResilienceHub"), or if you had created the alarm in Amazon CloudWatch ( "Customer"). * **excludeReason** *(string) --* Indicates the reason for excluding an operational recommendation. * **excluded** *(boolean) --* Indicates if an operational recommendation item is excluded. * **latestDiscoveredExperiment** *(dict) --* Indicates the experiment created in FIS that was discovered by Resilience Hub, which matches the recommendation. * **experimentArn** *(string) --* Amazon Resource Name (ARN) of the FIS experiment. * **experimentTemplateId** *(string) --* Identifier of the FIS experiment template. * **resourceId** *(string) --* Identifier of the resource. * **targetAccountId** *(string) --* Identifier of the target account. * **targetRegion** *(string) --* The target region. * **name** *(string) --* Name of the test recommendation. * **prerequisite** *(string) --* Prerequisite of the test recommendation. * **recommendationId** *(string) --* Identifier for the test recommendation. * **recommendationStatus** *(string) --* Status of the recommended test. * **referenceId** *(string) --* Reference identifier for the test recommendation. * **risk** *(string) --* Level of risk for this test recommendation. * **type** *(string) --* Type of test recommendation. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / list_app_version_resources list_app_version_resources ************************** ResilienceHub.Client.list_app_version_resources(**kwargs) Lists all the resources in an Resilience Hub application. See also: AWS API Documentation **Request Syntax** response = client.list_app_version_resources( appArn='string', appVersion='string', maxResults=123, nextToken='string', resolutionId='string' ) Parameters: * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appVersion** (*string*) -- **[REQUIRED]** The version of the application. * **maxResults** (*integer*) -- 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. * **nextToken** (*string*) -- Null, or the token from a previous call to get the next set of results. * **resolutionId** (*string*) -- The identifier for a specific resolution. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'physicalResources': [ { 'additionalInfo': { 'string': [ 'string', ] }, 'appComponents': [ { 'additionalInfo': { 'string': [ 'string', ] }, 'id': 'string', 'name': 'string', 'type': 'string' }, ], 'excluded': True|False, 'logicalResourceId': { 'eksSourceName': 'string', 'identifier': 'string', 'logicalStackName': 'string', 'resourceGroupName': 'string', 'terraformSourceName': 'string' }, 'parentResourceName': 'string', 'physicalResourceId': { 'awsAccountId': 'string', 'awsRegion': 'string', 'identifier': 'string', 'type': 'Arn'|'Native' }, 'resourceName': 'string', 'resourceType': 'string', 'sourceType': 'AppTemplate'|'Discovered' }, ], 'resolutionId': 'string' } **Response Structure** * *(dict) --* * **nextToken** *(string) --* 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 an Resilience Hub- native identifier. * **additionalInfo** *(dict) --* Additional configuration parameters for an Resilience Hub application. If you want to implement "additionalInfo" through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters. Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.Key: ""failover-regions""Value: ""[{"region":"", "accounts":[{"id":""}]}]"" * *(string) --* * *(list) --* * *(string) --* * **appComponents** *(list) --* The application components that belong to this resource. * *(dict) --* Defines an Application Component. * **additionalInfo** *(dict) --* Additional configuration parameters for an Resilience Hub application. If you want to implement "additionalInfo" through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters. Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.Key: ""failover- regions""Value: ""[{"region":"", "accounts":[{"id":""}]}]"" * *(string) --* * *(list) --* * *(string) --* * **id** *(string) --* Identifier of the Application Component. * **name** *(string) --* Name of the Application Component. * **type** *(string) --* The type of Application Component. * **excluded** *(boolean) --* Indicates if a resource is included or excluded from the assessment. * **logicalResourceId** *(dict) --* Logical identifier of the resource. * **eksSourceName** *(string) --* Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to. Note: This parameter accepts values in "eks- cluster/namespace" format. * **identifier** *(string) --* 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. * **terraformSourceName** *(string) --* The name of the Terraform S3 state file this resource belongs to. * **parentResourceName** *(string) --* Name of the parent resource. * **physicalResourceId** *(dict) --* Identifier of the physical 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) --* Identifier of the physical resource. * **type** *(string) --* Specifies the type of physical resource identifier. Arn The resource identifier is an Amazon Resource Name (ARN) and it can identify the following list of resources: * "AWS::ECS::Service" * "AWS::EFS::FileSystem" * "AWS::ElasticLoadBalancingV2::LoadBalancer" * "AWS::Lambda::Function" * "AWS::SNS::Topic" Native The resource identifier is an Resilience Hub-native identifier and it can identify the following list of resources: * "AWS::ApiGateway::RestApi" * "AWS::ApiGatewayV2::Api" * "AWS::AutoScaling::AutoScalingGroup" * "AWS::DocDB::DBCluster" * "AWS::DocDB::DBGlobalCluster" * "AWS::DocDB::DBInstance" * "AWS::DynamoDB::GlobalTable" * "AWS::DynamoDB::Table" * "AWS::EC2::EC2Fleet" * "AWS::EC2::Instance" * "AWS::EC2::NatGateway" * "AWS::EC2::Volume" * "AWS::ElasticLoadBalancing::LoadBalancer" * "AWS::RDS::DBCluster" * "AWS::RDS::DBInstance" * "AWS::RDS::GlobalCluster" * "AWS::Route53::RecordSet" * "AWS::S3::Bucket" * "AWS::SQS::Queue" * **resourceName** *(string) --* The name of the resource. * **resourceType** *(string) --* Type of resource. * **sourceType** *(string) --* Type of input source. * **resolutionId** *(string) --* The ID for a specific resolution. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / update_app_version_resource update_app_version_resource *************************** ResilienceHub.Client.update_app_version_resource(**kwargs) Updates the resource details in the Resilience Hub application. Note: * This action has no effect outside Resilience Hub. * This API updates the Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the Resilience Hub application using the "PublishAppVersion" API. * To update application version with new "physicalResourceID", you must call "ResolveAppVersionResources" API. See also: AWS API Documentation **Request Syntax** response = client.update_app_version_resource( additionalInfo={ 'string': [ 'string', ] }, appArn='string', appComponents=[ 'string', ], awsAccountId='string', awsRegion='string', excluded=True|False, logicalResourceId={ 'eksSourceName': 'string', 'identifier': 'string', 'logicalStackName': 'string', 'resourceGroupName': 'string', 'terraformSourceName': 'string' }, physicalResourceId='string', resourceName='string', resourceType='string' ) Parameters: * **additionalInfo** (*dict*) -- Currently, there is no supported additional information for resources. * *(string) --* * *(list) --* * *(string) --* * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appComponents** (*list*) -- List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added. * *(string) --* * **awsAccountId** (*string*) -- Amazon Web Services account that owns the physical resource. * **awsRegion** (*string*) -- Amazon Web Services region that owns the physical resource. * **excluded** (*boolean*) -- Indicates if a resource is excluded from an Resilience Hub application. Note: You can exclude only imported resources from an Resilience Hub application. * **logicalResourceId** (*dict*) -- Logical identifier of the resource. * **eksSourceName** *(string) --* Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to. Note: This parameter accepts values in "eks-cluster/namespace" format. * **identifier** *(string) --* **[REQUIRED]** 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. * **terraformSourceName** *(string) --* The name of the Terraform S3 state file this resource belongs to. * **physicalResourceId** (*string*) -- Physical identifier of the resource. * **resourceName** (*string*) -- Name of the resource. * **resourceType** (*string*) -- Type of resource. Return type: dict Returns: **Response Syntax** { 'appArn': 'string', 'appVersion': 'string', 'physicalResource': { 'additionalInfo': { 'string': [ 'string', ] }, 'appComponents': [ { 'additionalInfo': { 'string': [ 'string', ] }, 'id': 'string', 'name': 'string', 'type': 'string' }, ], 'excluded': True|False, 'logicalResourceId': { 'eksSourceName': 'string', 'identifier': 'string', 'logicalStackName': 'string', 'resourceGroupName': 'string', 'terraformSourceName': 'string' }, 'parentResourceName': 'string', 'physicalResourceId': { 'awsAccountId': 'string', 'awsRegion': 'string', 'identifier': 'string', 'type': 'Arn'|'Native' }, 'resourceName': 'string', 'resourceType': 'string', 'sourceType': 'AppTemplate'|'Discovered' } } **Response Structure** * *(dict) --* * **appArn** *(string) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appVersion** *(string) --* Resilience Hub application version. * **physicalResource** *(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. * **additionalInfo** *(dict) --* Additional configuration parameters for an Resilience Hub application. If you want to implement "additionalInfo" through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters. Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.Key: ""failover-regions""Value: ""[{"region":"", "accounts":[{"id":""}]}]"" * *(string) --* * *(list) --* * *(string) --* * **appComponents** *(list) --* The application components that belong to this resource. * *(dict) --* Defines an Application Component. * **additionalInfo** *(dict) --* Additional configuration parameters for an Resilience Hub application. If you want to implement "additionalInfo" through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters. Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.Key: ""failover- regions""Value: ""[{"region":"", "accounts":[{"id":""}]}]"" * *(string) --* * *(list) --* * *(string) --* * **id** *(string) --* Identifier of the Application Component. * **name** *(string) --* Name of the Application Component. * **type** *(string) --* The type of Application Component. * **excluded** *(boolean) --* Indicates if a resource is included or excluded from the assessment. * **logicalResourceId** *(dict) --* Logical identifier of the resource. * **eksSourceName** *(string) --* Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to. Note: This parameter accepts values in "eks- cluster/namespace" format. * **identifier** *(string) --* 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. * **terraformSourceName** *(string) --* The name of the Terraform S3 state file this resource belongs to. * **parentResourceName** *(string) --* Name of the parent resource. * **physicalResourceId** *(dict) --* Identifier of the physical 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) --* Identifier of the physical resource. * **type** *(string) --* Specifies the type of physical resource identifier. Arn The resource identifier is an Amazon Resource Name (ARN) and it can identify the following list of resources: * "AWS::ECS::Service" * "AWS::EFS::FileSystem" * "AWS::ElasticLoadBalancingV2::LoadBalancer" * "AWS::Lambda::Function" * "AWS::SNS::Topic" Native The resource identifier is an Resilience Hub-native identifier and it can identify the following list of resources: * "AWS::ApiGateway::RestApi" * "AWS::ApiGatewayV2::Api" * "AWS::AutoScaling::AutoScalingGroup" * "AWS::DocDB::DBCluster" * "AWS::DocDB::DBGlobalCluster" * "AWS::DocDB::DBInstance" * "AWS::DynamoDB::GlobalTable" * "AWS::DynamoDB::Table" * "AWS::EC2::EC2Fleet" * "AWS::EC2::Instance" * "AWS::EC2::NatGateway" * "AWS::EC2::Volume" * "AWS::ElasticLoadBalancing::LoadBalancer" * "AWS::RDS::DBCluster" * "AWS::RDS::DBInstance" * "AWS::RDS::GlobalCluster" * "AWS::Route53::RecordSet" * "AWS::S3::Bucket" * "AWS::SQS::Queue" * **resourceName** *(string) --* The name of the resource. * **resourceType** *(string) --* Type of resource. * **sourceType** *(string) --* Type of input source. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ServiceQuotaExceededException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / list_apps list_apps ********* ResilienceHub.Client.list_apps(**kwargs) Lists your Resilience Hub applications. Note: You can filter applications using only one filter at a time or without using any filter. If you try to filter applications using multiple filters, you will get the following error:"An error occurred (ValidationException) when calling the ListApps operation: Only one filter is supported for this operation." See also: AWS API Documentation **Request Syntax** response = client.list_apps( appArn='string', awsApplicationArn='string', fromLastAssessmentTime=datetime(2015, 1, 1), maxResults=123, name='string', nextToken='string', reverseOrder=True|False, toLastAssessmentTime=datetime(2015, 1, 1) ) Parameters: * **appArn** (*string*) -- Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **awsApplicationArn** (*string*) -- Amazon Resource Name (ARN) of Resource Groups group that is integrated with an AppRegistry application. For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **fromLastAssessmentTime** (*datetime*) -- Lower limit of the range that is used to filter applications based on their last assessment times. * **maxResults** (*integer*) -- 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. * **name** (*string*) -- The name for the one of the listed applications. * **nextToken** (*string*) -- Null, or the token from a previous call to get the next set of results. * **reverseOrder** (*boolean*) -- The application list is sorted based on the values of "lastAppComplianceEvaluationTime" field. By default, application list is sorted in ascending order. To sort the application list in descending order, set this field to "True". * **toLastAssessmentTime** (*datetime*) -- Upper limit of the range that is used to filter the applications based on their last assessment times. Return type: dict Returns: **Response Syntax** { 'appSummaries': [ { 'appArn': 'string', 'assessmentSchedule': 'Disabled'|'Daily', 'awsApplicationArn': 'string', 'complianceStatus': 'PolicyBreached'|'PolicyMet'|'NotAssessed'|'ChangesDetected'|'NotApplicable'|'MissingPolicy', 'creationTime': datetime(2015, 1, 1), 'description': 'string', 'driftStatus': 'NotChecked'|'NotDetected'|'Detected', 'lastAppComplianceEvaluationTime': datetime(2015, 1, 1), 'name': 'string', 'resiliencyScore': 123.0, 'rpoInSecs': 123, 'rtoInSecs': 123, 'status': 'Active'|'Deleting' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **appSummaries** *(list) --* Summaries for the Resilience Hub application. * *(dict) --* Defines an application summary. * **appArn** *(string) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **assessmentSchedule** *(string) --* Assessment execution schedule with 'Daily' or 'Disabled' values. * **awsApplicationArn** *(string) --* Amazon Resource Name (ARN) of Resource Groups group that is integrated with an AppRegistry application. For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **complianceStatus** *(string) --* The current status of compliance for the resiliency policy. * **creationTime** *(datetime) --* Date and time when the app was created. * **description** *(string) --* The optional description for an app. * **driftStatus** *(string) --* Indicates if compliance drifts (deviations) were detected while running an assessment for your application. * **lastAppComplianceEvaluationTime** *(datetime) --* Date and time of the most recent compliance evaluation. * **name** *(string) --* The name of the application. * **resiliencyScore** *(float) --* The current resiliency score for the application. * **rpoInSecs** *(integer) --* Recovery Point Objective (RPO) in seconds. * **rtoInSecs** *(integer) --* Recovery Time Objective (RTO) in seconds. * **status** *(string) --* Status of the application. * **nextToken** *(string) --* Token for the next set of results, or null if there are no more results. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / list_metrics list_metrics ************ ResilienceHub.Client.list_metrics(**kwargs) Lists the metrics that can be exported. See also: AWS API Documentation **Request Syntax** response = client.list_metrics( conditions=[ { 'field': 'string', 'operator': 'Equals'|'NotEquals'|'GreaterThen'|'GreaterOrEquals'|'LessThen'|'LessOrEquals', 'value': 'string' }, ], dataSource='string', fields=[ { 'aggregation': 'Min'|'Max'|'Sum'|'Avg'|'Count', 'name': 'string' }, ], maxResults=123, nextToken='string', sorts=[ { 'ascending': True|False, 'field': 'string' }, ] ) Parameters: * **conditions** (*list*) -- Indicates the list of all the conditions that were applied on the metrics. * *(dict) --* Indicates the condition based on which you want to filter the metrics. * **field** *(string) --* **[REQUIRED]** Indicates the field in the metric. * **operator** *(string) --* **[REQUIRED]** Indicates the type of operator or comparison to be used when evaluating a condition against the specified field. * **value** *(string) --* Indicates the value or data against which a condition is evaluated. * **dataSource** (*string*) -- Indicates the data source of the metrics. * **fields** (*list*) -- Indicates the list of fields in the data source. * *(dict) --* Indicates the field or attribute of a resource or data structure on which a condition is being applied or evaluated. * **aggregation** *(string) --* (Optional) Indicates the type of aggregation or summary operation (such as Sum, Average, and so on) to be performed on a particular field or set of data. * **name** *(string) --* **[REQUIRED]** Name of the field. * **maxResults** (*integer*) -- 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. * **nextToken** (*string*) -- Null, or the token from a previous call to get the next set of results. * **sorts** (*list*) -- (Optional) Indicates the order in which you want to sort the fields in the metrics. By default, the fields are sorted in the ascending order. * *(dict) --* Indicates the sorting order of the fields in the metrics. * **ascending** *(boolean) --* Indicates the name or identifier of the field or attribute that should be used as the basis for sorting the metrics. * **field** *(string) --* **[REQUIRED]** Indicates the order in which you want to sort the metrics. By default, the list is sorted in ascending order. To sort the list in descending order, set this field to False. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'rows': [ [ 'string', ], ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* Token for the next set of results, or null if there are no more results. * **rows** *(list) --* Specifies all the list of metric values for each row of metrics. * *(list) --* * *(string) --* **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / create_app_version_app_component create_app_version_app_component ******************************** ResilienceHub.Client.create_app_version_app_component(**kwargs) Creates a new Application Component in the Resilience Hub application. Note: This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the "PublishAppVersion" API. See also: AWS API Documentation **Request Syntax** response = client.create_app_version_app_component( additionalInfo={ 'string': [ 'string', ] }, appArn='string', clientToken='string', id='string', name='string', type='string' ) Parameters: * **additionalInfo** (*dict*) -- Currently, there is no supported additional information for Application Components. * *(string) --* * *(list) --* * *(string) --* * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **clientToken** (*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. * **id** (*string*) -- Identifier of the Application Component. * **name** (*string*) -- **[REQUIRED]** Name of the Application Component. * **type** (*string*) -- **[REQUIRED]** Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent. Return type: dict Returns: **Response Syntax** { 'appArn': 'string', 'appComponent': { 'additionalInfo': { 'string': [ 'string', ] }, 'id': 'string', 'name': 'string', 'type': 'string' }, 'appVersion': 'string' } **Response Structure** * *(dict) --* * **appArn** *(string) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appComponent** *(dict) --* List of Application Components that belong to this resource. * **additionalInfo** *(dict) --* Additional configuration parameters for an Resilience Hub application. If you want to implement "additionalInfo" through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters. Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.Key: ""failover-regions""Value: ""[{"region":"", "accounts":[{"id":""}]}]"" * *(string) --* * *(list) --* * *(string) --* * **id** *(string) --* Identifier of the Application Component. * **name** *(string) --* Name of the Application Component. * **type** *(string) --* The type of Application Component. * **appVersion** *(string) --* Resilience Hub application version. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ServiceQuotaExceededException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / describe_draft_app_version_resources_import_status describe_draft_app_version_resources_import_status ************************************************** ResilienceHub.Client.describe_draft_app_version_resources_import_status(**kwargs) Describes the status of importing resources to an application version. Note: If you get a 404 error with "ResourceImportStatusNotFoundAppMetadataException", you must call "importResourcesToDraftAppVersion" after creating the application and before calling "describeDraftAppVersionResourcesImportStatus" to obtain the status. See also: AWS API Documentation **Request Syntax** response = client.describe_draft_app_version_resources_import_status( appArn='string' ) Parameters: **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. Return type: dict Returns: **Response Syntax** { 'appArn': 'string', 'appVersion': 'string', 'errorDetails': [ { 'errorMessage': 'string' }, ], 'errorMessage': 'string', 'status': 'Pending'|'InProgress'|'Failed'|'Success', 'statusChangeTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **appArn** *(string) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appVersion** *(string) --* The version of the application. * **errorDetails** *(list) --* List of errors that were encountered while importing resources. * *(dict) --* Indicates the error that was encountered while importing a resource. * **errorMessage** *(string) --* Provides additional information about the error. * **errorMessage** *(string) --* The error message returned for the resource request. * **status** *(string) --* Status of the action. * **statusChangeTime** *(datetime) --* The time when the status last changed. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / update_app update_app ********** ResilienceHub.Client.update_app(**kwargs) Updates an application. See also: AWS API Documentation **Request Syntax** response = client.update_app( appArn='string', assessmentSchedule='Disabled'|'Daily', clearResiliencyPolicyArn=True|False, description='string', eventSubscriptions=[ { 'eventType': 'ScheduledAssessmentFailure'|'DriftDetected', 'name': 'string', 'snsTopicArn': 'string' }, ], permissionModel={ 'crossAccountRoleArns': [ 'string', ], 'invokerRoleName': 'string', 'type': 'LegacyIAMUser'|'RoleBased' }, policyArn='string' ) Parameters: * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **assessmentSchedule** (*string*) -- Assessment execution schedule with 'Daily' or 'Disabled' values. * **clearResiliencyPolicyArn** (*boolean*) -- Specifies if the resiliency policy ARN should be cleared. * **description** (*string*) -- The optional description for an app. * **eventSubscriptions** (*list*) -- The list of events you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for **Drift detected** and **Scheduled assessment failure** events. * *(dict) --* Indicates an event you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for **Drift detected** and **Scheduled assessment failure** events. * **eventType** *(string) --* **[REQUIRED]** The type of event you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for **Drift detected** ( "DriftDetected") and **Scheduled assessment failure** ( "ScheduledAssessmentFailure") events. * **name** *(string) --* **[REQUIRED]** Unique name to identify an event subscription. * **snsTopicArn** *(string) --* Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic. The format for this ARN is: "arn:partition:sns:region:account:topic-name". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **permissionModel** (*dict*) -- Defines the roles and credentials that Resilience Hub would use while creating an application, importing its resources, and running an assessment. * **crossAccountRoleArns** *(list) --* Defines a list of role Amazon Resource Names (ARNs) to be used in other accounts. These ARNs are used for querying purposes while importing resources and assessing your application. Note: * These ARNs are required only when your resources are in other accounts and you have different role name in these accounts. Else, the invoker role name will be used in the other accounts. * These roles must have a trust policy with "iam:AssumeRole" permission to the invoker role in the primary account. * *(string) --* * **invokerRoleName** *(string) --* Existing Amazon Web Services IAM role name in the primary Amazon Web Services account that will be assumed by Resilience Hub Service Principle to obtain a read-only access to your application resources while running an assessment. If your IAM role includes a path, you must include the path in the "invokerRoleName" parameter. For example, if your IAM role's ARN is "arn:aws:iam:123456789012:role/my-path/role- name", you should pass "my-path/role-name". Note: * You must have "iam:passRole" permission for this role while creating or updating the application. * Currently, "invokerRoleName" accepts only "[A-Za-z0-9_+=,.@-]" characters. * **type** *(string) --* **[REQUIRED]** Defines how Resilience Hub scans your resources. It can scan for the resources by using a pre-existing role in your Amazon Web Services account, or by using the credentials of the current IAM user. * **policyArn** (*string*) -- Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":resiliency- policy/ "policy-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. Return type: dict Returns: **Response Syntax** { 'app': { 'appArn': 'string', 'assessmentSchedule': 'Disabled'|'Daily', 'awsApplicationArn': 'string', 'complianceStatus': 'PolicyBreached'|'PolicyMet'|'NotAssessed'|'ChangesDetected'|'NotApplicable'|'MissingPolicy', 'creationTime': datetime(2015, 1, 1), 'description': 'string', 'driftStatus': 'NotChecked'|'NotDetected'|'Detected', 'eventSubscriptions': [ { 'eventType': 'ScheduledAssessmentFailure'|'DriftDetected', 'name': 'string', 'snsTopicArn': 'string' }, ], 'lastAppComplianceEvaluationTime': datetime(2015, 1, 1), 'lastDriftEvaluationTime': datetime(2015, 1, 1), 'lastResiliencyScoreEvaluationTime': datetime(2015, 1, 1), 'name': 'string', 'permissionModel': { 'crossAccountRoleArns': [ 'string', ], 'invokerRoleName': 'string', 'type': 'LegacyIAMUser'|'RoleBased' }, 'policyArn': 'string', 'resiliencyScore': 123.0, 'rpoInSecs': 123, 'rtoInSecs': 123, '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) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **assessmentSchedule** *(string) --* Assessment execution schedule with 'Daily' or 'Disabled' values. * **awsApplicationArn** *(string) --* Amazon Resource Name (ARN) of Resource Groups group that is integrated with an AppRegistry application. For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **complianceStatus** *(string) --* Current status of compliance for the resiliency policy. * **creationTime** *(datetime) --* Date and time when the application was created. * **description** *(string) --* Optional description for an application. * **driftStatus** *(string) --* Indicates if compliance drifts (deviations) were detected while running an assessment for your application. * **eventSubscriptions** *(list) --* The list of events you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for **Drift detected** and **Scheduled assessment failure** events. * *(dict) --* Indicates an event you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for **Drift detected** and **Scheduled assessment failure** events. * **eventType** *(string) --* The type of event you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for **Drift detected** ( "DriftDetected") and **Scheduled assessment failure** ( "ScheduledAssessmentFailure") events. * **name** *(string) --* Unique name to identify an event subscription. * **snsTopicArn** *(string) --* Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic. The format for this ARN is: "arn:partition:sns:region:account:topic-name". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **lastAppComplianceEvaluationTime** *(datetime) --* Date and time the most recent compliance evaluation. * **lastDriftEvaluationTime** *(datetime) --* Indicates the last time that a drift was evaluated. * **lastResiliencyScoreEvaluationTime** *(datetime) --* Date and time the most recent resiliency score evaluation. * **name** *(string) --* Name for the application. * **permissionModel** *(dict) --* Defines the roles and credentials that Resilience Hub would use while creating the application, importing its resources, and running an assessment. * **crossAccountRoleArns** *(list) --* Defines a list of role Amazon Resource Names (ARNs) to be used in other accounts. These ARNs are used for querying purposes while importing resources and assessing your application. Note: * These ARNs are required only when your resources are in other accounts and you have different role name in these accounts. Else, the invoker role name will be used in the other accounts. * These roles must have a trust policy with "iam:AssumeRole" permission to the invoker role in the primary account. * *(string) --* * **invokerRoleName** *(string) --* Existing Amazon Web Services IAM role name in the primary Amazon Web Services account that will be assumed by Resilience Hub Service Principle to obtain a read- only access to your application resources while running an assessment. If your IAM role includes a path, you must include the path in the "invokerRoleName" parameter. For example, if your IAM role's ARN is "arn:aws:iam:123456789012:role /my-path/role-name", you should pass "my-path/role- name". Note: * You must have "iam:passRole" permission for this role while creating or updating the application. * Currently, "invokerRoleName" accepts only "[A-Za-z0-9_+=,.@-]" characters. * **type** *(string) --* Defines how Resilience Hub scans your resources. It can scan for the resources by using a pre-existing role in your Amazon Web Services account, or by using the credentials of the current IAM user. * **policyArn** *(string) --* Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":resiliency-policy/ "policy-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **resiliencyScore** *(float) --* Current resiliency score for the application. * **rpoInSecs** *(integer) --* Recovery Point Objective (RPO) in seconds. * **rtoInSecs** *(integer) --* Recovery Time Objective (RTO) in seconds. * **status** *(string) --* Status of the application. * **tags** *(dict) --* 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) --* **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / close close ***** ResilienceHub.Client.close() Closes underlying endpoint connections. ResilienceHub / Client / list_app_assessment_compliance_drifts list_app_assessment_compliance_drifts ************************************* ResilienceHub.Client.list_app_assessment_compliance_drifts(**kwargs) List of compliance drifts that were detected while running an assessment. See also: AWS API Documentation **Request Syntax** response = client.list_app_assessment_compliance_drifts( assessmentArn='string', maxResults=123, nextToken='string' ) Parameters: * **assessmentArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app-assessment/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **maxResults** (*integer*) -- Maximum number of compliance drifts requested. * **nextToken** (*string*) -- Null, or the token from a previous call to get the next set of results. Return type: dict Returns: **Response Syntax** { 'complianceDrifts': [ { 'actualReferenceId': 'string', 'actualValue': { 'string': { 'achievableRpoInSecs': 123, 'achievableRtoInSecs': 123, 'complianceStatus': 'PolicyBreached'|'PolicyMet'|'NotApplicable'|'MissingPolicy', 'currentRpoInSecs': 123, 'currentRtoInSecs': 123, 'message': 'string', 'rpoDescription': 'string', 'rpoReferenceId': 'string', 'rtoDescription': 'string', 'rtoReferenceId': 'string' } }, 'appId': 'string', 'appVersion': 'string', 'diffType': 'NotEqual'|'Added'|'Removed', 'driftType': 'ApplicationCompliance'|'AppComponentResiliencyComplianceStatus', 'entityId': 'string', 'entityType': 'string', 'expectedReferenceId': 'string', 'expectedValue': { 'string': { 'achievableRpoInSecs': 123, 'achievableRtoInSecs': 123, 'complianceStatus': 'PolicyBreached'|'PolicyMet'|'NotApplicable'|'MissingPolicy', 'currentRpoInSecs': 123, 'currentRtoInSecs': 123, 'message': 'string', 'rpoDescription': 'string', 'rpoReferenceId': 'string', 'rtoDescription': 'string', 'rtoReferenceId': 'string' } } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **complianceDrifts** *(list) --* Indicates compliance drifts (recovery time objective (RTO) and recovery point objective (RPO)) detected for an assessed entity. * *(dict) --* Indicates the compliance drifts (recovery time objective (RTO) and recovery point objective (RPO)) that were detected for an assessed entity. * **actualReferenceId** *(string) --* Assessment identifier that is associated with this drift item. * **actualValue** *(dict) --* Actual compliance value of the entity. * *(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) --* Reference identifier of the RPO . * **rtoDescription** *(string) --* The RTO description. * **rtoReferenceId** *(string) --* Reference identifier of the RTO. * **appId** *(string) --* Identifier of your application. * **appVersion** *(string) --* Published version of your application on which drift was detected. * **diffType** *(string) --* Difference type between actual and expected recovery point objective (RPO) and recovery time objective (RTO) values. Currently, Resilience Hub supports only "NotEqual" difference type. * **driftType** *(string) --* The type of drift detected. Currently, Resilience Hub supports only **ApplicationCompliance** drift type. * **entityId** *(string) --* Identifier of an entity in which drift was detected. For compliance drift, the entity ID can be either application ID or the AppComponent ID. * **entityType** *(string) --* The type of entity in which drift was detected. For compliance drifts, Resilience Hub supports "AWS::ResilienceHub::AppComponent" and "AWS::ResilienceHub::Application". * **expectedReferenceId** *(string) --* Assessment identifier of a previous assessment of the same application version. Resilience Hub uses the previous assessment (associated with the reference identifier) to compare the compliance with the current assessment to identify drifts. * **expectedValue** *(dict) --* The expected compliance value of an entity. * *(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) --* Reference identifier of the RPO . * **rtoDescription** *(string) --* The RTO description. * **rtoReferenceId** *(string) --* Reference identifier of the RTO. * **nextToken** *(string) --* Null, or the token from a previous call to get the next set of results. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / delete_app_version_resource delete_app_version_resource *************************** ResilienceHub.Client.delete_app_version_resource(**kwargs) Deletes a resource from the Resilience Hub application. Note: * You can only delete a manually added resource. To exclude non- manually added resources, use the "UpdateAppVersionResource" API. * This action has no effect outside Resilience Hub. * This API updates the Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the Resilience Hub application using the "PublishAppVersion" API. See also: AWS API Documentation **Request Syntax** response = client.delete_app_version_resource( appArn='string', awsAccountId='string', awsRegion='string', clientToken='string', logicalResourceId={ 'eksSourceName': 'string', 'identifier': 'string', 'logicalStackName': 'string', 'resourceGroupName': 'string', 'terraformSourceName': 'string' }, physicalResourceId='string', resourceName='string' ) Parameters: * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **awsAccountId** (*string*) -- Amazon Web Services account that owns the physical resource. * **awsRegion** (*string*) -- Amazon Web Services region that owns the physical resource. * **clientToken** (*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. * **logicalResourceId** (*dict*) -- Logical identifier of the resource. * **eksSourceName** *(string) --* Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to. Note: This parameter accepts values in "eks-cluster/namespace" format. * **identifier** *(string) --* **[REQUIRED]** 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. * **terraformSourceName** *(string) --* The name of the Terraform S3 state file this resource belongs to. * **physicalResourceId** (*string*) -- Physical identifier of the resource. * **resourceName** (*string*) -- Name of the resource. Return type: dict Returns: **Response Syntax** { 'appArn': 'string', 'appVersion': 'string', 'physicalResource': { 'additionalInfo': { 'string': [ 'string', ] }, 'appComponents': [ { 'additionalInfo': { 'string': [ 'string', ] }, 'id': 'string', 'name': 'string', 'type': 'string' }, ], 'excluded': True|False, 'logicalResourceId': { 'eksSourceName': 'string', 'identifier': 'string', 'logicalStackName': 'string', 'resourceGroupName': 'string', 'terraformSourceName': 'string' }, 'parentResourceName': 'string', 'physicalResourceId': { 'awsAccountId': 'string', 'awsRegion': 'string', 'identifier': 'string', 'type': 'Arn'|'Native' }, 'resourceName': 'string', 'resourceType': 'string', 'sourceType': 'AppTemplate'|'Discovered' } } **Response Structure** * *(dict) --* * **appArn** *(string) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appVersion** *(string) --* Resilience Hub application version. * **physicalResource** *(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. * **additionalInfo** *(dict) --* Additional configuration parameters for an Resilience Hub application. If you want to implement "additionalInfo" through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters. Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.Key: ""failover-regions""Value: ""[{"region":"", "accounts":[{"id":""}]}]"" * *(string) --* * *(list) --* * *(string) --* * **appComponents** *(list) --* The application components that belong to this resource. * *(dict) --* Defines an Application Component. * **additionalInfo** *(dict) --* Additional configuration parameters for an Resilience Hub application. If you want to implement "additionalInfo" through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters. Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.Key: ""failover- regions""Value: ""[{"region":"", "accounts":[{"id":""}]}]"" * *(string) --* * *(list) --* * *(string) --* * **id** *(string) --* Identifier of the Application Component. * **name** *(string) --* Name of the Application Component. * **type** *(string) --* The type of Application Component. * **excluded** *(boolean) --* Indicates if a resource is included or excluded from the assessment. * **logicalResourceId** *(dict) --* Logical identifier of the resource. * **eksSourceName** *(string) --* Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to. Note: This parameter accepts values in "eks- cluster/namespace" format. * **identifier** *(string) --* 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. * **terraformSourceName** *(string) --* The name of the Terraform S3 state file this resource belongs to. * **parentResourceName** *(string) --* Name of the parent resource. * **physicalResourceId** *(dict) --* Identifier of the physical 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) --* Identifier of the physical resource. * **type** *(string) --* Specifies the type of physical resource identifier. Arn The resource identifier is an Amazon Resource Name (ARN) and it can identify the following list of resources: * "AWS::ECS::Service" * "AWS::EFS::FileSystem" * "AWS::ElasticLoadBalancingV2::LoadBalancer" * "AWS::Lambda::Function" * "AWS::SNS::Topic" Native The resource identifier is an Resilience Hub-native identifier and it can identify the following list of resources: * "AWS::ApiGateway::RestApi" * "AWS::ApiGatewayV2::Api" * "AWS::AutoScaling::AutoScalingGroup" * "AWS::DocDB::DBCluster" * "AWS::DocDB::DBGlobalCluster" * "AWS::DocDB::DBInstance" * "AWS::DynamoDB::GlobalTable" * "AWS::DynamoDB::Table" * "AWS::EC2::EC2Fleet" * "AWS::EC2::Instance" * "AWS::EC2::NatGateway" * "AWS::EC2::Volume" * "AWS::ElasticLoadBalancing::LoadBalancer" * "AWS::RDS::DBCluster" * "AWS::RDS::DBInstance" * "AWS::RDS::GlobalCluster" * "AWS::Route53::RecordSet" * "AWS::S3::Bucket" * "AWS::SQS::Queue" * **resourceName** *(string) --* The name of the resource. * **resourceType** *(string) --* Type of resource. * **sourceType** *(string) --* Type of input source. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / list_recommendation_templates list_recommendation_templates ***************************** ResilienceHub.Client.list_recommendation_templates(**kwargs) Lists the recommendation templates for the Resilience Hub applications. See also: AWS API Documentation **Request Syntax** response = client.list_recommendation_templates( assessmentArn='string', maxResults=123, name='string', nextToken='string', recommendationTemplateArn='string', reverseOrder=True|False, status=[ 'Pending'|'InProgress'|'Failed'|'Success', ] ) Parameters: * **assessmentArn** (*string*) -- Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app-assessment/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **maxResults** (*integer*) -- 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. * **name** (*string*) -- The name for one of the listed recommendation templates. * **nextToken** (*string*) -- Null, or the token from a previous call to get the next set of results. * **recommendationTemplateArn** (*string*) -- The Amazon Resource Name (ARN) for a recommendation template. * **reverseOrder** (*boolean*) -- The default is to sort by ascending **startTime**. To sort by descending **startTime**, set reverseOrder to "true". * **status** (*list*) -- Status of the action. * *(string) --* Return type: dict Returns: **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) --* 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) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **assessmentArn** *(string) --* Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app-assessment/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **endTime** *(datetime) --* The end time for the action. * **format** *(string) --* Format of the recommendation template. CfnJson The template is CloudFormation JSON. CfnYaml The template is CloudFormation YAML. * **message** *(string) --* Message for the recommendation template. * **name** *(string) --* 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) --* 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) --* Status of the action. * **tags** *(dict) --* 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. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / list_sop_recommendations list_sop_recommendations ************************ ResilienceHub.Client.list_sop_recommendations(**kwargs) Lists the standard operating procedure (SOP) recommendations for the Resilience Hub applications. See also: AWS API Documentation **Request Syntax** response = client.list_sop_recommendations( assessmentArn='string', maxResults=123, nextToken='string' ) Parameters: * **assessmentArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app-assessment/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **maxResults** (*integer*) -- 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. * **nextToken** (*string*) -- Null, or the token from a previous call to get the next set of results. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'sopRecommendations': [ { 'appComponentName': 'string', 'description': 'string', 'items': [ { 'alreadyImplemented': True|False, 'discoveredAlarm': { 'alarmArn': 'string', 'source': 'string' }, 'excludeReason': 'AlreadyImplemented'|'NotRelevant'|'ComplexityOfImplementation', 'excluded': True|False, 'latestDiscoveredExperiment': { 'experimentArn': 'string', 'experimentTemplateId': 'string' }, 'resourceId': 'string', 'targetAccountId': 'string', 'targetRegion': 'string' }, ], 'name': 'string', 'prerequisite': 'string', 'recommendationId': 'string', 'recommendationStatus': 'Implemented'|'Inactive'|'NotImplemented'|'Excluded', 'referenceId': 'string', 'serviceType': 'SSM' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* 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) --* Name of the Application Component. * **description** *(string) --* Description of the SOP recommendation. * **items** *(list) --* The recommendation items. * *(dict) --* Defines a recommendation. * **alreadyImplemented** *(boolean) --* Specifies if the recommendation has already been implemented. * **discoveredAlarm** *(dict) --* Indicates the previously implemented Amazon CloudWatch alarm discovered by Resilience Hub. * **alarmArn** *(string) --* Amazon Resource Name (ARN) of the Amazon CloudWatch alarm. * **source** *(string) --* Indicates the source of the Amazon CloudWatch alarm. That is, it indicates if the alarm was created using Resilience Hub recommendation ( "AwsResilienceHub"), or if you had created the alarm in Amazon CloudWatch ( "Customer"). * **excludeReason** *(string) --* Indicates the reason for excluding an operational recommendation. * **excluded** *(boolean) --* Indicates if an operational recommendation item is excluded. * **latestDiscoveredExperiment** *(dict) --* Indicates the experiment created in FIS that was discovered by Resilience Hub, which matches the recommendation. * **experimentArn** *(string) --* Amazon Resource Name (ARN) of the FIS experiment. * **experimentTemplateId** *(string) --* Identifier of the FIS experiment template. * **resourceId** *(string) --* Identifier of the resource. * **targetAccountId** *(string) --* Identifier of the target account. * **targetRegion** *(string) --* The target region. * **name** *(string) --* Name of the SOP recommendation. * **prerequisite** *(string) --* Prerequisite for the SOP recommendation. * **recommendationId** *(string) --* Identifier for the SOP recommendation. * **recommendationStatus** *(string) --* Status of the recommended standard operating procedure. * **referenceId** *(string) --* Reference identifier for the SOP recommendation. * **serviceType** *(string) --* The service type. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / describe_metrics_export describe_metrics_export *********************** ResilienceHub.Client.describe_metrics_export(**kwargs) Describes the metrics of the application configuration being exported. See also: AWS API Documentation **Request Syntax** response = client.describe_metrics_export( metricsExportId='string' ) Parameters: **metricsExportId** (*string*) -- **[REQUIRED]** Identifier of the metrics export task. Return type: dict Returns: **Response Syntax** { 'errorMessage': 'string', 'exportLocation': { 'bucket': 'string', 'prefix': 'string' }, 'metricsExportId': 'string', 'status': 'Pending'|'InProgress'|'Failed'|'Success' } **Response Structure** * *(dict) --* * **errorMessage** *(string) --* Explains the error that occurred while exporting the metrics. * **exportLocation** *(dict) --* Specifies the name of the Amazon S3 bucket where the exported metrics is stored. * **bucket** *(string) --* The name of the Amazon S3 bucket. * **prefix** *(string) --* The prefix for the Amazon S3 bucket. * **metricsExportId** *(string) --* Identifier for the metrics export task. * **status** *(string) --* Indicates the status of the metrics export task. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / list_app_input_sources list_app_input_sources ********************** ResilienceHub.Client.list_app_input_sources(**kwargs) Lists all the input sources of the Resilience Hub application. For more information about the input sources supported by Resilience Hub, see Discover the structure and describe your Resilience Hub application. See also: AWS API Documentation **Request Syntax** response = client.list_app_input_sources( appArn='string', appVersion='string', maxResults=123, nextToken='string' ) Parameters: * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appVersion** (*string*) -- **[REQUIRED]** Resilience Hub application version. * **maxResults** (*integer*) -- Maximum number of input sources to be displayed per Resilience Hub application. * **nextToken** (*string*) -- Null, or the token from a previous call to get the next set of results. Return type: dict Returns: **Response Syntax** { 'appInputSources': [ { 'eksSourceClusterNamespace': { 'eksClusterArn': 'string', 'namespace': 'string' }, 'importType': 'CfnStack'|'Resource'|'AppRegistryApp'|'ResourceGroup'|'Terraform'|'EKS', 'resourceCount': 123, 'sourceArn': 'string', 'sourceName': 'string', 'terraformSource': { 's3StateFileUrl': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **appInputSources** *(list) --* The list of Resilience Hub application input sources. * *(dict) --* The list of Resilience Hub application input sources. * **eksSourceClusterNamespace** *(dict) --* The namespace on your Amazon Elastic Kubernetes Service cluster. * **eksClusterArn** *(string) --* Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. The format for this ARN is: arn: "aws":eks: "region": "account-id":cluster/ "cluster-name". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **namespace** *(string) --* Name of the namespace that is located on your Amazon Elastic Kubernetes Service cluster. * **importType** *(string) --* The resource type of the input source. * **resourceCount** *(integer) --* The number of resources. * **sourceArn** *(string) --* The Amazon Resource Name (ARN) of the input source. For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **sourceName** *(string) --* The name of the input source. * **terraformSource** *(dict) --* The name of the Terraform s3 state file. * **s3StateFileUrl** *(string) --* The URL of the Terraform s3 state file you need to import. * **nextToken** *(string) --* Token for the next set of results, or null if there are no more results. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / start_app_assessment start_app_assessment ******************** ResilienceHub.Client.start_app_assessment(**kwargs) Creates a new application assessment for an application. See also: AWS API Documentation **Request Syntax** response = client.start_app_assessment( appArn='string', appVersion='string', assessmentName='string', clientToken='string', tags={ 'string': 'string' } ) Parameters: * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appVersion** (*string*) -- **[REQUIRED]** The version of the application. * **assessmentName** (*string*) -- **[REQUIRED]** The name for the assessment. * **clientToken** (*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. * **tags** (*dict*) -- 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) --* Return type: dict Returns: **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'|'NotApplicable'|'MissingPolicy', 'currentRpoInSecs': 123, 'currentRtoInSecs': 123, 'message': 'string', 'rpoDescription': 'string', 'rpoReferenceId': 'string', 'rtoDescription': 'string', 'rtoReferenceId': 'string' } }, 'complianceStatus': 'PolicyBreached'|'PolicyMet'|'NotApplicable'|'MissingPolicy', 'cost': { 'amount': 123.0, 'currency': 'string', 'frequency': 'Hourly'|'Daily'|'Monthly'|'Yearly' }, 'driftStatus': 'NotChecked'|'NotDetected'|'Detected', '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'|'NotApplicable' }, 'resiliencyScore': { 'componentScore': { 'string': { 'excludedCount': 123, 'outstandingCount': 123, 'possibleScore': 123.0, 'score': 123.0 } }, 'disruptionScore': { 'string': 123.0 }, 'score': 123.0 }, 'resourceErrorsDetails': { 'hasMoreErrors': True|False, 'resourceErrors': [ { 'logicalResourceId': 'string', 'physicalResourceId': 'string', 'reason': 'string' }, ] }, 'startTime': datetime(2015, 1, 1), 'summary': { 'riskRecommendations': [ { 'appComponents': [ 'string', ], 'recommendation': 'string', 'risk': 'string' }, ], 'summary': 'string' }, 'tags': { 'string': 'string' }, 'versionName': 'string' } } **Response Structure** * *(dict) --* * **assessment** *(dict) --* The assessment created. * **appArn** *(string) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appVersion** *(string) --* Version of an application. * **assessmentArn** *(string) --* Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app-assessment/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **assessmentName** *(string) --* Name of the assessment. * **assessmentStatus** *(string) --* Current status of the assessment for the resiliency policy. * **compliance** *(dict) --* 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) --* Reference identifier of the RPO . * **rtoDescription** *(string) --* The RTO description. * **rtoReferenceId** *(string) --* Reference identifier of the RTO. * **complianceStatus** *(string) --* Current status of the compliance for the resiliency policy. * **cost** *(dict) --* Cost for the application. * **amount** *(float) --* The cost amount. * **currency** *(string) --* The cost currency, for example "USD". * **frequency** *(string) --* The cost frequency. * **driftStatus** *(string) --* Indicates if compliance drifts (deviations) were detected while running an assessment for your application. * **endTime** *(datetime) --* 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) --* Resiliency policy of an application. * **creationTime** *(datetime) --* Date and time 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) --* Recovery Point Objective (RPO) in seconds. * **rtoInSecs** *(integer) --* Recovery Time Objective (RTO) in seconds. * **policyArn** *(string) --* Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":resiliency-policy/ "policy-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **policyDescription** *(string) --* Description of the resiliency policy. * **policyName** *(string) --* The name of the policy * **tags** *(dict) --* 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) --* Current resiliency score for an application. * **componentScore** *(dict) --* The score generated by Resilience Hub for the scoring component after running an assessment. For example, if the "score" is 25 points, it indicates the overall score of your application generated by Resilience Hub after running an assessment. * *(string) --* * *(dict) --* Resiliency score of each scoring component. For more information about scoring component, see Calculating resiliency score. * **excludedCount** *(integer) --* Number of recommendations that were excluded from the assessment. For example, if the "excludedCount" for Alarms coverage scoring component is 7, it indicates that 7 Amazon CloudWatch alarms are excluded from the assessment. * **outstandingCount** *(integer) --* Number of recommendations that must be implemented to obtain the maximum possible score for the scoring component. For SOPs, alarms, and tests, these are the number of recommendations that must be implemented. For compliance, these are the number of Application Components that have breached the resiliency policy. For example, if the "outstandingCount" for Alarms coverage scoring component is 5, it indicates that 5 Amazon CloudWatch alarms need to be implemented to achieve the maximum possible score. * **possibleScore** *(float) --* Maximum possible score that can be obtained for the scoring component. For example, if the "possibleScore" is 20 points, it indicates the maximum possible score you can achieve for the scoring component when you run a new assessment after implementing all the Resilience Hub recommendations. * **score** *(float) --* Resiliency score points given for the scoring component. The score is always less than or equal to the "possibleScore". * **disruptionScore** *(dict) --* The disruption score for a valid key. * *(string) --* * *(float) --* * **score** *(float) --* The outage score for a valid key. * **resourceErrorsDetails** *(dict) --* A resource error object containing a list of errors retrieving an application's resources. * **hasMoreErrors** *(boolean) --* This indicates if there are more errors not listed in the "resourceErrors" list. * **resourceErrors** *(list) --* A list of errors retrieving an application's resources. * *(dict) --* Defines application resource errors. * **logicalResourceId** *(string) --* Identifier of the logical resource. * **physicalResourceId** *(string) --* Identifier of the physical resource. * **reason** *(string) --* This is the error message. * **startTime** *(datetime) --* Starting time for the action. * **summary** *(dict) --* Indicates the AI-generated summary for the Resilience Hub assessment, providing a concise overview that highlights the top risks and recommendations. Note: This property is available only in the US East (N. Virginia) Region. * **riskRecommendations** *(list) --* Indicates the top risks and recommendations identified by the Resilience Hub assessment, each representing a specific risk and the corresponding recommendation to address it. Note: This property is available only in the US East (N. Virginia) Region. * *(dict) --* Indicates a specific risk identified in the Resilience Hub assessment and the corresponding recommendation provided to address that risk. Note: The assessment summary generated by large language models (LLMs) on Amazon Bedrock are only suggestions. The current level of generative AI technology is not perfect and LLMs are not infallible. Bias and incorrect answers, although rare, should be expected. Review each recommendation in the assessment summary before you use the output from an LLM. Note: This property is available only in the US East (N. Virginia) Region. * **appComponents** *(list) --* Indicates the Application Components (AppComponents) that were assessed as part of the assessment and are associated with the identified risk and recommendation. Note: This property is available only in the US East (N. Virginia) Region. * *(string) --* * **recommendation** *(string) --* Indicates the recommendation provided by the Resilience Hub to address the identified risks in the application. Note: This property is available only in the US East (N. Virginia) Region. * **risk** *(string) --* Indicates the description of the potential risk identified in the application as part of the Resilience Hub assessment. Note: This property is available only in the US East (N. Virginia) Region. * **summary** *(string) --* Indicates a concise summary that provides an overview of the Resilience Hub assessment. Note: This property is available only in the US East (N. Virginia) Region. * **tags** *(dict) --* 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) --* * **versionName** *(string) --* Version name of the published application. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ServiceQuotaExceededException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / list_unsupported_app_version_resources list_unsupported_app_version_resources ************************************** ResilienceHub.Client.list_unsupported_app_version_resources(**kwargs) Lists the resources that are not currently supported in 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** response = client.list_unsupported_app_version_resources( appArn='string', appVersion='string', maxResults=123, nextToken='string', resolutionId='string' ) Parameters: * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appVersion** (*string*) -- **[REQUIRED]** The version of the application. * **maxResults** (*integer*) -- 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. * **nextToken** (*string*) -- Null, or the token from a previous call to get the next set of results. * **resolutionId** (*string*) -- The identifier for a specific resolution. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'resolutionId': 'string', 'unsupportedResources': [ { 'logicalResourceId': { 'eksSourceName': 'string', 'identifier': 'string', 'logicalStackName': 'string', 'resourceGroupName': 'string', 'terraformSourceName': 'string' }, 'physicalResourceId': { 'awsAccountId': 'string', 'awsRegion': 'string', 'identifier': 'string', 'type': 'Arn'|'Native' }, 'resourceType': 'string', 'unsupportedResourceStatus': 'string' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* 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) --* Logical resource identifier for the unsupported resource. * **eksSourceName** *(string) --* Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to. Note: This parameter accepts values in "eks- cluster/namespace" format. * **identifier** *(string) --* 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. * **terraformSourceName** *(string) --* The name of the Terraform S3 state file this resource belongs to. * **physicalResourceId** *(dict) --* 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) --* Identifier of the physical resource. * **type** *(string) --* Specifies the type of physical resource identifier. Arn The resource identifier is an Amazon Resource Name (ARN) and it can identify the following list of resources: * "AWS::ECS::Service" * "AWS::EFS::FileSystem" * "AWS::ElasticLoadBalancingV2::LoadBalancer" * "AWS::Lambda::Function" * "AWS::SNS::Topic" Native The resource identifier is an Resilience Hub-native identifier and it can identify the following list of resources: * "AWS::ApiGateway::RestApi" * "AWS::ApiGatewayV2::Api" * "AWS::AutoScaling::AutoScalingGroup" * "AWS::DocDB::DBCluster" * "AWS::DocDB::DBGlobalCluster" * "AWS::DocDB::DBInstance" * "AWS::DynamoDB::GlobalTable" * "AWS::DynamoDB::Table" * "AWS::EC2::EC2Fleet" * "AWS::EC2::Instance" * "AWS::EC2::NatGateway" * "AWS::EC2::Volume" * "AWS::ElasticLoadBalancing::LoadBalancer" * "AWS::RDS::DBCluster" * "AWS::RDS::DBInstance" * "AWS::RDS::GlobalCluster" * "AWS::Route53::RecordSet" * "AWS::S3::Bucket" * "AWS::SQS::Queue" * **resourceType** *(string) --* The type of resource. * **unsupportedResourceStatus** *(string) --* The status of the unsupported resource. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / delete_recommendation_template delete_recommendation_template ****************************** ResilienceHub.Client.delete_recommendation_template(**kwargs) Deletes a recommendation template. This is a destructive action that can't be undone. See also: AWS API Documentation **Request Syntax** response = client.delete_recommendation_template( clientToken='string', recommendationTemplateArn='string' ) Parameters: * **clientToken** (*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. * **recommendationTemplateArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) for a recommendation template. Return type: dict Returns: **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) --* Status of the action. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / list_app_versions list_app_versions ***************** ResilienceHub.Client.list_app_versions(**kwargs) Lists the different versions for the Resilience Hub applications. See also: AWS API Documentation **Request Syntax** response = client.list_app_versions( appArn='string', endTime=datetime(2015, 1, 1), maxResults=123, nextToken='string', startTime=datetime(2015, 1, 1) ) Parameters: * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **endTime** (*datetime*) -- Upper limit of the time range to filter the application versions. * **maxResults** (*integer*) -- 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. * **nextToken** (*string*) -- Null, or the token from a previous call to get the next set of results. * **startTime** (*datetime*) -- Lower limit of the time range to filter the application versions. Return type: dict Returns: **Response Syntax** { 'appVersions': [ { 'appVersion': 'string', 'creationTime': datetime(2015, 1, 1), 'identifier': 123, 'versionName': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **appVersions** *(list) --* The version of the application. * *(dict) --* Version of an application. * **appVersion** *(string) --* Version of an application. * **creationTime** *(datetime) --* Creation time of the application version. * **identifier** *(integer) --* Identifier of the application version. * **versionName** *(string) --* Name of the application version. * **nextToken** *(string) --* Token for the next set of results, or null if there are no more results. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / describe_app_version_resource describe_app_version_resource ***************************** ResilienceHub.Client.describe_app_version_resource(**kwargs) Describes a resource of the Resilience Hub application. Note: This API accepts only one of the following parameters to describe the resource: * "resourceName" * "logicalResourceId" * "physicalResourceId" (Along with "physicalResourceId", you can also provide "awsAccountId", and "awsRegion") See also: AWS API Documentation **Request Syntax** response = client.describe_app_version_resource( appArn='string', appVersion='string', awsAccountId='string', awsRegion='string', logicalResourceId={ 'eksSourceName': 'string', 'identifier': 'string', 'logicalStackName': 'string', 'resourceGroupName': 'string', 'terraformSourceName': 'string' }, physicalResourceId='string', resourceName='string' ) Parameters: * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appVersion** (*string*) -- **[REQUIRED]** Resilience Hub application version. * **awsAccountId** (*string*) -- Amazon Web Services account that owns the physical resource. * **awsRegion** (*string*) -- Amazon Web Services region that owns the physical resource. * **logicalResourceId** (*dict*) -- Logical identifier of the resource. * **eksSourceName** *(string) --* Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to. Note: This parameter accepts values in "eks-cluster/namespace" format. * **identifier** *(string) --* **[REQUIRED]** 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. * **terraformSourceName** *(string) --* The name of the Terraform S3 state file this resource belongs to. * **physicalResourceId** (*string*) -- Physical identifier of the resource. * **resourceName** (*string*) -- Name of the resource. Return type: dict Returns: **Response Syntax** { 'appArn': 'string', 'appVersion': 'string', 'physicalResource': { 'additionalInfo': { 'string': [ 'string', ] }, 'appComponents': [ { 'additionalInfo': { 'string': [ 'string', ] }, 'id': 'string', 'name': 'string', 'type': 'string' }, ], 'excluded': True|False, 'logicalResourceId': { 'eksSourceName': 'string', 'identifier': 'string', 'logicalStackName': 'string', 'resourceGroupName': 'string', 'terraformSourceName': 'string' }, 'parentResourceName': 'string', 'physicalResourceId': { 'awsAccountId': 'string', 'awsRegion': 'string', 'identifier': 'string', 'type': 'Arn'|'Native' }, 'resourceName': 'string', 'resourceType': 'string', 'sourceType': 'AppTemplate'|'Discovered' } } **Response Structure** * *(dict) --* * **appArn** *(string) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appVersion** *(string) --* Resilience Hub application version. * **physicalResource** *(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. * **additionalInfo** *(dict) --* Additional configuration parameters for an Resilience Hub application. If you want to implement "additionalInfo" through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters. Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.Key: ""failover-regions""Value: ""[{"region":"", "accounts":[{"id":""}]}]"" * *(string) --* * *(list) --* * *(string) --* * **appComponents** *(list) --* The application components that belong to this resource. * *(dict) --* Defines an Application Component. * **additionalInfo** *(dict) --* Additional configuration parameters for an Resilience Hub application. If you want to implement "additionalInfo" through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters. Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.Key: ""failover- regions""Value: ""[{"region":"", "accounts":[{"id":""}]}]"" * *(string) --* * *(list) --* * *(string) --* * **id** *(string) --* Identifier of the Application Component. * **name** *(string) --* Name of the Application Component. * **type** *(string) --* The type of Application Component. * **excluded** *(boolean) --* Indicates if a resource is included or excluded from the assessment. * **logicalResourceId** *(dict) --* Logical identifier of the resource. * **eksSourceName** *(string) --* Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to. Note: This parameter accepts values in "eks- cluster/namespace" format. * **identifier** *(string) --* 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. * **terraformSourceName** *(string) --* The name of the Terraform S3 state file this resource belongs to. * **parentResourceName** *(string) --* Name of the parent resource. * **physicalResourceId** *(dict) --* Identifier of the physical 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) --* Identifier of the physical resource. * **type** *(string) --* Specifies the type of physical resource identifier. Arn The resource identifier is an Amazon Resource Name (ARN) and it can identify the following list of resources: * "AWS::ECS::Service" * "AWS::EFS::FileSystem" * "AWS::ElasticLoadBalancingV2::LoadBalancer" * "AWS::Lambda::Function" * "AWS::SNS::Topic" Native The resource identifier is an Resilience Hub-native identifier and it can identify the following list of resources: * "AWS::ApiGateway::RestApi" * "AWS::ApiGatewayV2::Api" * "AWS::AutoScaling::AutoScalingGroup" * "AWS::DocDB::DBCluster" * "AWS::DocDB::DBGlobalCluster" * "AWS::DocDB::DBInstance" * "AWS::DynamoDB::GlobalTable" * "AWS::DynamoDB::Table" * "AWS::EC2::EC2Fleet" * "AWS::EC2::Instance" * "AWS::EC2::NatGateway" * "AWS::EC2::Volume" * "AWS::ElasticLoadBalancing::LoadBalancer" * "AWS::RDS::DBCluster" * "AWS::RDS::DBInstance" * "AWS::RDS::GlobalCluster" * "AWS::Route53::RecordSet" * "AWS::S3::Bucket" * "AWS::SQS::Queue" * **resourceName** *(string) --* The name of the resource. * **resourceType** *(string) --* Type of resource. * **sourceType** *(string) --* Type of input source. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / tag_resource tag_resource ************ ResilienceHub.Client.tag_resource(**kwargs) Applies one or more tags to a resource. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( resourceArn='string', tags={ 'string': 'string' } ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the resource. * **tags** (*dict*) -- **[REQUIRED]** The tags to assign to the resource. Each tag consists of a key/value pair. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / list_app_version_app_components list_app_version_app_components ******************************* ResilienceHub.Client.list_app_version_app_components(**kwargs) Lists all the Application Components in the Resilience Hub application. See also: AWS API Documentation **Request Syntax** response = client.list_app_version_app_components( appArn='string', appVersion='string', maxResults=123, nextToken='string' ) Parameters: * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appVersion** (*string*) -- **[REQUIRED]** Version of the Application Component. * **maxResults** (*integer*) -- Maximum number of Application Components to be displayed per Resilience Hub application version. * **nextToken** (*string*) -- Null, or the token from a previous call to get the next set of results. Return type: dict Returns: **Response Syntax** { 'appArn': 'string', 'appComponents': [ { 'additionalInfo': { 'string': [ 'string', ] }, 'id': 'string', 'name': 'string', 'type': 'string' }, ], 'appVersion': 'string', 'nextToken': 'string' } **Response Structure** * *(dict) --* * **appArn** *(string) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appComponents** *(list) --* Defines an Application Component. * *(dict) --* Defines an Application Component. * **additionalInfo** *(dict) --* Additional configuration parameters for an Resilience Hub application. If you want to implement "additionalInfo" through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters. Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.Key: ""failover-regions""Value: ""[{"region":"", "accounts":[{"id":""}]}]"" * *(string) --* * *(list) --* * *(string) --* * **id** *(string) --* Identifier of the Application Component. * **name** *(string) --* Name of the Application Component. * **type** *(string) --* The type of Application Component. * **appVersion** *(string) --* Resilience Hub application version. * **nextToken** *(string) --* Token for the next set of results, or null if there are no more results. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / publish_app_version publish_app_version ******************* ResilienceHub.Client.publish_app_version(**kwargs) Publishes a new version of a specific Resilience Hub application. See also: AWS API Documentation **Request Syntax** response = client.publish_app_version( appArn='string', versionName='string' ) Parameters: * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **versionName** (*string*) -- Name of the application version. Return type: dict Returns: **Response Syntax** { 'appArn': 'string', 'appVersion': 'string', 'identifier': 123, 'versionName': 'string' } **Response Structure** * *(dict) --* * **appArn** *(string) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appVersion** *(string) --* The version of the application. * **identifier** *(integer) --* Identifier of the application version. * **versionName** *(string) --* Name of the application version. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / describe_app_version_template describe_app_version_template ***************************** ResilienceHub.Client.describe_app_version_template(**kwargs) Describes details about an Resilience Hub application. See also: AWS API Documentation **Request Syntax** response = client.describe_app_version_template( appArn='string', appVersion='string' ) Parameters: * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appVersion** (*string*) -- **[REQUIRED]** The version of the application. Return type: dict Returns: **Response Syntax** { 'appArn': 'string', 'appTemplateBody': 'string', 'appVersion': 'string' } **Response Structure** * *(dict) --* * **appArn** *(string) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appTemplateBody** *(string) --* A JSON string that provides information about your application structure. To learn more about the "appTemplateBody" template, see the sample template provided in the *Examples* section. The "appTemplateBody" JSON string has the following structure: * "resources" The list of logical resources that must be included in the Resilience Hub application. Type: Array Note: Don't add the resources that you want to exclude. Each "resources" array item includes the following fields: * "logicalResourceId" Logical identifier of the resource. Type: Object Each "logicalResourceId" object includes the following fields: * "identifier" Identifier of the resource. Type: String * "logicalStackName" The name of the CloudFormation stack this resource belongs to. Type: String * "resourceGroupName" The name of the resource group this resource belongs to. Type: String * "terraformSourceName" The name of the Terraform S3 state file this resource belongs to. Type: String * "eksSourceName" Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to. Note: This parameter accepts values in "eks- cluster/namespace" format. Type: String * "type" The type of resource. Type: string * "name" The name of the resource. Type: String * "additionalInfo" Additional configuration parameters for an Resilience Hub application. If you want to implement "additionalInfo" through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters. Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: ""failover-regions"" Value: ""[{"region":"", "accounts":[{"id":""}]}]"" * "appComponents" List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added. Type: Array Each "appComponents" array item includes the following fields: * "name" Name of the Application Component. Type: String * "type" Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent. Type: String * "resourceNames" The list of included resources that are assigned to the Application Component. Type: Array of strings * "additionalInfo" Additional configuration parameters for an Resilience Hub application. If you want to implement "additionalInfo" through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters. Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: ""failover-regions"" Value: ""[{"region":"", "accounts":[{"id":""}]}]"" * "excludedResources" The list of logical resource identifiers to be excluded from the application. Type: Array Note: Don't add the resources that you want to include. Each "excludedResources" array item includes the following fields: * "logicalResourceIds" Logical identifier of the resource. Type: Object Note: You can configure only one of the following fields: * "logicalStackName" * "resourceGroupName" * "terraformSourceName" * "eksSourceName" Each "logicalResourceIds" object includes the following fields: * "identifier" Identifier of the resource. Type: String * "logicalStackName" The name of the CloudFormation stack this resource belongs to. Type: String * "resourceGroupName" The name of the resource group this resource belongs to. Type: String * "terraformSourceName" The name of the Terraform S3 state file this resource belongs to. Type: String * "eksSourceName" Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to. Note: This parameter accepts values in "eks- cluster/namespace" format. Type: String * "version" Resilience Hub application version. * "additionalInfo" Additional configuration parameters for an Resilience Hub application. If you want to implement "additionalInfo" through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters. Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: ""failover-regions"" Value: ""[{"region":"", "accounts":[{"id":""}]}]"" * **appVersion** *(string) --* The version of the application. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / delete_app delete_app ********** ResilienceHub.Client.delete_app(**kwargs) Deletes an Resilience Hub application. This is a destructive action that can't be undone. See also: AWS API Documentation **Request Syntax** response = client.delete_app( appArn='string', clientToken='string', forceDelete=True|False ) Parameters: * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **clientToken** (*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. * **forceDelete** (*boolean*) -- A boolean option to force the deletion of an Resilience Hub application. Return type: dict Returns: **Response Syntax** { 'appArn': 'string' } **Response Structure** * *(dict) --* * **appArn** *(string) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ConflictException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" ResilienceHub / Client / describe_app_version describe_app_version ******************** ResilienceHub.Client.describe_app_version(**kwargs) Describes the Resilience Hub application version. See also: AWS API Documentation **Request Syntax** response = client.describe_app_version( appArn='string', appVersion='string' ) Parameters: * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appVersion** (*string*) -- **[REQUIRED]** Resilience Hub application version. Return type: dict Returns: **Response Syntax** { 'additionalInfo': { 'string': [ 'string', ] }, 'appArn': 'string', 'appVersion': 'string' } **Response Structure** * *(dict) --* * **additionalInfo** *(dict) --* Additional configuration parameters for an Resilience Hub application. If you want to implement "additionalInfo" through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters. Note: Currently, this parameter supports only failover region and account. * *(string) --* * *(list) --* * *(string) --* * **appArn** *(string) --* Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app- id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **appVersion** *(string) --* Resilience Hub application version. **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / describe_resiliency_policy describe_resiliency_policy ************************** ResilienceHub.Client.describe_resiliency_policy(**kwargs) Describes a specified resiliency policy for an 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** response = client.describe_resiliency_policy( policyArn='string' ) Parameters: **policyArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":resiliency-policy/ "policy-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. Return type: dict Returns: **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'|'NotApplicable' } } **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) --* Date and time 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) --* Recovery Point Objective (RPO) in seconds. * **rtoInSecs** *(integer) --* Recovery Time Objective (RTO) in seconds. * **policyArn** *(string) --* Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":resiliency-policy/ "policy-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **policyDescription** *(string) --* Description of the resiliency policy. * **policyName** *(string) --* The name of the policy * **tags** *(dict) --* 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"). **Exceptions** * "ResilienceHub.Client.exceptions.InternalServerException" * "ResilienceHub.Client.exceptions.ResourceNotFoundException" * "ResilienceHub.Client.exceptions.ThrottlingException" * "ResilienceHub.Client.exceptions.ValidationException" * "ResilienceHub.Client.exceptions.AccessDeniedException" ResilienceHub / Client / batch_update_recommendation_status batch_update_recommendation_status ********************************** ResilienceHub.Client.batch_update_recommendation_status(**kwargs) Enables you to include or exclude one or more operational recommendations. See also: AWS API Documentation **Request Syntax** response = client.batch_update_recommendation_status( appArn='string', requestEntries=[ { 'appComponentId': 'string', 'entryId': 'string', 'excludeReason': 'AlreadyImplemented'|'NotRelevant'|'ComplexityOfImplementation', 'excluded': True|False, 'item': { 'resourceId': 'string', 'targetAccountId': 'string', 'targetRegion': 'string' }, 'referenceId': 'string' }, ] ) Parameters: * **appArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: "partition":resiliencehub: "region": "account":app/ "app-id". For more information about ARNs, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference* guide. * **requestEntries** (*list*) -- **[REQUIRED]** Defines the list of operational recommendations that need to be included or excluded. * *(dict) --* Defines the operational recommendation item that is to be included or excluded. * **appComponentId** *(string) --* Indicates the identifier of the AppComponent. * **entryId** *(string) --* **[REQUIRED]** An identifier for an entry in this batch that is used to communicate the result. Note: The >>``<>``<>``<