Resiliencehub

import { Resiliencehub } from "https://aws-api.deno.dev/v0.4/services/resiliencehub.ts?docs=full";

class Resiliencehub {

constructor(apiFactory: client.ApiFactory);

async addDraftAppVersionResourceMappings(params: AddDraftAppVersionResourceMappingsRequest, opts?: client.RequestOptions): Promise<AddDraftAppVersionResourceMappingsResponse>;

async createApp(params: CreateAppRequest, opts?: client.RequestOptions): Promise<CreateAppResponse>;

async createAppVersionAppComponent(params: CreateAppVersionAppComponentRequest, opts?: client.RequestOptions): Promise<CreateAppVersionAppComponentResponse>;

async createAppVersionResource(params: CreateAppVersionResourceRequest, opts?: client.RequestOptions): Promise<CreateAppVersionResourceResponse>;

async createRecommendationTemplate(params: CreateRecommendationTemplateRequest, opts?: client.RequestOptions): Promise<CreateRecommendationTemplateResponse>;

async createResiliencyPolicy(params: CreateResiliencyPolicyRequest, opts?: client.RequestOptions): Promise<CreateResiliencyPolicyResponse>;

async deleteApp(params: DeleteAppRequest, opts?: client.RequestOptions): Promise<DeleteAppResponse>;

async deleteAppAssessment(params: DeleteAppAssessmentRequest, opts?: client.RequestOptions): Promise<DeleteAppAssessmentResponse>;

async deleteAppInputSource(params: DeleteAppInputSourceRequest, opts?: client.RequestOptions): Promise<DeleteAppInputSourceResponse>;

async deleteAppVersionAppComponent(params: DeleteAppVersionAppComponentRequest, opts?: client.RequestOptions): Promise<DeleteAppVersionAppComponentResponse>;

async deleteAppVersionResource(params: DeleteAppVersionResourceRequest, opts?: client.RequestOptions): Promise<DeleteAppVersionResourceResponse>;

async deleteRecommendationTemplate(params: DeleteRecommendationTemplateRequest, opts?: client.RequestOptions): Promise<DeleteRecommendationTemplateResponse>;

async deleteResiliencyPolicy(params: DeleteResiliencyPolicyRequest, opts?: client.RequestOptions): Promise<DeleteResiliencyPolicyResponse>;

async describeApp(params: DescribeAppRequest, opts?: client.RequestOptions): Promise<DescribeAppResponse>;

async describeAppAssessment(params: DescribeAppAssessmentRequest, opts?: client.RequestOptions): Promise<DescribeAppAssessmentResponse>;

async describeAppVersion(params: DescribeAppVersionRequest, opts?: client.RequestOptions): Promise<DescribeAppVersionResponse>;

async describeAppVersionAppComponent(params: DescribeAppVersionAppComponentRequest, opts?: client.RequestOptions): Promise<DescribeAppVersionAppComponentResponse>;

async describeAppVersionResource(params: DescribeAppVersionResourceRequest, opts?: client.RequestOptions): Promise<DescribeAppVersionResourceResponse>;

async describeAppVersionResourcesResolutionStatus(params: DescribeAppVersionResourcesResolutionStatusRequest, opts?: client.RequestOptions): Promise<DescribeAppVersionResourcesResolutionStatusResponse>;

async describeAppVersionTemplate(params: DescribeAppVersionTemplateRequest, opts?: client.RequestOptions): Promise<DescribeAppVersionTemplateResponse>;

async describeDraftAppVersionResourcesImportStatus(params: DescribeDraftAppVersionResourcesImportStatusRequest, opts?: client.RequestOptions): Promise<DescribeDraftAppVersionResourcesImportStatusResponse>;

async describeResiliencyPolicy(params: DescribeResiliencyPolicyRequest, opts?: client.RequestOptions): Promise<DescribeResiliencyPolicyResponse>;

async importResourcesToDraftAppVersion(params: ImportResourcesToDraftAppVersionRequest, opts?: client.RequestOptions): Promise<ImportResourcesToDraftAppVersionResponse>;

async listAlarmRecommendations(params: ListAlarmRecommendationsRequest, opts?: client.RequestOptions): Promise<ListAlarmRecommendationsResponse>;

async listAppAssessments(params?: ListAppAssessmentsRequest, opts?: client.RequestOptions): Promise<ListAppAssessmentsResponse>;

async listAppComponentCompliances(params: ListAppComponentCompliancesRequest, opts?: client.RequestOptions): Promise<ListAppComponentCompliancesResponse>;

async listAppComponentRecommendations(params: ListAppComponentRecommendationsRequest, opts?: client.RequestOptions): Promise<ListAppComponentRecommendationsResponse>;

async listAppInputSources(params: ListAppInputSourcesRequest, opts?: client.RequestOptions): Promise<ListAppInputSourcesResponse>;

async listApps(params?: ListAppsRequest, opts?: client.RequestOptions): Promise<ListAppsResponse>;

async listAppVersionAppComponents(params: ListAppVersionAppComponentsRequest, opts?: client.RequestOptions): Promise<ListAppVersionAppComponentsResponse>;

async listAppVersionResourceMappings(params: ListAppVersionResourceMappingsRequest, opts?: client.RequestOptions): Promise<ListAppVersionResourceMappingsResponse>;

async listAppVersionResources(params: ListAppVersionResourcesRequest, opts?: client.RequestOptions): Promise<ListAppVersionResourcesResponse>;

async listAppVersions(params: ListAppVersionsRequest, opts?: client.RequestOptions): Promise<ListAppVersionsResponse>;

async listRecommendationTemplates(params: ListRecommendationTemplatesRequest, opts?: client.RequestOptions): Promise<ListRecommendationTemplatesResponse>;

async listResiliencyPolicies(params?: ListResiliencyPoliciesRequest, opts?: client.RequestOptions): Promise<ListResiliencyPoliciesResponse>;

async listSopRecommendations(params: ListSopRecommendationsRequest, opts?: client.RequestOptions): Promise<ListSopRecommendationsResponse>;

async listSuggestedResiliencyPolicies(params?: ListSuggestedResiliencyPoliciesRequest, opts?: client.RequestOptions): Promise<ListSuggestedResiliencyPoliciesResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async listTestRecommendations(params: ListTestRecommendationsRequest, opts?: client.RequestOptions): Promise<ListTestRecommendationsResponse>;

async listUnsupportedAppVersionResources(params: ListUnsupportedAppVersionResourcesRequest, opts?: client.RequestOptions): Promise<ListUnsupportedAppVersionResourcesResponse>;

async publishAppVersion(params: PublishAppVersionRequest, opts?: client.RequestOptions): Promise<PublishAppVersionResponse>;

async putDraftAppVersionTemplate(params: PutDraftAppVersionTemplateRequest, opts?: client.RequestOptions): Promise<PutDraftAppVersionTemplateResponse>;

async removeDraftAppVersionResourceMappings(params: RemoveDraftAppVersionResourceMappingsRequest, opts?: client.RequestOptions): Promise<RemoveDraftAppVersionResourceMappingsResponse>;

async resolveAppVersionResources(params: ResolveAppVersionResourcesRequest, opts?: client.RequestOptions): Promise<ResolveAppVersionResourcesResponse>;

async startAppAssessment(params: StartAppAssessmentRequest, opts?: client.RequestOptions): Promise<StartAppAssessmentResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateApp(params: UpdateAppRequest, opts?: client.RequestOptions): Promise<UpdateAppResponse>;

async updateAppVersion(params: UpdateAppVersionRequest, opts?: client.RequestOptions): Promise<UpdateAppVersionResponse>;

async updateAppVersionAppComponent(params: UpdateAppVersionAppComponentRequest, opts?: client.RequestOptions): Promise<UpdateAppVersionAppComponentResponse>;

async updateAppVersionResource(params: UpdateAppVersionResourceRequest, opts?: client.RequestOptions): Promise<UpdateAppVersionResourceResponse>;

async updateResiliencyPolicy(params: UpdateResiliencyPolicyRequest, opts?: client.RequestOptions): Promise<UpdateResiliencyPolicyResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new Resiliencehub(apiFactory: client.ApiFactory)

[src]

§Methods

addDraftAppVersionResourceMappings(params: AddDraftAppVersionResourceMappingsRequest, opts?: client.RequestOptions): Promise<AddDraftAppVersionResourceMappingsResponse>

[src]

Adds the resource mapping for the draft application version. You can also update an existing resource mapping to a new physical resource.

createApp(params: CreateAppRequest, opts?: client.RequestOptions): Promise<CreateAppResponse>

[src]

Creates an AWS Resilience Hub application. An AWS Resilience Hub application is a collection of Amazon Web Services resources structured to prevent and recover Amazon Web Services application disruptions. To describe a AWS Resilience Hub application, you provide an application name, resources from one or more–up to five–CloudFormation stacks, and an appropriate resiliency policy.

After you create an AWS 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).

createAppVersionAppComponent(params: CreateAppVersionAppComponentRequest, opts?: client.RequestOptions): Promise<CreateAppVersionAppComponentResponse>

[src]

Creates a new Application Component in the AWS Resilience Hub application.

Note: This API updates the AWS Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the AWS Resilience Hub application using the PublishAppVersion API.

createAppVersionResource(params: CreateAppVersionResourceRequest, opts?: client.RequestOptions): Promise<CreateAppVersionResourceResponse>

[src]

Adds a resource to the AWS Resilience Hub applicationand assigns it to the specified Application Components. If you specify a new Application Component, AWS Resilience Hub will automatically create the Application Component.

Note: - This action has no effect outside AWS Resilience Hub. - This API updates the AWS Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the AWS Resilience Hub application using the PublishAppVersion API. - To update application version with new physicalResourceID, you must call ResolveAppVersionResources API.

createRecommendationTemplate(params: CreateRecommendationTemplateRequest, opts?: client.RequestOptions): Promise<CreateRecommendationTemplateResponse>

[src]

Creates a new recommendation template for the AWS Resilience Hub application.

createResiliencyPolicy(params: CreateResiliencyPolicyRequest, opts?: client.RequestOptions): Promise<CreateResiliencyPolicyResponse>

[src]

Creates a resiliency policy for an application.

deleteApp(params: DeleteAppRequest, opts?: client.RequestOptions): Promise<DeleteAppResponse>

[src]

Deletes an AWS Resilience Hub application. This is a destructive action that can't be undone.

deleteAppAssessment(params: DeleteAppAssessmentRequest, opts?: client.RequestOptions): Promise<DeleteAppAssessmentResponse>

[src]

Deletes an AWS Resilience Hub application assessment. This is a destructive action that can't be undone.

deleteAppInputSource(params: DeleteAppInputSourceRequest, opts?: client.RequestOptions): Promise<DeleteAppInputSourceResponse>

[src]

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

deleteAppVersionAppComponent(params: DeleteAppVersionAppComponentRequest, opts?: client.RequestOptions): Promise<DeleteAppVersionAppComponentResponse>

[src]

Deletes an Application Component from the AWS Resilience Hub application.

Note: - This API updates the AWS Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the AWS Resilience Hub application using the PublishAppVersion API. - You will not be able to delete an Application Component if it has resources associated with it.

deleteAppVersionResource(params: DeleteAppVersionResourceRequest, opts?: client.RequestOptions): Promise<DeleteAppVersionResourceResponse>

[src]

Deletes a resource from the AWS 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 AWS Resilience Hub. - This API updates the AWS Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the AWS Resilience Hub application using the PublishAppVersion API.

deleteRecommendationTemplate(params: DeleteRecommendationTemplateRequest, opts?: client.RequestOptions): Promise<DeleteRecommendationTemplateResponse>

[src]

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

deleteResiliencyPolicy(params: DeleteResiliencyPolicyRequest, opts?: client.RequestOptions): Promise<DeleteResiliencyPolicyResponse>

[src]

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

describeApp(params: DescribeAppRequest, opts?: client.RequestOptions): Promise<DescribeAppResponse>

[src]

Describes an AWS Resilience Hub application.

describeAppAssessment(params: DescribeAppAssessmentRequest, opts?: client.RequestOptions): Promise<DescribeAppAssessmentResponse>

[src]

Describes an assessment for an AWS Resilience Hub application.

describeAppVersion(params: DescribeAppVersionRequest, opts?: client.RequestOptions): Promise<DescribeAppVersionResponse>

[src]

Describes the AWS Resilience Hub application version.

describeAppVersionAppComponent(params: DescribeAppVersionAppComponentRequest, opts?: client.RequestOptions): Promise<DescribeAppVersionAppComponentResponse>

[src]

Describes an Application Component in the AWS Resilience Hub application.

describeAppVersionResource(params: DescribeAppVersionResourceRequest, opts?: client.RequestOptions): Promise<DescribeAppVersionResourceResponse>

[src]

Describes a resource of the AWS Resilience Hub application.

Note: 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)

describeAppVersionResourcesResolutionStatus(params: DescribeAppVersionResourcesResolutionStatusRequest, opts?: client.RequestOptions): Promise<DescribeAppVersionResourcesResolutionStatusResponse>

[src]

Returns the resolution status for the specified resolution identifier for an application version. If resolutionId is not specified, the current resolution status is returned.

describeAppVersionTemplate(params: DescribeAppVersionTemplateRequest, opts?: client.RequestOptions): Promise<DescribeAppVersionTemplateResponse>

[src]

Describes details about an AWS Resilience Hub application.

describeDraftAppVersionResourcesImportStatus(params: DescribeDraftAppVersionResourcesImportStatusRequest, opts?: client.RequestOptions): Promise<DescribeDraftAppVersionResourcesImportStatusResponse>

[src]

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.

describeResiliencyPolicy(params: DescribeResiliencyPolicyRequest, opts?: client.RequestOptions): Promise<DescribeResiliencyPolicyResponse>

[src]

Describes a specified resiliency policy for an AWS Resilience Hub application. The returned policy object includes creation time, data location constraints, the Amazon Resource Name (ARN) for the policy, tags, tier, and more.

importResourcesToDraftAppVersion(params: ImportResourcesToDraftAppVersionRequest, opts?: client.RequestOptions): Promise<ImportResourcesToDraftAppVersionResponse>

[src]

Imports resources to AWS Resilience Hub application draft version from different input sources. For more information about the input sources supported by AWS Resilience Hub, see Discover the structure and describe your Resilience Hub application.

listAlarmRecommendations(params: ListAlarmRecommendationsRequest, opts?: client.RequestOptions): Promise<ListAlarmRecommendationsResponse>

[src]

Lists the alarm recommendations for an AWS Resilience Hub application.

listAppAssessments(params?: ListAppAssessmentsRequest, opts?: client.RequestOptions): Promise<ListAppAssessmentsResponse>

[src]

Lists the assessments for an AWS Resilience Hub application. You can use request parameters to refine the results for the response object.

listAppComponentCompliances(params: ListAppComponentCompliancesRequest, opts?: client.RequestOptions): Promise<ListAppComponentCompliancesResponse>

[src]

Lists the compliances for an AWS Resilience Hub Application Component.

listAppComponentRecommendations(params: ListAppComponentRecommendationsRequest, opts?: client.RequestOptions): Promise<ListAppComponentRecommendationsResponse>

[src]

Lists the recommendations for an AWS Resilience Hub Application Component.

listAppInputSources(params: ListAppInputSourcesRequest, opts?: client.RequestOptions): Promise<ListAppInputSourcesResponse>

[src]

Lists all the input sources of the AWS Resilience Hub application. For more information about the input sources supported by AWS Resilience Hub, see Discover the structure and describe your Resilience Hub application.

listApps(params?: ListAppsRequest, opts?: client.RequestOptions): Promise<ListAppsResponse>

[src]

Lists your AWS 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.

listAppVersionAppComponents(params: ListAppVersionAppComponentsRequest, opts?: client.RequestOptions): Promise<ListAppVersionAppComponentsResponse>

[src]

Lists all the Application Components in the AWS Resilience Hub application.

listAppVersionResourceMappings(params: ListAppVersionResourceMappingsRequest, opts?: client.RequestOptions): Promise<ListAppVersionResourceMappingsResponse>

[src]

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.

listAppVersionResources(params: ListAppVersionResourcesRequest, opts?: client.RequestOptions): Promise<ListAppVersionResourcesResponse>

[src]

Lists all the resources in an AWS Resilience Hub application.

listAppVersions(params: ListAppVersionsRequest, opts?: client.RequestOptions): Promise<ListAppVersionsResponse>

[src]

Lists the different versions for the AWS Resilience Hub applications.

listRecommendationTemplates(params: ListRecommendationTemplatesRequest, opts?: client.RequestOptions): Promise<ListRecommendationTemplatesResponse>

[src]

Lists the recommendation templates for the AWS Resilience Hub applications.

listResiliencyPolicies(params?: ListResiliencyPoliciesRequest, opts?: client.RequestOptions): Promise<ListResiliencyPoliciesResponse>

[src]

Lists the resiliency policies for the AWS Resilience Hub applications.

listSopRecommendations(params: ListSopRecommendationsRequest, opts?: client.RequestOptions): Promise<ListSopRecommendationsResponse>

[src]

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

listSuggestedResiliencyPolicies(params?: ListSuggestedResiliencyPoliciesRequest, opts?: client.RequestOptions): Promise<ListSuggestedResiliencyPoliciesResponse>

[src]

Lists the suggested resiliency policies for the AWS Resilience Hub applications.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

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

listTestRecommendations(params: ListTestRecommendationsRequest, opts?: client.RequestOptions): Promise<ListTestRecommendationsResponse>

[src]

Lists the test recommendations for the AWS Resilience Hub application.

listUnsupportedAppVersionResources(params: ListUnsupportedAppVersionResourcesRequest, opts?: client.RequestOptions): Promise<ListUnsupportedAppVersionResourcesResponse>

[src]

Lists the resources that are not currently supported in AWS Resilience Hub. An unsupported resource is a resource that exists in the object that was used to create an app, but is not supported by AWS Resilience Hub.

publishAppVersion(params: PublishAppVersionRequest, opts?: client.RequestOptions): Promise<PublishAppVersionResponse>

[src]

Publishes a new version of a specific AWS Resilience Hub application.

putDraftAppVersionTemplate(params: PutDraftAppVersionTemplateRequest, opts?: client.RequestOptions): Promise<PutDraftAppVersionTemplateResponse>

[src]

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

removeDraftAppVersionResourceMappings(params: RemoveDraftAppVersionResourceMappingsRequest, opts?: client.RequestOptions): Promise<RemoveDraftAppVersionResourceMappingsResponse>

[src]

Removes resource mappings from a draft application version.

resolveAppVersionResources(params: ResolveAppVersionResourcesRequest, opts?: client.RequestOptions): Promise<ResolveAppVersionResourcesResponse>

[src]

Resolves the resources for an application version.

startAppAssessment(params: StartAppAssessmentRequest, opts?: client.RequestOptions): Promise<StartAppAssessmentResponse>

[src]

Creates a new application assessment for an application.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Applies one or more tags to a resource.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes one or more tags from a resource.

updateApp(params: UpdateAppRequest, opts?: client.RequestOptions): Promise<UpdateAppResponse>

[src]

Updates an application.

updateAppVersion(params: UpdateAppVersionRequest, opts?: client.RequestOptions): Promise<UpdateAppVersionResponse>

[src]

Updates the AWS Resilience Hub application version.

Note: This API updates the AWS Resilience Hub application draft version. To use this information for running resiliency assessments, you must publish the AWS Resilience Hub application using the PublishAppVersion API.

updateAppVersionAppComponent(params: UpdateAppVersionAppComponentRequest, opts?: client.RequestOptions): Promise<UpdateAppVersionAppComponentResponse>

[src]

Updates an existing Application Component in the AWS Resilience Hub application.

updateAppVersionResource(params: UpdateAppVersionResourceRequest, opts?: client.RequestOptions): Promise<UpdateAppVersionResourceResponse>

[src]

Updates the resource details in the AWS Resilience Hub application.

updateResiliencyPolicy(params: UpdateResiliencyPolicyRequest, opts?: client.RequestOptions): Promise<UpdateResiliencyPolicyResponse>

[src]

Updates a resiliency policy.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]