Skip to content

ResilienceHubClient#

Index > ResilienceHub > ResilienceHubClient

Auto-generated documentation for ResilienceHub type annotations stubs module mypy-boto3-resiliencehub.

ResilienceHubClient#

Type annotations and code completion for boto3.client("resiliencehub"). boto3 documentation

# ResilienceHubClient usage example

from boto3.session import Session
from mypy_boto3_resiliencehub.client import ResilienceHubClient

def get_resiliencehub_client() -> ResilienceHubClient:
    return Session().client("resiliencehub")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("resiliencehub").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("resiliencehub")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_resiliencehub.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

add_draft_app_version_resource_mappings#

Adds the resource mapping for the draft application version.

Type annotations and code completion for boto3.client("resiliencehub").add_draft_app_version_resource_mappings method. boto3 documentation

# add_draft_app_version_resource_mappings method definition

def add_draft_app_version_resource_mappings(
    self,
    *,
    appArn: str,
    resourceMappings: Sequence[ResourceMappingTypeDef],  # (1)
) -> AddDraftAppVersionResourceMappingsResponseTypeDef:  # (2)
    ...
  1. See ResourceMappingTypeDef
  2. See AddDraftAppVersionResourceMappingsResponseTypeDef 
# add_draft_app_version_resource_mappings method usage example with argument unpacking

kwargs: AddDraftAppVersionResourceMappingsRequestRequestTypeDef = {  # (1)
    "appArn": ...,
    "resourceMappings": ...,
}

parent.add_draft_app_version_resource_mappings(**kwargs)
  1. See AddDraftAppVersionResourceMappingsRequestRequestTypeDef

batch_update_recommendation_status#

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

Type annotations and code completion for boto3.client("resiliencehub").batch_update_recommendation_status method. boto3 documentation

# batch_update_recommendation_status method definition

def batch_update_recommendation_status(
    self,
    *,
    appArn: str,
    requestEntries: Sequence[UpdateRecommendationStatusRequestEntryTypeDef],  # (1)
) -> BatchUpdateRecommendationStatusResponseTypeDef:  # (2)
    ...
  1. See UpdateRecommendationStatusRequestEntryTypeDef
  2. See BatchUpdateRecommendationStatusResponseTypeDef 
# batch_update_recommendation_status method usage example with argument unpacking

kwargs: BatchUpdateRecommendationStatusRequestRequestTypeDef = {  # (1)
    "appArn": ...,
    "requestEntries": ...,
}

parent.batch_update_recommendation_status(**kwargs)
  1. See BatchUpdateRecommendationStatusRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("resiliencehub").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("resiliencehub").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_app#

Creates an Resilience Hub application.

Type annotations and code completion for boto3.client("resiliencehub").create_app method. boto3 documentation

# create_app method definition

def create_app(
    self,
    *,
    name: str,
    assessmentSchedule: AppAssessmentScheduleTypeType = ...,  # (1)
    clientToken: str = ...,
    description: str = ...,
    eventSubscriptions: Sequence[EventSubscriptionTypeDef] = ...,  # (2)
    permissionModel: PermissionModelTypeDef = ...,  # (3)
    policyArn: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateAppResponseTypeDef:  # (4)
    ...
  1. See AppAssessmentScheduleTypeType
  2. See EventSubscriptionTypeDef
  3. See PermissionModelTypeDef
  4. See CreateAppResponseTypeDef 
# create_app method usage example with argument unpacking

kwargs: CreateAppRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_app(**kwargs)
  1. See CreateAppRequestRequestTypeDef

create_app_version_app_component#

Creates a new Application Component in the Resilience Hub application.

Type annotations and code completion for boto3.client("resiliencehub").create_app_version_app_component method. boto3 documentation

# create_app_version_app_component method definition

def create_app_version_app_component(
    self,
    *,
    appArn: str,
    name: str,
    type: str,
    additionalInfo: Mapping[str, Sequence[str]] = ...,
    clientToken: str = ...,
    id: str = ...,
) -> CreateAppVersionAppComponentResponseTypeDef:  # (1)
    ...
  1. See CreateAppVersionAppComponentResponseTypeDef 
# create_app_version_app_component method usage example with argument unpacking

kwargs: CreateAppVersionAppComponentRequestRequestTypeDef = {  # (1)
    "appArn": ...,
    "name": ...,
    "type": ...,
}

parent.create_app_version_app_component(**kwargs)
  1. See CreateAppVersionAppComponentRequestRequestTypeDef

create_app_version_resource#

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

Type annotations and code completion for boto3.client("resiliencehub").create_app_version_resource method. boto3 documentation

# create_app_version_resource method definition

def create_app_version_resource(
    self,
    *,
    appArn: str,
    appComponents: Sequence[str],
    logicalResourceId: LogicalResourceIdTypeDef,  # (1)
    physicalResourceId: str,
    resourceType: str,
    additionalInfo: Mapping[str, Sequence[str]] = ...,
    awsAccountId: str = ...,
    awsRegion: str = ...,
    clientToken: str = ...,
    resourceName: str = ...,
) -> CreateAppVersionResourceResponseTypeDef:  # (2)
    ...
  1. See LogicalResourceIdTypeDef
  2. See CreateAppVersionResourceResponseTypeDef 
# create_app_version_resource method usage example with argument unpacking

kwargs: CreateAppVersionResourceRequestRequestTypeDef = {  # (1)
    "appArn": ...,
    "appComponents": ...,
    "logicalResourceId": ...,
    "physicalResourceId": ...,
    "resourceType": ...,
}

parent.create_app_version_resource(**kwargs)
  1. See CreateAppVersionResourceRequestRequestTypeDef

create_recommendation_template#

Creates a new recommendation template for the Resilience Hub application.

Type annotations and code completion for boto3.client("resiliencehub").create_recommendation_template method. boto3 documentation

# create_recommendation_template method definition

def create_recommendation_template(
    self,
    *,
    assessmentArn: str,
    name: str,
    bucketName: str = ...,
    clientToken: str = ...,
    format: TemplateFormatType = ...,  # (1)
    recommendationIds: Sequence[str] = ...,
    recommendationTypes: Sequence[RenderRecommendationTypeType] = ...,  # (2)
    tags: Mapping[str, str] = ...,
) -> CreateRecommendationTemplateResponseTypeDef:  # (3)
    ...
  1. See TemplateFormatType
  2. See RenderRecommendationTypeType
  3. See CreateRecommendationTemplateResponseTypeDef 
# create_recommendation_template method usage example with argument unpacking

kwargs: CreateRecommendationTemplateRequestRequestTypeDef = {  # (1)
    "assessmentArn": ...,
    "name": ...,
}

parent.create_recommendation_template(**kwargs)
  1. See CreateRecommendationTemplateRequestRequestTypeDef

create_resiliency_policy#

Creates a resiliency policy for an application.

Type annotations and code completion for boto3.client("resiliencehub").create_resiliency_policy method. boto3 documentation

# create_resiliency_policy method definition

def create_resiliency_policy(
    self,
    *,
    policy: Mapping[DisruptionTypeType, FailurePolicyTypeDef],  # (1)
    policyName: str,
    tier: ResiliencyPolicyTierType,  # (2)
    clientToken: str = ...,
    dataLocationConstraint: DataLocationConstraintType = ...,  # (3)
    policyDescription: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateResiliencyPolicyResponseTypeDef:  # (4)
    ...
  1. See DisruptionTypeType FailurePolicyTypeDef
  2. See ResiliencyPolicyTierType
  3. See DataLocationConstraintType
  4. See CreateResiliencyPolicyResponseTypeDef 
# create_resiliency_policy method usage example with argument unpacking

kwargs: CreateResiliencyPolicyRequestRequestTypeDef = {  # (1)
    "policy": ...,
    "policyName": ...,
    "tier": ...,
}

parent.create_resiliency_policy(**kwargs)
  1. See CreateResiliencyPolicyRequestRequestTypeDef

delete_app#

Deletes an Resilience Hub application.

Type annotations and code completion for boto3.client("resiliencehub").delete_app method. boto3 documentation

# delete_app method definition

def delete_app(
    self,
    *,
    appArn: str,
    clientToken: str = ...,
    forceDelete: bool = ...,
) -> DeleteAppResponseTypeDef:  # (1)
    ...
  1. See DeleteAppResponseTypeDef 
# delete_app method usage example with argument unpacking

kwargs: DeleteAppRequestRequestTypeDef = {  # (1)
    "appArn": ...,
}

parent.delete_app(**kwargs)
  1. See DeleteAppRequestRequestTypeDef

delete_app_assessment#

Deletes an Resilience Hub application assessment.

Type annotations and code completion for boto3.client("resiliencehub").delete_app_assessment method. boto3 documentation

# delete_app_assessment method definition

def delete_app_assessment(
    self,
    *,
    assessmentArn: str,
    clientToken: str = ...,
) -> DeleteAppAssessmentResponseTypeDef:  # (1)
    ...
  1. See DeleteAppAssessmentResponseTypeDef 
# delete_app_assessment method usage example with argument unpacking

kwargs: DeleteAppAssessmentRequestRequestTypeDef = {  # (1)
    "assessmentArn": ...,
}

parent.delete_app_assessment(**kwargs)
  1. See DeleteAppAssessmentRequestRequestTypeDef

delete_app_input_source#

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

Type annotations and code completion for boto3.client("resiliencehub").delete_app_input_source method. boto3 documentation

# delete_app_input_source method definition

def delete_app_input_source(
    self,
    *,
    appArn: str,
    clientToken: str = ...,
    eksSourceClusterNamespace: EksSourceClusterNamespaceTypeDef = ...,  # (1)
    sourceArn: str = ...,
    terraformSource: TerraformSourceTypeDef = ...,  # (2)
) -> DeleteAppInputSourceResponseTypeDef:  # (3)
    ...
  1. See EksSourceClusterNamespaceTypeDef
  2. See TerraformSourceTypeDef
  3. See DeleteAppInputSourceResponseTypeDef 
# delete_app_input_source method usage example with argument unpacking

kwargs: DeleteAppInputSourceRequestRequestTypeDef = {  # (1)
    "appArn": ...,
}

parent.delete_app_input_source(**kwargs)
  1. See DeleteAppInputSourceRequestRequestTypeDef

delete_app_version_app_component#

Deletes an Application Component from the Resilience Hub application.

Type annotations and code completion for boto3.client("resiliencehub").delete_app_version_app_component method. boto3 documentation

# delete_app_version_app_component method definition

def delete_app_version_app_component(
    self,
    *,
    appArn: str,
    id: str,
    clientToken: str = ...,
) -> DeleteAppVersionAppComponentResponseTypeDef:  # (1)
    ...
  1. See DeleteAppVersionAppComponentResponseTypeDef 
# delete_app_version_app_component method usage example with argument unpacking

kwargs: DeleteAppVersionAppComponentRequestRequestTypeDef = {  # (1)
    "appArn": ...,
    "id": ...,
}

parent.delete_app_version_app_component(**kwargs)
  1. See DeleteAppVersionAppComponentRequestRequestTypeDef

delete_app_version_resource#

Deletes a resource from the Resilience Hub application.

Type annotations and code completion for boto3.client("resiliencehub").delete_app_version_resource method. boto3 documentation

# delete_app_version_resource method definition

def delete_app_version_resource(
    self,
    *,
    appArn: str,
    awsAccountId: str = ...,
    awsRegion: str = ...,
    clientToken: str = ...,
    logicalResourceId: LogicalResourceIdTypeDef = ...,  # (1)
    physicalResourceId: str = ...,
    resourceName: str = ...,
) -> DeleteAppVersionResourceResponseTypeDef:  # (2)
    ...
  1. See LogicalResourceIdTypeDef
  2. See DeleteAppVersionResourceResponseTypeDef 
# delete_app_version_resource method usage example with argument unpacking

kwargs: DeleteAppVersionResourceRequestRequestTypeDef = {  # (1)
    "appArn": ...,
}

parent.delete_app_version_resource(**kwargs)
  1. See DeleteAppVersionResourceRequestRequestTypeDef

delete_recommendation_template#

Deletes a recommendation template.

Type annotations and code completion for boto3.client("resiliencehub").delete_recommendation_template method. boto3 documentation

# delete_recommendation_template method definition

def delete_recommendation_template(
    self,
    *,
    recommendationTemplateArn: str,
    clientToken: str = ...,
) -> DeleteRecommendationTemplateResponseTypeDef:  # (1)
    ...
  1. See DeleteRecommendationTemplateResponseTypeDef 
# delete_recommendation_template method usage example with argument unpacking

kwargs: DeleteRecommendationTemplateRequestRequestTypeDef = {  # (1)
    "recommendationTemplateArn": ...,
}

parent.delete_recommendation_template(**kwargs)
  1. See DeleteRecommendationTemplateRequestRequestTypeDef

delete_resiliency_policy#

Deletes a resiliency policy.

Type annotations and code completion for boto3.client("resiliencehub").delete_resiliency_policy method. boto3 documentation

# delete_resiliency_policy method definition

def delete_resiliency_policy(
    self,
    *,
    policyArn: str,
    clientToken: str = ...,
) -> DeleteResiliencyPolicyResponseTypeDef:  # (1)
    ...
  1. See DeleteResiliencyPolicyResponseTypeDef 
# delete_resiliency_policy method usage example with argument unpacking

kwargs: DeleteResiliencyPolicyRequestRequestTypeDef = {  # (1)
    "policyArn": ...,
}

parent.delete_resiliency_policy(**kwargs)
  1. See DeleteResiliencyPolicyRequestRequestTypeDef

describe_app#

Describes an Resilience Hub application.

Type annotations and code completion for boto3.client("resiliencehub").describe_app method. boto3 documentation

# describe_app method definition

def describe_app(
    self,
    *,
    appArn: str,
) -> DescribeAppResponseTypeDef:  # (1)
    ...
  1. See DescribeAppResponseTypeDef 
# describe_app method usage example with argument unpacking

kwargs: DescribeAppRequestRequestTypeDef = {  # (1)
    "appArn": ...,
}

parent.describe_app(**kwargs)
  1. See DescribeAppRequestRequestTypeDef

describe_app_assessment#

Describes an assessment for an Resilience Hub application.

Type annotations and code completion for boto3.client("resiliencehub").describe_app_assessment method. boto3 documentation

# describe_app_assessment method definition

def describe_app_assessment(
    self,
    *,
    assessmentArn: str,
) -> DescribeAppAssessmentResponseTypeDef:  # (1)
    ...
  1. See DescribeAppAssessmentResponseTypeDef 
# describe_app_assessment method usage example with argument unpacking

kwargs: DescribeAppAssessmentRequestRequestTypeDef = {  # (1)
    "assessmentArn": ...,
}

parent.describe_app_assessment(**kwargs)
  1. See DescribeAppAssessmentRequestRequestTypeDef

describe_app_version#

Describes the Resilience Hub application version.

Type annotations and code completion for boto3.client("resiliencehub").describe_app_version method. boto3 documentation

# describe_app_version method definition

def describe_app_version(
    self,
    *,
    appArn: str,
    appVersion: str,
) -> DescribeAppVersionResponseTypeDef:  # (1)
    ...
  1. See DescribeAppVersionResponseTypeDef 
# describe_app_version method usage example with argument unpacking

kwargs: DescribeAppVersionRequestRequestTypeDef = {  # (1)
    "appArn": ...,
    "appVersion": ...,
}

parent.describe_app_version(**kwargs)
  1. See DescribeAppVersionRequestRequestTypeDef

describe_app_version_app_component#

Describes an Application Component in the Resilience Hub application.

Type annotations and code completion for boto3.client("resiliencehub").describe_app_version_app_component method. boto3 documentation

# describe_app_version_app_component method definition

def describe_app_version_app_component(
    self,
    *,
    appArn: str,
    appVersion: str,
    id: str,
) -> DescribeAppVersionAppComponentResponseTypeDef:  # (1)
    ...
  1. See DescribeAppVersionAppComponentResponseTypeDef 
# describe_app_version_app_component method usage example with argument unpacking

kwargs: DescribeAppVersionAppComponentRequestRequestTypeDef = {  # (1)
    "appArn": ...,
    "appVersion": ...,
    "id": ...,
}

parent.describe_app_version_app_component(**kwargs)
  1. See DescribeAppVersionAppComponentRequestRequestTypeDef

describe_app_version_resource#

Describes a resource of the Resilience Hub application.

Type annotations and code completion for boto3.client("resiliencehub").describe_app_version_resource method. boto3 documentation

# describe_app_version_resource method definition

def describe_app_version_resource(
    self,
    *,
    appArn: str,
    appVersion: str,
    awsAccountId: str = ...,
    awsRegion: str = ...,
    logicalResourceId: LogicalResourceIdTypeDef = ...,  # (1)
    physicalResourceId: str = ...,
    resourceName: str = ...,
) -> DescribeAppVersionResourceResponseTypeDef:  # (2)
    ...
  1. See LogicalResourceIdTypeDef
  2. See DescribeAppVersionResourceResponseTypeDef 
# describe_app_version_resource method usage example with argument unpacking

kwargs: DescribeAppVersionResourceRequestRequestTypeDef = {  # (1)
    "appArn": ...,
    "appVersion": ...,
}

parent.describe_app_version_resource(**kwargs)
  1. See DescribeAppVersionResourceRequestRequestTypeDef

describe_app_version_resources_resolution_status#

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

Type annotations and code completion for boto3.client("resiliencehub").describe_app_version_resources_resolution_status method. boto3 documentation

# describe_app_version_resources_resolution_status method definition

def describe_app_version_resources_resolution_status(
    self,
    *,
    appArn: str,
    appVersion: str,
    resolutionId: str = ...,
) -> DescribeAppVersionResourcesResolutionStatusResponseTypeDef:  # (1)
    ...
  1. See DescribeAppVersionResourcesResolutionStatusResponseTypeDef 
# describe_app_version_resources_resolution_status method usage example with argument unpacking

kwargs: DescribeAppVersionResourcesResolutionStatusRequestRequestTypeDef = {  # (1)
    "appArn": ...,
    "appVersion": ...,
}

parent.describe_app_version_resources_resolution_status(**kwargs)
  1. See DescribeAppVersionResourcesResolutionStatusRequestRequestTypeDef

describe_app_version_template#

Describes details about an Resilience Hub application.

Type annotations and code completion for boto3.client("resiliencehub").describe_app_version_template method. boto3 documentation

# describe_app_version_template method definition

def describe_app_version_template(
    self,
    *,
    appArn: str,
    appVersion: str,
) -> DescribeAppVersionTemplateResponseTypeDef:  # (1)
    ...
  1. See DescribeAppVersionTemplateResponseTypeDef 
# describe_app_version_template method usage example with argument unpacking

kwargs: DescribeAppVersionTemplateRequestRequestTypeDef = {  # (1)
    "appArn": ...,
    "appVersion": ...,
}

parent.describe_app_version_template(**kwargs)
  1. See DescribeAppVersionTemplateRequestRequestTypeDef

describe_draft_app_version_resources_import_status#

Describes the status of importing resources to an application version.

Type annotations and code completion for boto3.client("resiliencehub").describe_draft_app_version_resources_import_status method. boto3 documentation

# describe_draft_app_version_resources_import_status method definition

def describe_draft_app_version_resources_import_status(
    self,
    *,
    appArn: str,
) -> DescribeDraftAppVersionResourcesImportStatusResponseTypeDef:  # (1)
    ...
  1. See DescribeDraftAppVersionResourcesImportStatusResponseTypeDef 
# describe_draft_app_version_resources_import_status method usage example with argument unpacking

kwargs: DescribeDraftAppVersionResourcesImportStatusRequestRequestTypeDef = {  # (1)
    "appArn": ...,
}

parent.describe_draft_app_version_resources_import_status(**kwargs)
  1. See DescribeDraftAppVersionResourcesImportStatusRequestRequestTypeDef

describe_resiliency_policy#

Describes a specified resiliency policy for an Resilience Hub application.

Type annotations and code completion for boto3.client("resiliencehub").describe_resiliency_policy method. boto3 documentation

# describe_resiliency_policy method definition

def describe_resiliency_policy(
    self,
    *,
    policyArn: str,
) -> DescribeResiliencyPolicyResponseTypeDef:  # (1)
    ...
  1. See DescribeResiliencyPolicyResponseTypeDef 
# describe_resiliency_policy method usage example with argument unpacking

kwargs: DescribeResiliencyPolicyRequestRequestTypeDef = {  # (1)
    "policyArn": ...,
}

parent.describe_resiliency_policy(**kwargs)
  1. See DescribeResiliencyPolicyRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("resiliencehub").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

import_resources_to_draft_app_version#

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

Type annotations and code completion for boto3.client("resiliencehub").import_resources_to_draft_app_version method. boto3 documentation

# import_resources_to_draft_app_version method definition

def import_resources_to_draft_app_version(
    self,
    *,
    appArn: str,
    eksSources: Sequence[EksSourceTypeDef] = ...,  # (1)
    importStrategy: ResourceImportStrategyTypeType = ...,  # (2)
    sourceArns: Sequence[str] = ...,
    terraformSources: Sequence[TerraformSourceTypeDef] = ...,  # (3)
) -> ImportResourcesToDraftAppVersionResponseTypeDef:  # (4)
    ...
  1. See EksSourceTypeDef
  2. See ResourceImportStrategyTypeType
  3. See