View Source AWS.Resiliencehub (aws-elixir v0.13.3)
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
Adds the resource mapping for the draft application version.
Creates an Resilience Hub application.
Creates a new Application Component in the Resilience Hub application.
Adds a resource to the Resilience Hub application and assigns it to the specified Application Components.
Creates a new recommendation template for the Resilience Hub application.
Creates a resiliency policy for an application.
Deletes an Resilience Hub application.
Deletes an Resilience Hub application assessment.
Deletes the input source and all of its imported resources from the Resilience Hub application.
Deletes an Application Component from the Resilience Hub application.
Deletes a resource from the Resilience Hub application.
Deletes a recommendation template.
Deletes a resiliency policy.
Describes an Resilience Hub application.
Describes an assessment for an Resilience Hub application.
Describes the Resilience Hub application version.
Describes an Application Component in the Resilience Hub application.
Describes a resource of the Resilience Hub application.
Returns the resolution status for the specified resolution identifier for an application version.
Describes details about an Resilience Hub application.
Describes the status of importing resources to an application version.
Describes a specified resiliency policy for an Resilience Hub application.
Imports resources to Resilience Hub application draft version from different input sources.
Lists the alarm recommendations for an Resilience Hub application.
Lists the assessments for an Resilience Hub application.
Lists the compliances for an Resilience Hub Application Component.
Lists the recommendations for an Resilience Hub Application Component.
Lists all the input sources of the Resilience Hub application.
Lists all the Application Components in the Resilience Hub application.
Lists how the resources in an application version are mapped/sourced from.
Lists all the resources in an Resilience Hub application.
Lists the different versions for the Resilience Hub applications.
Lists your Resilience Hub applications.
Lists the recommendation templates for the Resilience Hub applications.
Lists the resiliency policies for the Resilience Hub applications.
Lists the standard operating procedure (SOP) recommendations for the Resilience Hub applications.
Lists the suggested resiliency policies for the Resilience Hub applications.
Lists the tags for your resources in your Resilience Hub applications.
Lists the test recommendations for the Resilience Hub application.
Lists the resources that are not currently supported in Resilience Hub.
Publishes a new version of a specific Resilience Hub application.
Adds or updates the app template for an Resilience Hub application draft version.
Removes resource mappings from a draft application version.
Resolves the resources for an application version.
Creates a new application assessment for an application.
Applies one or more tags to a resource.
Removes one or more tags from a resource.
Updates an application.
Updates the Resilience Hub application version.
Updates an existing Application Component in the Resilience Hub application.
Updates the resource details in the Resilience Hub application.
Updates a resiliency policy.
Link to this section Functions
add_draft_app_version_resource_mappings(client, input, options \\ [])
View SourceAdds the resource mapping for the draft application version.
You can also update an existing resource mapping to a new physical resource.
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–up to 20–CloudFormation stacks, and an appropriate resiliency policy.
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).
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.
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.
Creates a new recommendation template for the Resilience Hub application.
Creates a resiliency policy for an application.
Deletes an Resilience Hub application.
This is a destructive action that can't be undone.
Deletes an Resilience Hub application assessment.
This is a destructive action that can't be undone.
Deletes the input source and all of its imported resources from the Resilience Hub application.
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.
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.
Deletes a recommendation template.
This is a destructive action that can't be undone.
Deletes a resiliency policy.
This is a destructive action that can't be undone.
Describes an Resilience Hub application.
Describes an assessment for an Resilience Hub application.
Describes the Resilience Hub application version.
Describes an Application Component in the Resilience Hub application.
Describes a resource of the Resilience Hub application.
This API accepts only one of the following parameters to descibe the resource:
resourceName
logicalResourceId
physicalResourceId
(Along with physicalResourceId
, you can also
provide awsAccountId
, and awsRegion
)
describe_app_version_resources_resolution_status(client, input, options \\ [])
View SourceReturns the resolution status for the specified resolution identifier for an application version.
If resolutionId
is not specified, the current resolution status is returned.
Describes details about an Resilience Hub application.
describe_draft_app_version_resources_import_status(client, input, options \\ [])
View SourceDescribes 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.
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.
import_resources_to_draft_app_version(client, input, options \\ [])
View SourceImports 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.
Lists the alarm recommendations for an Resilience Hub application.
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 SourceLists the assessments for an Resilience Hub application.
You can use request parameters to refine the results for the response object.
Lists the compliances for an Resilience Hub Application Component.
Lists the recommendations for an Resilience Hub Application Component.
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.
Lists all the Application Components in the Resilience Hub application.
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.
Lists all the resources in an Resilience Hub application.
Lists the different versions for the Resilience Hub applications.
list_apps(client, app_arn \\ nil, max_results \\ nil, name \\ nil, next_token \\ nil, options \\ [])
View SourceLists 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.
list_recommendation_templates(client, assessment_arn, max_results \\ nil, name \\ nil, next_token \\ nil, recommendation_template_arn \\ nil, reverse_order \\ nil, status \\ nil, options \\ [])
View SourceLists the recommendation templates for the Resilience Hub applications.
list_resiliency_policies(client, max_results \\ nil, next_token \\ nil, policy_name \\ nil, options \\ [])
View SourceLists the resiliency policies for the Resilience Hub applications.
Lists the standard operating procedure (SOP) recommendations for the Resilience Hub applications.
list_suggested_resiliency_policies(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the suggested resiliency policies for the Resilience Hub applications.
Lists the tags for your resources in your Resilience Hub applications.
Lists the test recommendations for the Resilience Hub application.
list_unsupported_app_version_resources(client, input, options \\ [])
View SourceLists 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.
Publishes a new version of a specific Resilience Hub application.
Adds or updates the app template for an Resilience Hub application draft version.
remove_draft_app_version_resource_mappings(client, input, options \\ [])
View SourceRemoves resource mappings from a draft application version.
Resolves the resources for an application version.
Creates a new application assessment for an application.
Applies one or more tags to a resource.
Removes one or more tags from a resource.
Updates an application.
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.
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.
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.
Updates a resiliency policy.