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 source of resource-maps to the draft version of an application.

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