aws-elixir

View Source AWS.Resiliencehub (aws-elixir v1.0.4)

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.

Link to this section Summary

Functions

accept_resource_grouping_recommendations(client, input, options \\ [])

Accepts the resource grouping recommendations suggested by Resilience Hub for your application.

add_draft_app_version_resource_mappings(client, input, options \\ [])

Adds the source of resource-maps to the draft version of an application.

batch_update_recommendation_status(client, input, options \\ [])

Enables you to include or exclude one or more operational recommendations.

create_app(client, input, options \\ [])

Creates an Resilience Hub application.

create_app_version_app_component(client, input, options \\ [])

Creates a new Application Component in the Resilience Hub application.

create_app_version_resource(client, input, options \\ [])

Adds a resource to the Resilience Hub application and assigns it to the specified Application Components.

create_recommendation_template(client, input, options \\ [])

Creates a new recommendation template for the Resilience Hub application.

create_resiliency_policy(client, input, options \\ [])

Creates a resiliency policy for an application.

delete_app(client, input, options \\ [])

Deletes an Resilience Hub application.

delete_app_assessment(client, input, options \\ [])

Deletes an Resilience Hub application assessment.

delete_app_input_source(client, input, options \\ [])

Deletes the input source and all of its imported resources from the Resilience Hub application.

delete_app_version_app_component(client, input, options \\ [])

Deletes an Application Component from the Resilience Hub application.

delete_app_version_resource(client, input, options \\ [])

Deletes a resource from the Resilience Hub application.

delete_recommendation_template(client, input, options \\ [])

Deletes a recommendation template.

delete_resiliency_policy(client, input, options \\ [])

Deletes a resiliency policy.

describe_app(client, input, options \\ [])

Describes an Resilience Hub application.

describe_app_assessment(client, input, options \\ [])

Describes an assessment for an Resilience Hub application.

describe_app_version(client, input, options \\ [])

Describes the Resilience Hub application version.

describe_app_version_app_component(client, input, options \\ [])

Describes an Application Component in the Resilience Hub application.

describe_app_version_resource(client, input, options \\ [])

Describes a resource of the Resilience Hub application.

describe_app_version_resources_resolution_status(client, input, options \\ [])

Returns the resolution status for the specified resolution identifier for an application version.

describe_app_version_template(client, input, options \\ [])

Describes details about an Resilience Hub application.

describe_draft_app_version_resources_import_status(client, input, options \\ [])

Describes the status of importing resources to an application version.

describe_metrics_export(client, input, options \\ [])

Describes the metrics of the application configuration being exported.

describe_resiliency_policy(client, input, options \\ [])

Describes a specified resiliency policy for an Resilience Hub application.

describe_resource_grouping_recommendation_task(client, input, options \\ [])

Describes the resource grouping recommendation tasks run by Resilience Hub for your application.

import_resources_to_draft_app_version(client, input, options \\ [])

Imports resources to Resilience Hub application draft version from different input sources.

list_alarm_recommendations(client, input, options \\ [])

Lists the alarm recommendations for an Resilience Hub application.

list_app_assessment_compliance_drifts(client, input, options \\ [])

List of compliance drifts that were detected while running an assessment.

list_app_assessment_resource_drifts(client, input, options \\ [])

List of resource drifts that were detected while running an assessment.

list_app_assessments(client, app_arn \\ nil, assessment_name \\ nil, assessment_status \\ nil, compliance_status \\ nil, invoker \\ nil, max_results \\ nil, next_token \\ nil, reverse_order \\ nil, options \\ [])

Lists the assessments for an Resilience Hub application.

list_app_component_compliances(client, input, options \\ [])

Lists the compliances for an Resilience Hub Application Component.

list_app_component_recommendations(client, input, options \\ [])

Lists the recommendations for an Resilience Hub Application Component.

list_app_input_sources(client, input, options \\ [])

Lists all the input sources of the Resilience Hub application.

list_app_version_app_components(client, input, options \\ [])

Lists all the Application Components in the Resilience Hub application.

list_app_version_resource_mappings(client, input, options \\ [])

Lists how the resources in an application version are mapped/sourced from.

list_app_version_resources(client, input, options \\ [])

Lists all the resources in an Resilience Hub application.

list_app_versions(client, input, options \\ [])

Lists the different versions for the Resilience Hub applications.

list_apps(client, app_arn \\ nil, aws_application_arn \\ nil, from_last_assessment_time \\ nil, max_results \\ nil, name \\ nil, next_token \\ nil, reverse_order \\ nil, to_last_assessment_time \\ nil, options \\ [])

Lists your Resilience Hub applications.

list_metrics(client, input, options \\ [])

Lists the metrics that can be exported.

list_recommendation_templates(client, assessment_arn \\ nil, max_results \\ nil, name \\ nil, next_token \\ nil, recommendation_template_arn \\ nil, reverse_order \\ nil, status \\ nil, options \\ [])

Lists the recommendation templates for the Resilience Hub applications.

list_resiliency_policies(client, max_results \\ nil, next_token \\ nil, policy_name \\ nil, options \\ [])

Lists the resiliency policies for the Resilience Hub applications.

list_resource_grouping_recommendations(client, app_arn \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the resource grouping recommendations suggested by Resilience Hub for your application.

list_sop_recommendations(client, input, options \\ [])

Lists the standard operating procedure (SOP) recommendations for the Resilience Hub applications.

list_suggested_resiliency_policies(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the suggested resiliency policies for the Resilience Hub applications.

list_tags_for_resource(client, resource_arn, options \\ [])

Lists the tags for your resources in your Resilience Hub applications.

list_test_recommendations(client, input, options \\ [])

Lists the test recommendations for the Resilience Hub application.

list_unsupported_app_version_resources(client, input, options \\ [])

Lists the resources that are not currently supported in Resilience Hub.

metadata()
publish_app_version(client, input, options \\ [])

Publishes a new version of a specific Resilience Hub application.

put_draft_app_version_template(client, input, options \\ [])

Adds or updates the app template for an Resilience Hub application draft version.

reject_resource_grouping_recommendations(client, input, options \\ [])

Rejects resource grouping recommendations.

remove_draft_app_version_resource_mappings(client, input, options \\ [])

Removes resource mappings from a draft application version.

resolve_app_version_resources(client, input, options \\ [])

Resolves the resources for an application version.

start_app_assessment(client, input, options \\ [])

Creates a new application assessment for an application.

start_metrics_export(client, input, options \\ [])

Initiates the export task of metrics.

start_resource_grouping_recommendation_task(client, input, options \\ [])

Starts grouping recommendation task.

tag_resource(client, resource_arn, input, options \\ [])

Applies one or more tags to a resource.

untag_resource(client, resource_arn, input, options \\ [])

Removes one or more tags from a resource.

update_app(client, input, options \\ [])

Updates an application.

update_app_version(client, input, options \\ [])

Updates the Resilience Hub application version.

update_app_version_app_component(client, input, options \\ [])

Updates an existing Application Component in the Resilience Hub application.

update_app_version_resource(client, input, options \\ [])

Updates the resource details in the Resilience Hub application.

update_resiliency_policy(client, input, options \\ [])

Updates a resiliency policy.

Link to this section Functions

Link to this function

accept_resource_grouping_recommendations(client, input, options \\ [])

View Source

Accepts the resource grouping recommendations suggested by Resilience Hub for your application.

Link to this function

add_draft_app_version_resource_mappings(client, input, options \\ [])

View Source

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.

Link to this function

batch_update_recommendation_status(client, input, options \\ [])

View Source

Enables you to include or exclude one or more operational recommendations.

Link to this function

create_app(client, input, options \\ [])

View Source

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).

Link to this function

create_app_version_app_component(client, input, options \\ [])

View Source

Creates a new Application Component in the Resilience Hub application.

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.

Link to this function

create_app_version_resource(client, input, options \\ [])

View Source

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.

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.

Link to this function

create_recommendation_template(client, input, options \\ [])

View Source

Creates a new recommendation template for the Resilience Hub application.

Link to this function

create_resiliency_policy(client, input, options \\ [])

View Source

Creates a resiliency policy for an application.

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.

Link to this function

delete_app(client, input, options \\ [])

View Source

Deletes an Resilience Hub application.

This is a destructive action that can't be undone.

Link to this function

delete_app_assessment(client, input, options \\ [])

View Source

Deletes an Resilience Hub application assessment.

This is a destructive action that can't be undone.

Link to this function

delete_app_input_source(client, input, options \\ [])

View Source

Deletes the input source and all of its imported resources from the Resilience Hub application.

Link to this function

delete_app_version_app_component(client, input, options \\ [])

View Source

Deletes an Application Component from the Resilience Hub application.

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.

Link to this function

delete_app_version_resource(client, input, options \\ [])

View Source

Deletes a resource from the Resilience Hub application.

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.

Link to this function

delete_recommendation_template(client, input, options \\ [])

View Source

Deletes a recommendation template.

This is a destructive action that can't be undone.

Link to this function

delete_resiliency_policy(client, input, options \\ [])

View Source

Deletes a resiliency policy.

This is a destructive action that can't be undone.

Link to this function

describe_app(client, input, options \\ [])

View Source

Describes an Resilience Hub application.

Link to this function

describe_app_assessment(client, input, options \\ [])

View Source

Describes an assessment for an Resilience Hub application.

Link to this function

describe_app_version(client, input, options \\ [])

View Source

Describes the Resilience Hub application version.

Link to this function

describe_app_version_app_component(client, input, options \\ [])

View Source

Describes an Application Component in the Resilience Hub application.

Link to this function

describe_app_version_resource(client, input, options \\ [])

View Source

Describes a resource of the Resilience Hub application.

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)

Link to this function

describe_app_version_resources_resolution_status(client, input, options \\ [])

View Source

Returns the resolution status for the specified resolution identifier for an application version.

If resolutionId is not specified, the current resolution status is returned.

Link to this function

describe_app_version_template(client, input, options \\ [])

View Source

Describes details about an Resilience Hub application.

Link to this function

describe_draft_app_version_resources_import_status(client, input, options \\ [])

View Source

Describes the status of importing resources to an application version.

If you get a 404 error with ResourceImportStatusNotFoundAppMetadataException, you must call importResourcesToDraftAppVersion after creating the application and before calling describeDraftAppVersionResourcesImportStatus to obtain the status.

Link to this function

describe_metrics_export(client, input, options \\ [])

View Source

Describes the metrics of the application configuration being exported.

Link to this function

describe_resiliency_policy(client, input, options \\ [])

View Source

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.

Link to this function

describe_resource_grouping_recommendation_task(client, input, options \\ [])

View Source

Describes the resource grouping recommendation tasks run by Resilience Hub for your application.

Link to this function

import_resources_to_draft_app_version(client, input, options \\ [])

View Source

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.

Link to this function

list_alarm_recommendations(client, input, options \\ [])

View Source

Lists the alarm recommendations for an Resilience Hub application.

Link to this function

list_app_assessment_compliance_drifts(client, input, options \\ [])

View Source

List of compliance drifts that were detected while running an assessment.

Link to this function

list_app_assessment_resource_drifts(client, input, options \\ [])

View Source

List of resource drifts that were detected while running an assessment.

Link to this function

list_app_assessments(client, app_arn \\ nil, assessment_name \\ nil, assessment_status \\ nil, compliance_status \\ nil, invoker \\ nil, max_results \\ nil, next_token \\ nil, reverse_order \\ nil, options \\ [])

View Source

Lists the assessments for an Resilience Hub application.

You can use request parameters to refine the results for the response object.

Link to this function

list_app_component_compliances(client, input, options \\ [])

View Source

Lists the compliances for an Resilience Hub Application Component.

Link to this function

list_app_component_recommendations(client, input, options \\ [])

View Source

Lists the recommendations for an Resilience Hub Application Component.

Link to this function

list_app_input_sources(client, input, options \\ [])

View Source

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.

Link to this function

list_app_version_app_components(client, input, options \\ [])

View Source

Lists all the Application Components in the Resilience Hub application.

Link to this function

list_app_version_resource_mappings(client, input, options \\ [])

View Source

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.

Link to this function

list_app_version_resources(client, input, options \\ [])

View Source

Lists all the resources in an Resilience Hub application.

Link to this function

list_app_versions(client, input, options \\ [])

View Source

Lists the different versions for the Resilience Hub applications.

Link to this function

list_apps(client, app_arn \\ nil, aws_application_arn \\ nil, from_last_assessment_time \\ nil, max_results \\ nil, name \\ nil, next_token \\ nil, reverse_order \\ nil, to_last_assessment_time \\ nil, options \\ [])

View Source

Lists your Resilience Hub applications.

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.
Link to this function

list_metrics(client, input, options \\ [])

View Source

Lists the metrics that can be exported.

Link to this function

list_recommendation_templates(client, assessment_arn \\ nil, max_results \\ nil, name \\ nil, next_token \\ nil, recommendation_template_arn \\ nil, reverse_order \\ nil, status \\ nil, options \\ [])

View Source

Lists the recommendation templates for the Resilience Hub applications.

Link to this function

list_resiliency_policies(client, max_results \\ nil, next_token \\ nil, policy_name \\ nil, options \\ [])

View Source

Lists the resiliency policies for the Resilience Hub applications.

Link to this function

list_resource_grouping_recommendations(client, app_arn \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the resource grouping recommendations suggested by Resilience Hub for your application.

Link to this function

list_sop_recommendations(client, input, options \\ [])

View Source

Lists the standard operating procedure (SOP) recommendations for the Resilience Hub applications.

Link to this function

list_suggested_resiliency_policies(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the suggested resiliency policies for the Resilience Hub applications.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Lists the tags for your resources in your Resilience Hub applications.

Link to this function

list_test_recommendations(client, input, options \\ [])

View Source

Lists the test recommendations for the Resilience Hub application.

Link to this function

list_unsupported_app_version_resources(client, input, options \\ [])

View Source

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.

Link to this function

metadata()

View Source
Link to this function

publish_app_version(client, input, options \\ [])

View Source

Publishes a new version of a specific Resilience Hub application.

Link to this function

put_draft_app_version_template(client, input, options \\ [])

View Source

Adds or updates the app template for an Resilience Hub application draft version.

Link to this function

reject_resource_grouping_recommendations(client, input, options \\ [])

View Source

Rejects resource grouping recommendations.

Link to this function

remove_draft_app_version_resource_mappings(client, input, options \\ [])

View Source

Removes resource mappings from a draft application version.

Link to this function

resolve_app_version_resources(client, input, options \\ [])

View Source

Resolves the resources for an application version.

Link to this function

start_app_assessment(client, input, options \\ [])

View Source

Creates a new application assessment for an application.

Link to this function

start_metrics_export(client, input, options \\ [])

View Source

Initiates the export task of metrics.

Link to this function

start_resource_grouping_recommendation_task(client, input, options \\ [])

View Source

Starts grouping recommendation task.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Applies one or more tags to a resource.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes one or more tags from a resource.

Link to this function

update_app(client, input, options \\ [])

View Source

Updates an application.

Link to this function

update_app_version(client, input, options \\ [])

View Source

Updates the Resilience Hub application version.

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.

Link to this function

update_app_version_app_component(client, input, options \\ [])

View Source

Updates an existing Application Component in the Resilience Hub application.

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.

Link to this function

update_app_version_resource(client, input, options \\ [])

View Source

Updates the resource details in the Resilience Hub application.

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.

Link to this function

update_resiliency_policy(client, input, options \\ [])

View Source

Updates a resiliency policy.

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.