ResilienceHub

Table of Contents

Client

class ResilienceHub.Client

A low-level client representing AWS Resilience Hub

AWS Resilience Hub helps you proactively prepare and protect your Amazon Web Services applications from disruptions. Resilience Hub offers continuous 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.

import boto3

client = boto3.client('resiliencehub')

These are the available methods:

add_draft_app_version_resource_mappings(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.add_draft_app_version_resource_mappings(
    appArn='string',
    resourceMappings=[
        {
            'appRegistryAppName': 'string',
            'logicalStackName': 'string',
            'mappingType': 'CfnStack'|'Resource'|'AppRegistryApp'|'ResourceGroup'|'Terraform',
            'physicalResourceId': {
                'awsAccountId': 'string',
                'awsRegion': 'string',
                'identifier': 'string',
                'type': 'Arn'|'Native'
            },
            'resourceGroupName': 'string',
            'resourceName': 'string',
            'terraformSourceName': 'string'
        },
    ]
)
Parameters
  • appArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • resourceMappings (list) --

    [REQUIRED]

    Mappings used to map logical resources from the template to physical resources. You can use the mapping type CFN_STACK if the application template uses a logical stack name. Or you can map individual resources by using the mapping type RESOURCE . We recommend using the mapping type CFN_STACK if the application is backed by a CloudFormation stack.

    • (dict) --

      Defines a resource mapping.

      • appRegistryAppName (string) --

        The name of the application this resource is mapped to.

      • logicalStackName (string) --

        The name of the CloudFormation stack this resource is mapped to.

      • mappingType (string) -- [REQUIRED]

        Specifies the type of resource mapping.

        AppRegistryApp

        The resource is mapped to another application. The name of the application is contained in the appRegistryAppName property.

        CfnStack

        The resource is mapped to a CloudFormation stack. The name of the CloudFormation stack is contained in the logicalStackName property.

        Resource

        The resource is mapped to another resource. The name of the resource is contained in the resourceName property.

        ResourceGroup

        The resource is mapped to a resource group. The name of the resource group is contained in the resourceGroupName property.

      • physicalResourceId (dict) -- [REQUIRED]

        The identifier of this resource.

        • awsAccountId (string) --

          The Amazon Web Services account that owns the physical resource.

        • awsRegion (string) --

          The Amazon Web Services Region that the physical resource is located in.

        • identifier (string) -- [REQUIRED]

          The identifier of the physical resource.

        • type (string) -- [REQUIRED]

          Specifies the type of physical resource identifier.

          Arn

          The resource identifier is an Amazon Resource Name (ARN) .

          Native

          The resource identifier is an AWS Resilience Hub-native identifier.

      • resourceGroupName (string) --

        The name of the resource group this resource is mapped to.

      • resourceName (string) --

        The name of the resource this resource is mapped to.

      • terraformSourceName (string) --

        The short name of the Terraform source.

Return type

dict

Returns

Response Syntax

{
    'appArn': 'string',
    'appVersion': 'string',
    'resourceMappings': [
        {
            'appRegistryAppName': 'string',
            'logicalStackName': 'string',
            'mappingType': 'CfnStack'|'Resource'|'AppRegistryApp'|'ResourceGroup'|'Terraform',
            'physicalResourceId': {
                'awsAccountId': 'string',
                'awsRegion': 'string',
                'identifier': 'string',
                'type': 'Arn'|'Native'
            },
            'resourceGroupName': 'string',
            'resourceName': 'string',
            'terraformSourceName': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • appArn (string) --

      The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

    • appVersion (string) --

      The version of the application.

    • resourceMappings (list) --

      Mappings used to map logical resources from the template to physical resources. You can use the mapping type CFN_STACK if the application template uses a logical stack name. Or you can map individual resources by using the mapping type RESOURCE . We recommend using the mapping type CFN_STACK if the application is backed by a CloudFormation stack.

      • (dict) --

        Defines a resource mapping.

        • appRegistryAppName (string) --

          The name of the application this resource is mapped to.

        • logicalStackName (string) --

          The name of the CloudFormation stack this resource is mapped to.

        • mappingType (string) --

          Specifies the type of resource mapping.

          AppRegistryApp

          The resource is mapped to another application. The name of the application is contained in the appRegistryAppName property.

          CfnStack

          The resource is mapped to a CloudFormation stack. The name of the CloudFormation stack is contained in the logicalStackName property.

          Resource

          The resource is mapped to another resource. The name of the resource is contained in the resourceName property.

          ResourceGroup

          The resource is mapped to a resource group. The name of the resource group is contained in the resourceGroupName property.

        • physicalResourceId (dict) --

          The identifier of this resource.

          • awsAccountId (string) --

            The Amazon Web Services account that owns the physical resource.

          • awsRegion (string) --

            The Amazon Web Services Region that the physical resource is located in.

          • identifier (string) --

            The identifier of the physical resource.

          • type (string) --

            Specifies the type of physical resource identifier.

            Arn

            The resource identifier is an Amazon Resource Name (ARN) .

            Native

            The resource identifier is an AWS Resilience Hub-native identifier.

        • resourceGroupName (string) --

          The name of the resource group this resource is mapped to.

        • resourceName (string) --

          The name of the resource this resource is mapped to.

        • terraformSourceName (string) --

          The short name of the Terraform source.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
close()

Closes underlying endpoint connections.

create_app(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.create_app(
    assessmentSchedule='Disabled'|'Daily',
    clientToken='string',
    description='string',
    name='string',
    policyArn='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • assessmentSchedule (string) -- Assessment execution schedule with 'Daily' or 'Disabled' values.
  • clientToken (string) --

    Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

    This field is autopopulated if not provided.

  • description (string) -- The optional description for an app.
  • name (string) --

    [REQUIRED]

    The name for the application.

  • policyArn (string) -- The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: partition :resiliencehub: region : account :resiliency-policy/ policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
  • tags (dict) --

    The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'app': {
        'appArn': 'string',
        'assessmentSchedule': 'Disabled'|'Daily',
        'complianceStatus': 'PolicyBreached'|'PolicyMet'|'NotAssessed'|'ChangesDetected',
        'creationTime': datetime(2015, 1, 1),
        'description': 'string',
        'lastAppComplianceEvaluationTime': datetime(2015, 1, 1),
        'lastResiliencyScoreEvaluationTime': datetime(2015, 1, 1),
        'name': 'string',
        'policyArn': 'string',
        'resiliencyScore': 123.0,
        'status': 'Active'|'Deleting',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • app (dict) --

      The created application returned as an object with details including compliance status, creation time, description, resiliency score, and more.

      • appArn (string) --

        The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

      • assessmentSchedule (string) --

        Assessment execution schedule with 'Daily' or 'Disabled' values.

      • complianceStatus (string) --

        The current status of compliance for the resiliency policy.

      • creationTime (datetime) --

        The timestamp for when the app was created.

      • description (string) --

        The optional description for an app.

      • lastAppComplianceEvaluationTime (datetime) --

        The timestamp for the most recent compliance evaluation.

      • lastResiliencyScoreEvaluationTime (datetime) --

        The timestamp for the most recent resiliency score evaluation.

      • name (string) --

        The name for the application.

      • policyArn (string) --

        The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: partition :resiliencehub: region : account :resiliency-policy/ policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

      • resiliencyScore (float) --

        The current resiliency score for the application.

      • status (string) --

        The status of the application.

      • tags (dict) --

        The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

        • (string) --
          • (string) --

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ServiceQuotaExceededException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
create_app_version_app_component(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_app_version_app_component(
    additionalInfo={
        'string': [
            'string',
        ]
    },
    appArn='string',
    clientToken='string',
    id='string',
    name='string',
    type='string'
)
Parameters
  • additionalInfo (dict) --

    Currently, there is no supported additional information for Application Components.

    • (string) --
      • (list) --
        • (string) --
  • appArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • clientToken (string) --

    Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

    This field is autopopulated if not provided.

  • id (string) -- The identifier of the Application Component.
  • name (string) --

    [REQUIRED]

    The name of the Application Component.

  • type (string) --

    [REQUIRED]

    The type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.

Return type

dict

Returns

Response Syntax

{
    'appArn': 'string',
    'appComponent': {
        'additionalInfo': {
            'string': [
                'string',
            ]
        },
        'id': 'string',
        'name': 'string',
        'type': 'string'
    },
    'appVersion': 'string'
}

Response Structure

  • (dict) --

    • appArn (string) --

      The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

    • appComponent (dict) --

      Defines an Application Component.

      • additionalInfo (dict) --

        Additional configuration parameters for an AWS Resilience Hub application.

        Note

        Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

        Key: "failover-regions"

        Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

        • (string) --
          • (list) --
            • (string) --
      • id (string) --

        Unique identifier of the Application Component.

      • name (string) --

        The name of the Application Component.

      • type (string) --

        The type of Application Component.

    • appVersion (string) --

      The AWS Resilience Hub application version.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ServiceQuotaExceededException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
create_app_version_resource(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_app_version_resource(
    additionalInfo={
        'string': [
            'string',
        ]
    },
    appArn='string',
    appComponents=[
        'string',
    ],
    awsAccountId='string',
    awsRegion='string',
    clientToken='string',
    logicalResourceId={
        'identifier': 'string',
        'logicalStackName': 'string',
        'resourceGroupName': 'string',
        'terraformSourceName': 'string'
    },
    physicalResourceId='string',
    resourceName='string',
    resourceType='string'
)
Parameters
  • additionalInfo (dict) --

    Currently, there is no supported additional information for resources.

    • (string) --
      • (list) --
        • (string) --
  • appArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • appComponents (list) --

    [REQUIRED]

    The list of Application Components that this resource belongs to. If an Application Component is not part of the AWS Resilience Hub application, it will be added.

    • (string) --
  • awsAccountId (string) -- The Amazon Web Services account that owns the physical resource.
  • awsRegion (string) -- The Amazon Web Services region that owns the physical resource.
  • clientToken (string) --

    Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

    This field is autopopulated if not provided.

  • logicalResourceId (dict) --

    [REQUIRED]

    The logical identifier of the resource.

    • identifier (string) -- [REQUIRED]

      The identifier of the resource.

    • logicalStackName (string) --

      The name of the CloudFormation stack this resource belongs to.

    • resourceGroupName (string) --

      The name of the resource group that this resource belongs to.

    • terraformSourceName (string) --

      The name of the Terraform S3 state file this resource belongs to.

  • physicalResourceId (string) --

    [REQUIRED]

    The physical identifier of the resource.

  • resourceName (string) --

    [REQUIRED]

    The name of the resource.

  • resourceType (string) --

    [REQUIRED]

    The type of resource.

Return type

dict

Returns

Response Syntax

{
    'appArn': 'string',
    'appVersion': 'string',
    'physicalResource': {
        'additionalInfo': {
            'string': [
                'string',
            ]
        },
        'appComponents': [
            {
                'additionalInfo': {
                    'string': [
                        'string',
                    ]
                },
                'id': 'string',
                'name': 'string',
                'type': 'string'
            },
        ],
        'excluded': True|False,
        'logicalResourceId': {
            'identifier': 'string',
            'logicalStackName': 'string',
            'resourceGroupName': 'string',
            'terraformSourceName': 'string'
        },
        'physicalResourceId': {
            'awsAccountId': 'string',
            'awsRegion': 'string',
            'identifier': 'string',
            'type': 'Arn'|'Native'
        },
        'resourceName': 'string',
        'resourceType': 'string'
    }
}

Response Structure

  • (dict) --

    • appArn (string) --

      The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

    • appVersion (string) --

      The AWS Resilience Hub application version.

    • physicalResource (dict) --

      Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.

      • additionalInfo (dict) --

        Additional configuration parameters for an AWS Resilience Hub application.

        Note

        Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

        Key: "failover-regions"

        Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

        • (string) --
          • (list) --
            • (string) --
      • appComponents (list) --

        The application components that belong to this resource.

        • (dict) --

          Defines an Application Component.

          • additionalInfo (dict) --

            Additional configuration parameters for an AWS Resilience Hub application.

            Note

            Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

            Key: "failover-regions"

            Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

            • (string) --
              • (list) --
                • (string) --
          • id (string) --

            Unique identifier of the Application Component.

          • name (string) --

            The name of the Application Component.

          • type (string) --

            The type of Application Component.

      • excluded (boolean) --

        Indicates if a resource is included or excluded from the assessment.

      • logicalResourceId (dict) --

        The logical identifier of the resource.

        • identifier (string) --

          The identifier of the resource.

        • logicalStackName (string) --

          The name of the CloudFormation stack this resource belongs to.

        • resourceGroupName (string) --

          The name of the resource group that this resource belongs to.

        • terraformSourceName (string) --

          The name of the Terraform S3 state file this resource belongs to.

      • physicalResourceId (dict) --

        The physical identifier of the resource.

        • awsAccountId (string) --

          The Amazon Web Services account that owns the physical resource.

        • awsRegion (string) --

          The Amazon Web Services Region that the physical resource is located in.

        • identifier (string) --

          The identifier of the physical resource.

        • type (string) --

          Specifies the type of physical resource identifier.

          Arn

          The resource identifier is an Amazon Resource Name (ARN) .

          Native

          The resource identifier is an AWS Resilience Hub-native identifier.

      • resourceName (string) --

        The name of the resource.

      • resourceType (string) --

        The type of resource.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ServiceQuotaExceededException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
create_recommendation_template(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.create_recommendation_template(
    assessmentArn='string',
    bucketName='string',
    clientToken='string',
    format='CfnYaml'|'CfnJson',
    name='string',
    recommendationIds=[
        'string',
    ],
    recommendationTypes=[
        'Alarm'|'Sop'|'Test',
    ],
    tags={
        'string': 'string'
    }
)
Parameters
  • assessmentArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: partition :resiliencehub: region : account :app-assessment/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • bucketName (string) -- The name of the Amazon S3 bucket that will contain the recommendation template.
  • clientToken (string) --

    Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

    This field is autopopulated if not provided.

  • format (string) --

    The format for the recommendation template.

    CfnJson

    The template is CloudFormation JSON.

    CfnYaml

    The template is CloudFormation YAML.

  • name (string) --

    [REQUIRED]

    The name for the recommendation template.

  • recommendationIds (list) --

    Identifiers for the recommendations used to create a recommendation template.

    • (string) --
  • recommendationTypes (list) --

    An array of strings that specify the recommendation template type or types.

    Alarm

    The template is an AlarmRecommendation template.

    Sop

    The template is a SopRecommendation template.

    Test

    The template is a TestRecommendation template.

    • (string) --
  • tags (dict) --

    The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'recommendationTemplate': {
        'appArn': 'string',
        'assessmentArn': 'string',
        'endTime': datetime(2015, 1, 1),
        'format': 'CfnYaml'|'CfnJson',
        'message': 'string',
        'name': 'string',
        'needsReplacements': True|False,
        'recommendationIds': [
            'string',
        ],
        'recommendationTemplateArn': 'string',
        'recommendationTypes': [
            'Alarm'|'Sop'|'Test',
        ],
        'startTime': datetime(2015, 1, 1),
        'status': 'Pending'|'InProgress'|'Failed'|'Success',
        'tags': {
            'string': 'string'
        },
        'templatesLocation': {
            'bucket': 'string',
            'prefix': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • recommendationTemplate (dict) --

      The newly created recommendation template, returned as an object. This object includes the template's name, format, status, tags, Amazon S3 bucket location, and more.

      • appArn (string) --

        The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

      • assessmentArn (string) --

        The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: partition :resiliencehub: region : account :app-assessment/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

      • endTime (datetime) --

        The end time for the action.

      • format (string) --

        The format of the recommendation template.

        CfnJson

        The template is CloudFormation JSON.

        CfnYaml

        The template is CloudFormation YAML.

      • message (string) --

        The message for the recommendation template.

      • name (string) --

        The name for the recommendation template.

      • needsReplacements (boolean) --

        Indicates if replacements are needed.

      • recommendationIds (list) --

        Identifiers for the recommendations used in the recommendation template.

        • (string) --
      • recommendationTemplateArn (string) --

        The Amazon Resource Name (ARN) for the recommendation template.

      • recommendationTypes (list) --

        An array of strings that specify the recommendation template type or types.

        Alarm

        The template is an AlarmRecommendation template.

        Sop

        The template is a SopRecommendation template.

        Test

        The template is a TestRecommendation template.

        • (string) --
      • startTime (datetime) --

        The start time for the action.

      • status (string) --

        The status of the action.

      • tags (dict) --

        The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

        • (string) --
          • (string) --
      • templatesLocation (dict) --

        The file location of the template.

        • bucket (string) --

          The name of the Amazon S3 bucket.

        • prefix (string) --

          The prefix for the Amazon S3 bucket.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ServiceQuotaExceededException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
create_resiliency_policy(**kwargs)

Creates a resiliency policy for an application.

See also: AWS API Documentation

Request Syntax

response = client.create_resiliency_policy(
    clientToken='string',
    dataLocationConstraint='AnyLocation'|'SameContinent'|'SameCountry',
    policy={
        'string': {
            'rpoInSecs': 123,
            'rtoInSecs': 123
        }
    },
    policyDescription='string',
    policyName='string',
    tags={
        'string': 'string'
    },
    tier='MissionCritical'|'Critical'|'Important'|'CoreServices'|'NonCritical'
)
Parameters
  • clientToken (string) --

    Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

    This field is autopopulated if not provided.

  • dataLocationConstraint (string) -- Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
  • policy (dict) --

    [REQUIRED]

    The type of resiliency policy to be created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.

    • (string) --
      • (dict) --

        Defines a failure policy.

        • rpoInSecs (integer) -- [REQUIRED]

          The Recovery Point Objective (RPO), in seconds.

        • rtoInSecs (integer) -- [REQUIRED]

          The Recovery Time Objective (RTO), in seconds.

  • policyDescription (string) -- The description for the policy.
  • policyName (string) --

    [REQUIRED]

    The name of the policy

  • tags (dict) --

    The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

    • (string) --
      • (string) --
  • tier (string) --

    [REQUIRED]

    The tier for this resiliency policy, ranging from the highest severity ( MissionCritical ) to lowest ( NonCritical ).

Return type

dict

Returns

Response Syntax

{
    'policy': {
        'creationTime': datetime(2015, 1, 1),
        'dataLocationConstraint': 'AnyLocation'|'SameContinent'|'SameCountry',
        'estimatedCostTier': 'L1'|'L2'|'L3'|'L4',
        'policy': {
            'string': {
                'rpoInSecs': 123,
                'rtoInSecs': 123
            }
        },
        'policyArn': 'string',
        'policyDescription': 'string',
        'policyName': 'string',
        'tags': {
            'string': 'string'
        },
        'tier': 'MissionCritical'|'Critical'|'Important'|'CoreServices'|'NonCritical'
    }
}

Response Structure

  • (dict) --

    • policy (dict) --

      The type of resiliency policy that was created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.

      • creationTime (datetime) --

        The timestamp for when the resiliency policy was created.

      • dataLocationConstraint (string) --

        Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

      • estimatedCostTier (string) --

        Specifies the estimated cost tier of the resiliency policy.

      • policy (dict) --

        The resiliency policy.

        • (string) --

          • (dict) --

            Defines a failure policy.

            • rpoInSecs (integer) --

              The Recovery Point Objective (RPO), in seconds.

            • rtoInSecs (integer) --

              The Recovery Time Objective (RTO), in seconds.

      • policyArn (string) --

        The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: partition :resiliencehub: region : account :resiliency-policy/ policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

      • policyDescription (string) --

        The description for the policy.

      • policyName (string) --

        The name of the policy

      • tags (dict) --

        The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

        • (string) --
          • (string) --
      • tier (string) --

        The tier for this resiliency policy, ranging from the highest severity ( MissionCritical ) to lowest ( NonCritical ).

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ServiceQuotaExceededException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
delete_app(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.delete_app(
    appArn='string',
    clientToken='string',
    forceDelete=True|False
)
Parameters
  • appArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • clientToken (string) --

    Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

    This field is autopopulated if not provided.

  • forceDelete (boolean) -- A boolean option to force the deletion of an AWS Resilience Hub application.
Return type

dict

Returns

Response Syntax

{
    'appArn': 'string'
}

Response Structure

  • (dict) --

    • appArn (string) --

      The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
delete_app_assessment(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.delete_app_assessment(
    assessmentArn='string',
    clientToken='string'
)
Parameters
  • assessmentArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: partition :resiliencehub: region : account :app-assessment/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • clientToken (string) --

    Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'assessmentArn': 'string',
    'assessmentStatus': 'Pending'|'InProgress'|'Failed'|'Success'
}

Response Structure

  • (dict) --

    • assessmentArn (string) --

      The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: partition :resiliencehub: region : account :app-assessment/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

    • assessmentStatus (string) --

      The current status of the assessment for the resiliency policy.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
delete_app_input_source(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.delete_app_input_source(
    appArn='string',
    clientToken='string',
    sourceArn='string',
    terraformSource={
        's3StateFileUrl': 'string'
    }
)
Parameters
  • appArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • clientToken (string) --

    Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

    This field is autopopulated if not provided.

  • sourceArn (string) -- The Amazon Resource Name (ARN) of the imported resource you want to remove from the AWS Resilience Hub application. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
  • terraformSource (dict) --

    The imported Terraform s3 state file you want to remove from the AWS Resilience Hub application.

    • s3StateFileUrl (string) -- [REQUIRED]

      The Terraform s3 state file you need to import.

Return type

dict

Returns

Response Syntax

{
    'appArn': 'string',
    'appInputSource': {
        'importType': 'CfnStack'|'Resource'|'AppRegistryApp'|'ResourceGroup'|'Terraform',
        'resourceCount': 123,
        'sourceArn': 'string',
        'sourceName': 'string',
        'terraformSource': {
            's3StateFileUrl': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • appArn (string) --

      The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

    • appInputSource (dict) --

      The name of the input source from where the application resource is imported from.

      • importType (string) --

        The resource type of the input source.

      • resourceCount (integer) --

        The number of resources that were imported.

      • sourceArn (string) --

        The Amazon Resource Name (ARN) of the input source. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

      • sourceName (string) --

        The name of the input source.

      • terraformSource (dict) --

        The name of the Terraform s3 state file.

        • s3StateFileUrl (string) --

          The Terraform s3 state file you need to import.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
delete_app_version_app_component(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_app_version_app_component(
    appArn='string',
    clientToken='string',
    id='string'
)
Parameters
  • appArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • clientToken (string) --

    Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

    This field is autopopulated if not provided.

  • id (string) --

    [REQUIRED]

    The identifier of the Application Component.

Return type

dict

Returns

Response Syntax

{
    'appArn': 'string',
    'appComponent': {
        'additionalInfo': {
            'string': [
                'string',
            ]
        },
        'id': 'string',
        'name': 'string',
        'type': 'string'
    },
    'appVersion': 'string'
}

Response Structure

  • (dict) --

    • appArn (string) --

      The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

    • appComponent (dict) --

      Defines an Application Component.

      • additionalInfo (dict) --

        Additional configuration parameters for an AWS Resilience Hub application.

        Note

        Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

        Key: "failover-regions"

        Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

        • (string) --
          • (list) --
            • (string) --
      • id (string) --

        Unique identifier of the Application Component.

      • name (string) --

        The name of the Application Component.

      • type (string) --

        The type of Application Component.

    • appVersion (string) --

      The AWS Resilience Hub application version.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
delete_app_version_resource(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_app_version_resource(
    appArn='string',
    awsAccountId='string',
    awsRegion='string',
    clientToken='string',
    logicalResourceId={
        'identifier': 'string',
        'logicalStackName': 'string',
        'resourceGroupName': 'string',
        'terraformSourceName': 'string'
    },
    physicalResourceId='string',
    resourceName='string'
)
Parameters
  • appArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • awsAccountId (string) -- The Amazon Web Services account that owns the physical resource.
  • awsRegion (string) -- The Amazon Web Services region that owns the physical resource.
  • clientToken (string) --

    Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

    This field is autopopulated if not provided.

  • logicalResourceId (dict) --

    The logical identifier of the resource.

    • identifier (string) -- [REQUIRED]

      The identifier of the resource.

    • logicalStackName (string) --

      The name of the CloudFormation stack this resource belongs to.

    • resourceGroupName (string) --

      The name of the resource group that this resource belongs to.

    • terraformSourceName (string) --

      The name of the Terraform S3 state file this resource belongs to.

  • physicalResourceId (string) -- The physical identifier of the resource.
  • resourceName (string) -- The name of the resource.
Return type

dict

Returns

Response Syntax

{
    'appArn': 'string',
    'appVersion': 'string',
    'physicalResource': {
        'additionalInfo': {
            'string': [
                'string',
            ]
        },
        'appComponents': [
            {
                'additionalInfo': {
                    'string': [
                        'string',
                    ]
                },
                'id': 'string',
                'name': 'string',
                'type': 'string'
            },
        ],
        'excluded': True|False,
        'logicalResourceId': {
            'identifier': 'string',
            'logicalStackName': 'string',
            'resourceGroupName': 'string',
            'terraformSourceName': 'string'
        },
        'physicalResourceId': {
            'awsAccountId': 'string',
            'awsRegion': 'string',
            'identifier': 'string',
            'type': 'Arn'|'Native'
        },
        'resourceName': 'string',
        'resourceType': 'string'
    }
}

Response Structure

  • (dict) --

    • appArn (string) --

      The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

    • appVersion (string) --

      The AWS Resilience Hub application version.

    • physicalResource (dict) --

      Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.

      • additionalInfo (dict) --

        Additional configuration parameters for an AWS Resilience Hub application.

        Note

        Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

        Key: "failover-regions"

        Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

        • (string) --
          • (list) --
            • (string) --
      • appComponents (list) --

        The application components that belong to this resource.

        • (dict) --

          Defines an Application Component.

          • additionalInfo (dict) --

            Additional configuration parameters for an AWS Resilience Hub application.

            Note

            Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

            Key: "failover-regions"

            Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

            • (string) --
              • (list) --
                • (string) --
          • id (string) --

            Unique identifier of the Application Component.

          • name (string) --

            The name of the Application Component.

          • type (string) --

            The type of Application Component.

      • excluded (boolean) --

        Indicates if a resource is included or excluded from the assessment.

      • logicalResourceId (dict) --

        The logical identifier of the resource.

        • identifier (string) --

          The identifier of the resource.

        • logicalStackName (string) --

          The name of the CloudFormation stack this resource belongs to.

        • resourceGroupName (string) --

          The name of the resource group that this resource belongs to.

        • terraformSourceName (string) --

          The name of the Terraform S3 state file this resource belongs to.

      • physicalResourceId (dict) --

        The physical identifier of the resource.

        • awsAccountId (string) --

          The Amazon Web Services account that owns the physical resource.

        • awsRegion (string) --

          The Amazon Web Services Region that the physical resource is located in.

        • identifier (string) --

          The identifier of the physical resource.

        • type (string) --

          Specifies the type of physical resource identifier.

          Arn

          The resource identifier is an Amazon Resource Name (ARN) .

          Native

          The resource identifier is an AWS Resilience Hub-native identifier.

      • resourceName (string) --

        The name of the resource.

      • resourceType (string) --

        The type of resource.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
delete_recommendation_template(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.delete_recommendation_template(
    clientToken='string',
    recommendationTemplateArn='string'
)
Parameters
  • clientToken (string) --

    Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

    This field is autopopulated if not provided.

  • recommendationTemplateArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) for a recommendation template.

Return type

dict

Returns

Response Syntax

{
    'recommendationTemplateArn': 'string',
    'status': 'Pending'|'InProgress'|'Failed'|'Success'
}

Response Structure

  • (dict) --

    • recommendationTemplateArn (string) --

      The Amazon Resource Name (ARN) for a recommendation template.

    • status (string) --

      The status of the action.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
delete_resiliency_policy(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.delete_resiliency_policy(
    clientToken='string',
    policyArn='string'
)
Parameters
  • clientToken (string) --

    Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

    This field is autopopulated if not provided.

  • policyArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: partition :resiliencehub: region : account :resiliency-policy/ policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

Return type

dict

Returns

Response Syntax

{
    'policyArn': 'string'
}

Response Structure

  • (dict) --

    • policyArn (string) --

      The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: partition :resiliencehub: region : account :resiliency-policy/ policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
describe_app(**kwargs)

Describes an AWS Resilience Hub application.

See also: AWS API Documentation

Request Syntax

response = client.describe_app(
    appArn='string'
)
Parameters
appArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

Return type
dict
Returns
Response Syntax
{
    'app': {
        'appArn': 'string',
        'assessmentSchedule': 'Disabled'|'Daily',
        'complianceStatus': 'PolicyBreached'|'PolicyMet'|'NotAssessed'|'ChangesDetected',
        'creationTime': datetime(2015, 1, 1),
        'description': 'string',
        'lastAppComplianceEvaluationTime': datetime(2015, 1, 1),
        'lastResiliencyScoreEvaluationTime': datetime(2015, 1, 1),
        'name': 'string',
        'policyArn': 'string',
        'resiliencyScore': 123.0,
        'status': 'Active'|'Deleting',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --
    • app (dict) --

      The specified application, returned as an object with details including compliance status, creation time, description, resiliency score, and more.

      • appArn (string) --

        The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

      • assessmentSchedule (string) --

        Assessment execution schedule with 'Daily' or 'Disabled' values.

      • complianceStatus (string) --

        The current status of compliance for the resiliency policy.

      • creationTime (datetime) --

        The timestamp for when the app was created.

      • description (string) --

        The optional description for an app.

      • lastAppComplianceEvaluationTime (datetime) --

        The timestamp for the most recent compliance evaluation.

      • lastResiliencyScoreEvaluationTime (datetime) --

        The timestamp for the most recent resiliency score evaluation.

      • name (string) --

        The name for the application.

      • policyArn (string) --

        The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: partition :resiliencehub: region : account :resiliency-policy/ policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

      • resiliencyScore (float) --

        The current resiliency score for the application.

      • status (string) --

        The status of the application.

      • tags (dict) --

        The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

        • (string) --
          • (string) --

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
describe_app_assessment(**kwargs)

Describes an assessment for an AWS Resilience Hub application.

See also: AWS API Documentation

Request Syntax

response = client.describe_app_assessment(
    assessmentArn='string'
)
Parameters
assessmentArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: partition :resiliencehub: region : account :app-assessment/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

Return type
dict
Returns
Response Syntax
{
    'assessment': {
        'appArn': 'string',
        'appVersion': 'string',
        'assessmentArn': 'string',
        'assessmentName': 'string',
        'assessmentStatus': 'Pending'|'InProgress'|'Failed'|'Success',
        'compliance': {
            'string': {
                'achievableRpoInSecs': 123,
                'achievableRtoInSecs': 123,
                'complianceStatus': 'PolicyBreached'|'PolicyMet',
                'currentRpoInSecs': 123,
                'currentRtoInSecs': 123,
                'message': 'string',
                'rpoDescription': 'string',
                'rpoReferenceId': 'string',
                'rtoDescription': 'string',
                'rtoReferenceId': 'string'
            }
        },
        'complianceStatus': 'PolicyBreached'|'PolicyMet',
        'cost': {
            'amount': 123.0,
            'currency': 'string',
            'frequency': 'Hourly'|'Daily'|'Monthly'|'Yearly'
        },
        'endTime': datetime(2015, 1, 1),
        'invoker': 'User'|'System',
        'message': 'string',
        'policy': {
            'creationTime': datetime(2015, 1, 1),
            'dataLocationConstraint': 'AnyLocation'|'SameContinent'|'SameCountry',
            'estimatedCostTier': 'L1'|'L2'|'L3'|'L4',
            'policy': {
                'string': {
                    'rpoInSecs': 123,
                    'rtoInSecs': 123
                }
            },
            'policyArn': 'string',
            'policyDescription': 'string',
            'policyName': 'string',
            'tags': {
                'string': 'string'
            },
            'tier': 'MissionCritical'|'Critical'|'Important'|'CoreServices'|'NonCritical'
        },
        'resiliencyScore': {
            'disruptionScore': {
                'string': 123.0
            },
            'score': 123.0
        },
        'resourceErrorsDetails': {
            'hasMoreErrors': True|False,
            'resourceErrors': [
                {
                    'logicalResourceId': 'string',
                    'physicalResourceId': 'string',
                    'reason': 'string'
                },
            ]
        },
        'startTime': datetime(2015, 1, 1),
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --
    • assessment (dict) --

      The assessment for an AWS Resilience Hub application, returned as an object. This object includes Amazon Resource Names (ARNs), compliance information, compliance status, cost, messages, resiliency scores, and more.

      • appArn (string) --

        The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

      • appVersion (string) --

        The version of the application.

      • assessmentArn (string) --

        The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: partition :resiliencehub: region : account :app-assessment/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

      • assessmentName (string) --

        The name of the assessment.

      • assessmentStatus (string) --

        The current status of the assessment for the resiliency policy.

      • compliance (dict) --

        The application compliance against the resiliency policy.

        • (string) --
          • (dict) --

            Defines the compliance against the resiliency policy for a disruption.

            • achievableRpoInSecs (integer) --

              The Recovery Point Objective (RPO) that is achievable, in seconds.

            • achievableRtoInSecs (integer) --

              The Recovery Time Objective (RTO) that is achievable, in seconds

            • complianceStatus (string) --

              The current status of compliance for the resiliency policy.

            • currentRpoInSecs (integer) --

              The current RPO, in seconds.

            • currentRtoInSecs (integer) --

              The current RTO, in seconds.

            • message (string) --

              The disruption compliance message.

            • rpoDescription (string) --

              The RPO description.

            • rpoReferenceId (string) --

              The RPO reference identifier.

            • rtoDescription (string) --

              The RTO description.

            • rtoReferenceId (string) --

              The RTO reference identifier.

      • complianceStatus (string) --

        The current status of the compliance for the resiliency policy.

      • cost (dict) --

        The cost for the application.

        • amount (float) --

          The cost amount.

        • currency (string) --

          The cost currency, for example USD .

        • frequency (string) --

          The cost frequency.

      • endTime (datetime) --

        The end time for the action.

      • invoker (string) --

        The entity that invoked the assessment.

      • message (string) --

        Error or warning message from the assessment execution

      • policy (dict) --

        The resiliency policy.

        • creationTime (datetime) --

          The timestamp for when the resiliency policy was created.

        • dataLocationConstraint (string) --

          Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

        • estimatedCostTier (string) --

          Specifies the estimated cost tier of the resiliency policy.

        • policy (dict) --

          The resiliency policy.

          • (string) --
            • (dict) --

              Defines a failure policy.

              • rpoInSecs (integer) --

                The Recovery Point Objective (RPO), in seconds.

              • rtoInSecs (integer) --

                The Recovery Time Objective (RTO), in seconds.

        • policyArn (string) --

          The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: partition :resiliencehub: region : account :resiliency-policy/ policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

        • policyDescription (string) --

          The description for the policy.

        • policyName (string) --

          The name of the policy

        • tags (dict) --

          The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

          • (string) --
            • (string) --
        • tier (string) --

          The tier for this resiliency policy, ranging from the highest severity ( MissionCritical ) to lowest ( NonCritical ).

      • resiliencyScore (dict) --

        The current resiliency score for the application.

        • disruptionScore (dict) --

          The disruption score for a valid key.

          • (string) --
            • (float) --
        • score (float) --

          The outage score for a valid key.

      • resourceErrorsDetails (dict) --

        A resource error object containing a list of errors retrieving an application's resources.

        • hasMoreErrors (boolean) --

          This indicates if there are more errors not listed in the resourceErrors list.

        • resourceErrors (list) --

          A list of errors retrieving an application's resources.

          • (dict) --

            Defines application resource errors.

            • logicalResourceId (string) --

              This is the identifier of the resource.

            • physicalResourceId (string) --

              This is the identifier of the physical resource.

            • reason (string) --

              This is the error message.

      • startTime (datetime) --

        The starting time for the action.

      • tags (dict) --

        The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

        • (string) --
          • (string) --

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
describe_app_version(**kwargs)

Describes the AWS Resilience Hub application version.

See also: AWS API Documentation

Request Syntax

response = client.describe_app_version(
    appArn='string',
    appVersion='string'
)
Parameters
  • appArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • appVersion (string) --

    [REQUIRED]

    The AWS Resilience Hub application version.

Return type

dict

Returns

Response Syntax

{
    'additionalInfo': {
        'string': [
            'string',
        ]
    },
    'appArn': 'string',
    'appVersion': 'string'
}

Response Structure

  • (dict) --

    • additionalInfo (dict) --

      Additional configuration parameters for an AWS Resilience Hub application.

      Note

      Currently, this parameter supports only failover region and account.

      • (string) --
        • (list) --
          • (string) --
    • appArn (string) --

      The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

    • appVersion (string) --

      The AWS Resilience Hub application version.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
describe_app_version_app_component(**kwargs)

Describes an Application Component in the AWS Resilience Hub application.

See also: AWS API Documentation

Request Syntax

response = client.describe_app_version_app_component(
    appArn='string',
    appVersion='string',
    id='string'
)
Parameters
  • appArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • appVersion (string) --

    [REQUIRED]

    The AWS Resilience Hub application version.

  • id (string) --

    [REQUIRED]

    The identifier of the Application Component.

Return type

dict

Returns

Response Syntax

{
    'appArn': 'string',
    'appComponent': {
        'additionalInfo': {
            'string': [
                'string',
            ]
        },
        'id': 'string',
        'name': 'string',
        'type': 'string'
    },
    'appVersion': 'string'
}

Response Structure

  • (dict) --

    • appArn (string) --

      The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

    • appComponent (dict) --

      Defines an Application Component.

      • additionalInfo (dict) --

        Additional configuration parameters for an AWS Resilience Hub application.

        Note

        Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

        Key: "failover-regions"

        Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

        • (string) --
          • (list) --
            • (string) --
      • id (string) --

        Unique identifier of the Application Component.

      • name (string) --

        The name of the Application Component.

      • type (string) --

        The type of Application Component.

    • appVersion (string) --

      The AWS Resilience Hub application version.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
describe_app_version_resource(**kwargs)

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 )

See also: AWS API Documentation

Request Syntax

response = client.describe_app_version_resource(
    appArn='string',
    appVersion='string',
    awsAccountId='string',
    awsRegion='string',
    logicalResourceId={
        'identifier': 'string',
        'logicalStackName': 'string',
        'resourceGroupName': 'string',
        'terraformSourceName': 'string'
    },
    physicalResourceId='string',
    resourceName='string'
)
Parameters
  • appArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • appVersion (string) --

    [REQUIRED]

    The AWS Resilience Hub application version.

  • awsAccountId (string) -- The Amazon Web Services account that owns the physical resource.
  • awsRegion (string) -- The Amazon Web Services region that owns the physical resource.
  • logicalResourceId (dict) --

    The logical identifier of the resource.

    • identifier (string) -- [REQUIRED]

      The identifier of the resource.

    • logicalStackName (string) --

      The name of the CloudFormation stack this resource belongs to.

    • resourceGroupName (string) --

      The name of the resource group that this resource belongs to.

    • terraformSourceName (string) --

      The name of the Terraform S3 state file this resource belongs to.

  • physicalResourceId (string) -- The physical identifier of the resource.
  • resourceName (string) -- The name of the resource.
Return type

dict

Returns

Response Syntax

{
    'appArn': 'string',
    'appVersion': 'string',
    'physicalResource': {
        'additionalInfo': {
            'string': [
                'string',
            ]
        },
        'appComponents': [
            {
                'additionalInfo': {
                    'string': [
                        'string',
                    ]
                },
                'id': 'string',
                'name': 'string',
                'type': 'string'
            },
        ],
        'excluded': True|False,
        'logicalResourceId': {
            'identifier': 'string',
            'logicalStackName': 'string',
            'resourceGroupName': 'string',
            'terraformSourceName': 'string'
        },
        'physicalResourceId': {
            'awsAccountId': 'string',
            'awsRegion': 'string',
            'identifier': 'string',
            'type': 'Arn'|'Native'
        },
        'resourceName': 'string',
        'resourceType': 'string'
    }
}

Response Structure

  • (dict) --

    • appArn (string) --

      The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

    • appVersion (string) --

      The AWS Resilience Hub application version.

    • physicalResource (dict) --

      Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.

      • additionalInfo (dict) --

        Additional configuration parameters for an AWS Resilience Hub application.

        Note

        Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

        Key: "failover-regions"

        Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

        • (string) --
          • (list) --
            • (string) --
      • appComponents (list) --

        The application components that belong to this resource.

        • (dict) --

          Defines an Application Component.

          • additionalInfo (dict) --

            Additional configuration parameters for an AWS Resilience Hub application.

            Note

            Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

            Key: "failover-regions"

            Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

            • (string) --
              • (list) --
                • (string) --
          • id (string) --

            Unique identifier of the Application Component.

          • name (string) --

            The name of the Application Component.

          • type (string) --

            The type of Application Component.

      • excluded (boolean) --

        Indicates if a resource is included or excluded from the assessment.

      • logicalResourceId (dict) --

        The logical identifier of the resource.

        • identifier (string) --

          The identifier of the resource.

        • logicalStackName (string) --

          The name of the CloudFormation stack this resource belongs to.

        • resourceGroupName (string) --

          The name of the resource group that this resource belongs to.

        • terraformSourceName (string) --

          The name of the Terraform S3 state file this resource belongs to.

      • physicalResourceId (dict) --

        The physical identifier of the resource.

        • awsAccountId (string) --

          The Amazon Web Services account that owns the physical resource.

        • awsRegion (string) --

          The Amazon Web Services Region that the physical resource is located in.

        • identifier (string) --

          The identifier of the physical resource.

        • type (string) --

          Specifies the type of physical resource identifier.

          Arn

          The resource identifier is an Amazon Resource Name (ARN) .

          Native

          The resource identifier is an AWS Resilience Hub-native identifier.

      • resourceName (string) --

        The name of the resource.

      • resourceType (string) --

        The type of resource.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
describe_app_version_resources_resolution_status(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_app_version_resources_resolution_status(
    appArn='string',
    appVersion='string',
    resolutionId='string'
)
Parameters
  • appArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • appVersion (string) --

    [REQUIRED]

    The version of the application.

  • resolutionId (string) -- The identifier for a specific resolution.
Return type

dict

Returns

Response Syntax

{
    'appArn': 'string',
    'appVersion': 'string',
    'errorMessage': 'string',
    'resolutionId': 'string',
    'status': 'Pending'|'InProgress'|'Failed'|'Success'
}

Response Structure

  • (dict) --

    • appArn (string) --

      The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

    • appVersion (string) --

      The version of the application.

    • errorMessage (string) --

      The returned error message for the request.

    • resolutionId (string) --

      The identifier for a specific resolution.

    • status (string) --

      The status of the action.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
describe_app_version_template(**kwargs)

Describes details about an AWS Resilience Hub application.

See also: AWS API Documentation

Request Syntax

response = client.describe_app_version_template(
    appArn='string',
    appVersion='string'
)
Parameters
  • appArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • appVersion (string) --

    [REQUIRED]

    The version of the application.

Return type

dict

Returns

Response Syntax

{
    'appArn': 'string',
    'appTemplateBody': 'string',
    'appVersion': 'string'
}

Response Structure

  • (dict) --

    • appArn (string) --

      The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

    • appTemplateBody (string) --

      A JSON string that provides information about your application structure. To learn more about the appTemplateBody template, see the sample template provided in the Examples section.

      The appTemplateBody JSON string has the following structure:

      • resources The list of logical resources that needs to be included in the application. Type: Array

      Note

      Don't add the resources that you want to exclude.

      Each resources array item includes the following fields:

      • logicalResourceId The logical identifier of the resource. Type: Object Each logicalResourceId object includes the following fields:
        • identifier The identifier of the resource. Type: String
        • logicalStackName The name of the CloudFormation stack this resource belongs to. Type: String
        • resourceGroupName The name of the resource group this resource belongs to. Type: String
        • terraformSourceName The name of the Terraform S3 state file this resource belongs to. Type: String
      • type The type of resource. Type: string
      • name The name of the resource. Type: String
      • appComponents The list of Application Components that this resource belongs to. If an Application Component is not part of the AWS Resilience Hub application, it will be added. Type: Array Each appComponents array item includes the following fields:

        • name The name of the Application Component. Type: String
        • type The type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent. Type: String
        • resourceNames The list of included resources that are assigned to the Application Component. Type: Array of strings
        • additionalInfo Additional configuration parameters for an AWS Resilience Hub application.

        Note

        Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: "failover-regions" Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

      • excludedResources The list of logical resource identifiers to be excluded from the application. Type: Array

      Note

      Don't add the resources that you want to include.

      Each excludedResources array item includes the following fields:

      • logicalResourceIds The logical identifier of the resource. Type: Object

      Note

      You can configure only one of the following fields:

      • logicalStackName
      • resourceGroupName
      • terraformSourceName

      Each logicalResourceIds object includes the following fields:

      • identifier The identifier of the resource. Type: String
      • logicalStackName The name of the CloudFormation stack this resource belongs to. Type: String
      • resourceGroupName The name of the resource group this resource belongs to. Type: String
      • terraformSourceName The name of the Terraform S3 state file this resource belongs to. Type: String
    • appVersion (string) --

      The version of the application.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
describe_draft_app_version_resources_import_status(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_draft_app_version_resources_import_status(
    appArn='string'
)
Parameters
appArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

Return type
dict
Returns
Response Syntax
{
    'appArn': 'string',
    'appVersion': 'string',
    'errorMessage': 'string',
    'status': 'Pending'|'InProgress'|'Failed'|'Success',
    'statusChangeTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --
    • appArn (string) --

      The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

    • appVersion (string) --

      The version of the application.

    • errorMessage (string) --

      The returned error message for the request.

    • status (string) --

      The status of the action.

    • statusChangeTime (datetime) --

      The timestamp for when the status last changed.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
describe_resiliency_policy(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_resiliency_policy(
    policyArn='string'
)
Parameters
policyArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: partition :resiliencehub: region : account :resiliency-policy/ policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

Return type
dict
Returns
Response Syntax
{
    'policy': {
        'creationTime': datetime(2015, 1, 1),
        'dataLocationConstraint': 'AnyLocation'|'SameContinent'|'SameCountry',
        'estimatedCostTier': 'L1'|'L2'|'L3'|'L4',
        'policy': {
            'string': {
                'rpoInSecs': 123,
                'rtoInSecs': 123
            }
        },
        'policyArn': 'string',
        'policyDescription': 'string',
        'policyName': 'string',
        'tags': {
            'string': 'string'
        },
        'tier': 'MissionCritical'|'Critical'|'Important'|'CoreServices'|'NonCritical'
    }
}

Response Structure

  • (dict) --
    • policy (dict) --

      Information about the specific resiliency policy, returned as an object. This object includes creation time, data location constraints, its name, description, tags, the recovery time objective (RTO) and recovery point objective (RPO) in seconds, and more.

      • creationTime (datetime) --

        The timestamp for when the resiliency policy was created.

      • dataLocationConstraint (string) --

        Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

      • estimatedCostTier (string) --

        Specifies the estimated cost tier of the resiliency policy.

      • policy (dict) --

        The resiliency policy.

        • (string) --
          • (dict) --

            Defines a failure policy.

            • rpoInSecs (integer) --

              The Recovery Point Objective (RPO), in seconds.

            • rtoInSecs (integer) --

              The Recovery Time Objective (RTO), in seconds.

      • policyArn (string) --

        The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: partition :resiliencehub: region : account :resiliency-policy/ policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

      • policyDescription (string) --

        The description for the policy.

      • policyName (string) --

        The name of the policy

      • tags (dict) --

        The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

        • (string) --
          • (string) --
      • tier (string) --

        The tier for this resiliency policy, ranging from the highest severity ( MissionCritical ) to lowest ( NonCritical ).

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
import_resources_to_draft_app_version(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.import_resources_to_draft_app_version(
    appArn='string',
    importStrategy='AddOnly'|'ReplaceAll',
    sourceArns=[
        'string',
    ],
    terraformSources=[
        {
            's3StateFileUrl': 'string'
        },
    ]
)
Parameters
  • appArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • importStrategy (string) -- The import strategy you would like to set to import resources into AWS Resilience Hub application.
  • sourceArns (list) --

    The Amazon Resource Names (ARNs) for the resources that you want to import.

    • (string) --
  • terraformSources (list) --

    A list of terraform file s3 URLs you need to import.

    • (dict) --

      The Terraform s3 state file you need to import.

      • s3StateFileUrl (string) -- [REQUIRED]

        The Terraform s3 state file you need to import.

Return type

dict

Returns

Response Syntax

{
    'appArn': 'string',
    'appVersion': 'string',
    'sourceArns': [
        'string',
    ],
    'status': 'Pending'|'InProgress'|'Failed'|'Success',
    'terraformSources': [
        {
            's3StateFileUrl': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • appArn (string) --

      The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

    • appVersion (string) --

      The version of the application.

    • sourceArns (list) --

      The Amazon Resource Names (ARNs) for the resources that you imported.

      • (string) --
    • status (string) --

      The status of the action.

    • terraformSources (list) --

      A list of terraform file s3 URLs you need to import.

      • (dict) --

        The Terraform s3 state file you need to import.

        • s3StateFileUrl (string) --

          The Terraform s3 state file you need to import.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
list_alarm_recommendations(**kwargs)

Lists the alarm recommendations for an AWS Resilience Hub application.

See also: AWS API Documentation

Request Syntax

response = client.list_alarm_recommendations(
    assessmentArn='string',
    maxResults=123,
    nextToken='string'
)
Parameters
  • assessmentArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: partition :resiliencehub: region : account :app-assessment/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • maxResults (integer) -- The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • nextToken (string) -- Null, or the token from a previous call to get the next set of results.
Return type

dict

Returns

Response Syntax

{
    'alarmRecommendations': [
        {
            'appComponentName': 'string',
            'description': 'string',
            'items': [
                {
                    'alreadyImplemented': True|False,
                    'resourceId': 'string',
                    'targetAccountId': 'string',
                    'targetRegion': 'string'
                },
            ],
            'name': 'string',
            'prerequisite': 'string',
            'recommendationId': 'string',
            'referenceId': 'string',
            'type': 'Metric'|'Composite'|'Canary'|'Logs'|'Event'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • alarmRecommendations (list) --

      The alarm recommendations for an AWS Resilience Hub application, returned as an object. This object includes Application Component names, descriptions, information about whether a recommendation has already been implemented or not, prerequisites, and more.

      • (dict) --

        Defines a recommendation for a CloudWatch alarm.

        • appComponentName (string) --

          The Application Component for the CloudWatch alarm recommendation.

        • description (string) --

          The description of the recommendation.

        • items (list) --

          The list of CloudWatch alarm recommendations.

          • (dict) --

            Defines a recommendation.

            • alreadyImplemented (boolean) --

              Specifies if the recommendation has already been implemented.

            • resourceId (string) --

              The resource identifier.

            • targetAccountId (string) --

              The target account identifier.

            • targetRegion (string) --

              The target region.

        • name (string) --

          The name of the alarm recommendation.

        • prerequisite (string) --

          The prerequisite for the alarm recommendation.

        • recommendationId (string) --

          The identifier of the alarm recommendation.

        • referenceId (string) --

          The reference identifier of the alarm recommendation.

        • type (string) --

          The type of alarm recommendation.

    • nextToken (string) --

      The token for the next set of results, or null if there are no more results.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
list_app_assessments(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_app_assessments(
    appArn='string',
    assessmentName='string',
    assessmentStatus=[
        'Pending'|'InProgress'|'Failed'|'Success',
    ],
    complianceStatus='PolicyBreached'|'PolicyMet',
    invoker='User'|'System',
    maxResults=123,
    nextToken='string',
    reverseOrder=True|False
)
Parameters
  • appArn (string) -- The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
  • assessmentName (string) -- The name for the assessment.
  • assessmentStatus (list) --

    The current status of the assessment for the resiliency policy.

    • (string) --
  • complianceStatus (string) -- The current status of compliance for the resiliency policy.
  • invoker (string) -- Specifies the entity that invoked a specific assessment, either a User or the System .
  • maxResults (integer) -- The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • nextToken (string) -- Null, or the token from a previous call to get the next set of results.
  • reverseOrder (boolean) -- The default is to sort by ascending startTime . To sort by descending startTime , set reverseOrder to true .
Return type

dict

Returns

Response Syntax

{
    'assessmentSummaries': [
        {
            'appArn': 'string',
            'appVersion': 'string',
            'assessmentArn': 'string',
            'assessmentName': 'string',
            'assessmentStatus': 'Pending'|'InProgress'|'Failed'|'Success',
            'complianceStatus': 'PolicyBreached'|'PolicyMet',
            'cost': {
                'amount': 123.0,
                'currency': 'string',
                'frequency': 'Hourly'|'Daily'|'Monthly'|'Yearly'
            },
            'endTime': datetime(2015, 1, 1),
            'invoker': 'User'|'System',
            'message': 'string',
            'resiliencyScore': 123.0,
            'startTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • assessmentSummaries (list) --

      The summaries for the specified assessments, returned as an object. This object includes application versions, associated Amazon Resource Numbers (ARNs), cost, messages, resiliency scores, and more.

      • (dict) --

        Defines an application assessment summary.

        • appArn (string) --

          The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

        • appVersion (string) --

          The version of the application.

        • assessmentArn (string) --

          The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: partition :resiliencehub: region : account :app-assessment/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

        • assessmentName (string) --

          The name of the assessment.

        • assessmentStatus (string) --

          The current status of the assessment for the resiliency policy.

        • complianceStatus (string) --

          The current status of compliance for the resiliency policy.

        • cost (dict) --

          The cost for the application.

          • amount (float) --

            The cost amount.

          • currency (string) --

            The cost currency, for example USD .

          • frequency (string) --

            The cost frequency.

        • endTime (datetime) --

          The end time for the action.

        • invoker (string) --

          The entity that invoked the assessment.

        • message (string) --

          The message from the assessment run.

        • resiliencyScore (float) --

          The current resiliency score for the application.

        • startTime (datetime) --

          The starting time for the action.

    • nextToken (string) --

      The token for the next set of results, or null if there are no more results.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
list_app_component_compliances(**kwargs)

Lists the compliances for an AWS Resilience Hub Application Component.

See also: AWS API Documentation

Request Syntax

response = client.list_app_component_compliances(
    assessmentArn='string',
    maxResults=123,
    nextToken='string'
)
Parameters
  • assessmentArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: partition :resiliencehub: region : account :app-assessment/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • maxResults (integer) -- The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • nextToken (string) -- Null, or the token from a previous call to get the next set of results.
Return type

dict

Returns

Response Syntax

{
    'componentCompliances': [
        {
            'appComponentName': 'string',
            'compliance': {
                'string': {
                    'achievableRpoInSecs': 123,
                    'achievableRtoInSecs': 123,
                    'complianceStatus': 'PolicyBreached'|'PolicyMet',
                    'currentRpoInSecs': 123,
                    'currentRtoInSecs': 123,
                    'message': 'string',
                    'rpoDescription': 'string',
                    'rpoReferenceId': 'string',
                    'rtoDescription': 'string',
                    'rtoReferenceId': 'string'
                }
            },
            'cost': {
                'amount': 123.0,
                'currency': 'string',
                'frequency': 'Hourly'|'Daily'|'Monthly'|'Yearly'
            },
            'message': 'string',
            'resiliencyScore': {
                'disruptionScore': {
                    'string': 123.0
                },
                'score': 123.0
            },
            'status': 'PolicyBreached'|'PolicyMet'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • componentCompliances (list) --

      The compliances for an AWS Resilience Hub Application Component, returned as an object. This object contains the names of the Application Components, compliances, costs, resiliency scores, outage scores, and more.

      • (dict) --

        Defines the compliance of an Application Component against the resiliency policy.

        • appComponentName (string) --

          The name of the Application Component.

        • compliance (dict) --

          The compliance of the Application Component against the resiliency policy.

          • (string) --

            • (dict) --

              Defines the compliance against the resiliency policy for a disruption.

              • achievableRpoInSecs (integer) --

                The Recovery Point Objective (RPO) that is achievable, in seconds.

              • achievableRtoInSecs (integer) --

                The Recovery Time Objective (RTO) that is achievable, in seconds

              • complianceStatus (string) --

                The current status of compliance for the resiliency policy.

              • currentRpoInSecs (integer) --

                The current RPO, in seconds.

              • currentRtoInSecs (integer) --

                The current RTO, in seconds.

              • message (string) --

                The disruption compliance message.

              • rpoDescription (string) --

                The RPO description.

              • rpoReferenceId (string) --

                The RPO reference identifier.

              • rtoDescription (string) --

                The RTO description.

              • rtoReferenceId (string) --

                The RTO reference identifier.

        • cost (dict) --

          The cost for the application.

          • amount (float) --

            The cost amount.

          • currency (string) --

            The cost currency, for example USD .

          • frequency (string) --

            The cost frequency.

        • message (string) --

          The compliance message.

        • resiliencyScore (dict) --

          The current resiliency score for the application.

          • disruptionScore (dict) --

            The disruption score for a valid key.

            • (string) --
              • (float) --
          • score (float) --

            The outage score for a valid key.

        • status (string) --

          The status of the action.

    • nextToken (string) --

      The token for the next set of results, or null if there are no more results.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
list_app_component_recommendations(**kwargs)

Lists the recommendations for an AWS Resilience Hub Application Component.

See also: AWS API Documentation

Request Syntax

response = client.list_app_component_recommendations(
    assessmentArn='string',
    maxResults=123,
    nextToken='string'
)
Parameters
  • assessmentArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: partition :resiliencehub: region : account :app-assessment/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • maxResults (integer) -- The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • nextToken (string) -- Null, or the token from a previous call to get the next set of results.
Return type

dict

Returns

Response Syntax

{
    'componentRecommendations': [
        {
            'appComponentName': 'string',
            'configRecommendations': [
                {
                    'appComponentName': 'string',
                    'compliance': {
                        'string': {
                            'achievableRpoInSecs': 123,
                            'achievableRtoInSecs': 123,
                            'complianceStatus': 'PolicyBreached'|'PolicyMet',
                            'currentRpoInSecs': 123,
                            'currentRtoInSecs': 123,
                            'message': 'string',
                            'rpoDescription': 'string',
                            'rpoReferenceId': 'string',
                            'rtoDescription': 'string',
                            'rtoReferenceId': 'string'
                        }
                    },
                    'cost': {
                        'amount': 123.0,
                        'currency': 'string',
                        'frequency': 'Hourly'|'Daily'|'Monthly'|'Yearly'
                    },
                    'description': 'string',
                    'haArchitecture': 'MultiSite'|'WarmStandby'|'PilotLight'|'BackupAndRestore'|'NoRecoveryPlan',
                    'name': 'string',
                    'optimizationType': 'LeastCost'|'LeastChange'|'BestAZRecovery'|'LeastErrors'|'BestAttainable'|'BestRegionRecovery',
                    'recommendationCompliance': {
                        'string': {
                            'expectedComplianceStatus': 'PolicyBreached'|'PolicyMet',
                            'expectedRpoDescription': 'string',
                            'expectedRpoInSecs': 123,
                            'expectedRtoDescription': 'string',
                            'expectedRtoInSecs': 123
                        }
                    },
                    'referenceId': 'string',
                    'suggestedChanges': [
                        'string',
                    ]
                },
            ],
            'recommendationStatus': 'BreachedUnattainable'|'BreachedCanMeet'|'MetCanImprove'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • componentRecommendations (list) --

      The recommendations for an AWS Resilience Hub Application Component, returned as an object. This object contains the names of the Application Components, configuration recommendations, and recommendation statuses.

      • (dict) --

        Defines recommendations for an AWS Resilience Hub Application Component, returned as an object. This object contains component names, configuration recommendations, and recommendation statuses.

        • appComponentName (string) --

          The name of the Application Component.

        • configRecommendations (list) --

          The list of recommendations.

          • (dict) --

            Defines a configuration recommendation.

            • appComponentName (string) --

              The name of the Application Component.

            • compliance (dict) --

              The current compliance against the resiliency policy before applying the configuration change.

              • (string) --

                • (dict) --

                  Defines the compliance against the resiliency policy for a disruption.

                  • achievableRpoInSecs (integer) --

                    The Recovery Point Objective (RPO) that is achievable, in seconds.

                  • achievableRtoInSecs (integer) --

                    The Recovery Time Objective (RTO) that is achievable, in seconds

                  • complianceStatus (string) --

                    The current status of compliance for the resiliency policy.

                  • currentRpoInSecs (integer) --

                    The current RPO, in seconds.

                  • currentRtoInSecs (integer) --

                    The current RTO, in seconds.

                  • message (string) --

                    The disruption compliance message.

                  • rpoDescription (string) --

                    The RPO description.

                  • rpoReferenceId (string) --

                    The RPO reference identifier.

                  • rtoDescription (string) --

                    The RTO description.

                  • rtoReferenceId (string) --

                    The RTO reference identifier.

            • cost (dict) --

              The cost for the application.

              • amount (float) --

                The cost amount.

              • currency (string) --

                The cost currency, for example USD .

              • frequency (string) --

                The cost frequency.

            • description (string) --

              The optional description for an app.

            • haArchitecture (string) --

              The architecture type.

            • name (string) --

              The name of the recommendation configuration.

            • optimizationType (string) --

              The type of optimization.

            • recommendationCompliance (dict) --

              The expected compliance against the resiliency policy after applying the configuration change.

              • (string) --

                • (dict) --

                  Defines a disruption compliance recommendation.

                  • expectedComplianceStatus (string) --

                    The expected compliance status after applying the recommended configuration change.

                  • expectedRpoDescription (string) --

                    The expected Recovery Point Objective (RPO) description after applying the recommended configuration change.

                  • expectedRpoInSecs (integer) --

                    The expected RPO after applying the recommended configuration change.

                  • expectedRtoDescription (string) --

                    The expected Recovery Time Objective (RTO) description after applying the recommended configuration change.

                  • expectedRtoInSecs (integer) --

                    The expected RTO after applying the recommended configuration change.

            • referenceId (string) --

              The reference identifier for the recommendation configuration.

            • suggestedChanges (list) --

              List of the suggested configuration changes.

              • (string) --
        • recommendationStatus (string) --

          The recommendation status.

    • nextToken (string) --

      The token for the next set of results, or null if there are no more results.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
list_app_input_sources(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.list_app_input_sources(
    appArn='string',
    appVersion='string',
    maxResults=123,
    nextToken='string'
)
Parameters
  • appArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • appVersion (string) --

    [REQUIRED]

    The AWS Resilience Hub application version.

  • maxResults (integer) -- Maximum number of input sources to be displayed per AWS Resilience Hub application.
  • nextToken (string) -- Null, or the token from a previous call to get the next set of results.
Return type

dict

Returns

Response Syntax

{
    'appInputSources': [
        {
            'importType': 'CfnStack'|'Resource'|'AppRegistryApp'|'ResourceGroup'|'Terraform',
            'resourceCount': 123,
            'sourceArn': 'string',
            'sourceName': 'string',
            'terraformSource': {
                's3StateFileUrl': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • appInputSources (list) --

      The list of AWS Resilience Hub application input sources.

      • (dict) --

        The list of AWS Resilience Hub application input sources.

        • importType (string) --

          The resource type of the input source.

        • resourceCount (integer) --

          The number of resources that were imported.

        • sourceArn (string) --

          The Amazon Resource Name (ARN) of the input source. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

        • sourceName (string) --

          The name of the input source.

        • terraformSource (dict) --

          The name of the Terraform s3 state file.

          • s3StateFileUrl (string) --

            The Terraform s3 state file you need to import.

    • nextToken (string) --

      The token for the next set of results, or null if there are no more results.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
list_app_version_app_components(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_app_version_app_components(
    appArn='string',
    appVersion='string',
    maxResults=123,
    nextToken='string'
)
Parameters
  • appArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • appVersion (string) --

    [REQUIRED]

    The version of the Application Component.

  • maxResults (integer) -- Maximum number of Application Components to be displayed per AWS Resilience Hub application version.
  • nextToken (string) -- Null, or the token from a previous call to get the next set of results.
Return type

dict

Returns

Response Syntax

{
    'appArn': 'string',
    'appComponents': [
        {
            'additionalInfo': {
                'string': [
                    'string',
                ]
            },
            'id': 'string',
            'name': 'string',
            'type': 'string'
        },
    ],
    'appVersion': 'string',
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • appArn (string) --

      The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

    • appComponents (list) --

      Defines an Application Component.

      • (dict) --

        Defines an Application Component.

        • additionalInfo (dict) --

          Additional configuration parameters for an AWS Resilience Hub application.

          Note

          Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

          Key: "failover-regions"

          Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

          • (string) --
            • (list) --
              • (string) --
        • id (string) --

          Unique identifier of the Application Component.

        • name (string) --

          The name of the Application Component.

        • type (string) --

          The type of Application Component.

    • appVersion (string) --

      The AWS Resilience Hub application version.

    • nextToken (string) --

      The token for the next set of results, or null if there are no more results.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
list_app_version_resource_mappings(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.list_app_version_resource_mappings(
    appArn='string',
    appVersion='string',
    maxResults=123,
    nextToken='string'
)
Parameters
  • appArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • appVersion (string) --

    [REQUIRED]

    The version of the application.

  • maxResults (integer) -- The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • nextToken (string) -- Null, or the token from a previous call to get the next set of results.
Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'resourceMappings': [
        {
            'appRegistryAppName': 'string',
            'logicalStackName': 'string',
            'mappingType': 'CfnStack'|'Resource'|'AppRegistryApp'|'ResourceGroup'|'Terraform',
            'physicalResourceId': {
                'awsAccountId': 'string',
                'awsRegion': 'string',
                'identifier': 'string',
                'type': 'Arn'|'Native'
            },
            'resourceGroupName': 'string',
            'resourceName': 'string',
            'terraformSourceName': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      The token for the next set of results, or null if there are no more results.

    • resourceMappings (list) --

      Mappings used to map logical resources from the template to physical resources. You can use the mapping type CFN_STACK if the application template uses a logical stack name. Or you can map individual resources by using the mapping type RESOURCE . We recommend using the mapping type CFN_STACK if the application is backed by a CloudFormation stack.

      • (dict) --

        Defines a resource mapping.

        • appRegistryAppName (string) --

          The name of the application this resource is mapped to.

        • logicalStackName (string) --

          The name of the CloudFormation stack this resource is mapped to.

        • mappingType (string) --

          Specifies the type of resource mapping.

          AppRegistryApp

          The resource is mapped to another application. The name of the application is contained in the appRegistryAppName property.

          CfnStack

          The resource is mapped to a CloudFormation stack. The name of the CloudFormation stack is contained in the logicalStackName property.

          Resource

          The resource is mapped to another resource. The name of the resource is contained in the resourceName property.

          ResourceGroup

          The resource is mapped to a resource group. The name of the resource group is contained in the resourceGroupName property.

        • physicalResourceId (dict) --

          The identifier of this resource.

          • awsAccountId (string) --

            The Amazon Web Services account that owns the physical resource.

          • awsRegion (string) --

            The Amazon Web Services Region that the physical resource is located in.

          • identifier (string) --

            The identifier of the physical resource.

          • type (string) --

            Specifies the type of physical resource identifier.

            Arn

            The resource identifier is an Amazon Resource Name (ARN) .

            Native

            The resource identifier is an AWS Resilience Hub-native identifier.

        • resourceGroupName (string) --

          The name of the resource group this resource is mapped to.

        • resourceName (string) --

          The name of the resource this resource is mapped to.

        • terraformSourceName (string) --

          The short name of the Terraform source.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
list_app_version_resources(**kwargs)

Lists all the resources in an AWS Resilience Hub application.

See also: AWS API Documentation

Request Syntax

response = client.list_app_version_resources(
    appArn='string',
    appVersion='string',
    maxResults=123,
    nextToken='string',
    resolutionId='string'
)
Parameters
  • appArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • appVersion (string) --

    [REQUIRED]

    The version of the application.

  • maxResults (integer) -- The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • nextToken (string) -- Null, or the token from a previous call to get the next set of results.
  • resolutionId (string) -- The identifier for a specific resolution.
Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'physicalResources': [
        {
            'additionalInfo': {
                'string': [
                    'string',
                ]
            },
            'appComponents': [
                {
                    'additionalInfo': {
                        'string': [
                            'string',
                        ]
                    },
                    'id': 'string',
                    'name': 'string',
                    'type': 'string'
                },
            ],
            'excluded': True|False,
            'logicalResourceId': {
                'identifier': 'string',
                'logicalStackName': 'string',
                'resourceGroupName': 'string',
                'terraformSourceName': 'string'
            },
            'physicalResourceId': {
                'awsAccountId': 'string',
                'awsRegion': 'string',
                'identifier': 'string',
                'type': 'Arn'|'Native'
            },
            'resourceName': 'string',
            'resourceType': 'string'
        },
    ],
    'resolutionId': 'string'
}

Response Structure

  • (dict) --

    • nextToken (string) --

      The token for the next set of results, or null if there are no more results.

    • physicalResources (list) --

      The physical resources in the application version.

      • (dict) --

        Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or an AWS Resilience Hub-native identifier.

        • additionalInfo (dict) --

          Additional configuration parameters for an AWS Resilience Hub application.

          Note

          Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

          Key: "failover-regions"

          Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

          • (string) --
            • (list) --
              • (string) --
        • appComponents (list) --

          The application components that belong to this resource.

          • (dict) --

            Defines an Application Component.

            • additionalInfo (dict) --

              Additional configuration parameters for an AWS Resilience Hub application.

              Note

              Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

              Key: "failover-regions"

              Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

              • (string) --
                • (list) --
                  • (string) --
            • id (string) --

              Unique identifier of the Application Component.

            • name (string) --

              The name of the Application Component.

            • type (string) --

              The type of Application Component.

        • excluded (boolean) --

          Indicates if a resource is included or excluded from the assessment.

        • logicalResourceId (dict) --

          The logical identifier of the resource.

          • identifier (string) --

            The identifier of the resource.

          • logicalStackName (string) --

            The name of the CloudFormation stack this resource belongs to.

          • resourceGroupName (string) --

            The name of the resource group that this resource belongs to.

          • terraformSourceName (string) --

            The name of the Terraform S3 state file this resource belongs to.

        • physicalResourceId (dict) --

          The physical identifier of the resource.

          • awsAccountId (string) --

            The Amazon Web Services account that owns the physical resource.

          • awsRegion (string) --

            The Amazon Web Services Region that the physical resource is located in.

          • identifier (string) --

            The identifier of the physical resource.

          • type (string) --

            Specifies the type of physical resource identifier.

            Arn

            The resource identifier is an Amazon Resource Name (ARN) .

            Native

            The resource identifier is an AWS Resilience Hub-native identifier.

        • resourceName (string) --

          The name of the resource.

        • resourceType (string) --

          The type of resource.

    • resolutionId (string) --

      The ID for a specific resolution.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
list_app_versions(**kwargs)

Lists the different versions for the AWS Resilience Hub applications.

See also: AWS API Documentation

Request Syntax

response = client.list_app_versions(
    appArn='string',
    maxResults=123,
    nextToken='string'
)
Parameters
  • appArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • maxResults (integer) -- The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • nextToken (string) -- Null, or the token from a previous call to get the next set of results.
Return type

dict

Returns

Response Syntax

{
    'appVersions': [
        {
            'appVersion': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • appVersions (list) --

      The version of the application.

      • (dict) --

        The version of the application.

        • appVersion (string) --

          The version of the application.

    • nextToken (string) --

      The token for the next set of results, or null if there are no more results.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
list_apps(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.list_apps(
    appArn='string',
    maxResults=123,
    name='string',
    nextToken='string'
)
Parameters
  • appArn (string) -- The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
  • maxResults (integer) -- The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • name (string) -- The name for the one of the listed applications.
  • nextToken (string) -- Null, or the token from a previous call to get the next set of results.
Return type

dict

Returns

Response Syntax

{
    'appSummaries': [
        {
            'appArn': 'string',
            'assessmentSchedule': 'Disabled'|'Daily',
            'complianceStatus': 'PolicyBreached'|'PolicyMet'|'NotAssessed'|'ChangesDetected',
            'creationTime': datetime(2015, 1, 1),
            'description': 'string',
            'name': 'string',
            'resiliencyScore': 123.0,
            'status': 'Active'|'Deleting'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • appSummaries (list) --

      Summaries for the AWS Resilience Hub application.

      • (dict) --

        Defines an application summary.

        • appArn (string) --

          The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

        • assessmentSchedule (string) --

          Assessment execution schedule with 'Daily' or 'Disabled' values.

        • complianceStatus (string) --

          The current status of compliance for the resiliency policy.

        • creationTime (datetime) --

          The timestamp for when the app was created.

        • description (string) --

          The optional description for an app.

        • name (string) --

          The name of the application.

        • resiliencyScore (float) --

          The current resiliency score for the application.

        • status (string) --

          The status of the application.

    • nextToken (string) --

      The token for the next set of results, or null if there are no more results.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
list_recommendation_templates(**kwargs)

Lists the recommendation templates for the AWS Resilience Hub applications.

See also: AWS API Documentation

Request Syntax

response = client.list_recommendation_templates(
    assessmentArn='string',
    maxResults=123,
    name='string',
    nextToken='string',
    recommendationTemplateArn='string',
    reverseOrder=True|False,
    status=[
        'Pending'|'InProgress'|'Failed'|'Success',
    ]
)
Parameters
  • assessmentArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: partition :resiliencehub: region : account :app-assessment/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • maxResults (integer) -- The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • name (string) -- The name for one of the listed recommendation templates.
  • nextToken (string) -- Null, or the token from a previous call to get the next set of results.
  • recommendationTemplateArn (string) -- The Amazon Resource Name (ARN) for a recommendation template.
  • reverseOrder (boolean) -- The default is to sort by ascending startTime . To sort by descending startTime , set reverseOrder to true .
  • status (list) --

    The status of the action.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'recommendationTemplates': [
        {
            'appArn': 'string',
            'assessmentArn': 'string',
            'endTime': datetime(2015, 1, 1),
            'format': 'CfnYaml'|'CfnJson',
            'message': 'string',
            'name': 'string',
            'needsReplacements': True|False,
            'recommendationIds': [
                'string',
            ],
            'recommendationTemplateArn': 'string',
            'recommendationTypes': [
                'Alarm'|'Sop'|'Test',
            ],
            'startTime': datetime(2015, 1, 1),
            'status': 'Pending'|'InProgress'|'Failed'|'Success',
            'tags': {
                'string': 'string'
            },
            'templatesLocation': {
                'bucket': 'string',
                'prefix': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      The token for the next set of results, or null if there are no more results.

    • recommendationTemplates (list) --

      The recommendation templates for the AWS Resilience Hub applications.

      • (dict) --

        Defines a recommendation template created with the CreateRecommendationTemplate action.

        • appArn (string) --

          The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

        • assessmentArn (string) --

          The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: partition :resiliencehub: region : account :app-assessment/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

        • endTime (datetime) --

          The end time for the action.

        • format (string) --

          The format of the recommendation template.

          CfnJson

          The template is CloudFormation JSON.

          CfnYaml

          The template is CloudFormation YAML.

        • message (string) --

          The message for the recommendation template.

        • name (string) --

          The name for the recommendation template.

        • needsReplacements (boolean) --

          Indicates if replacements are needed.

        • recommendationIds (list) --

          Identifiers for the recommendations used in the recommendation template.

          • (string) --
        • recommendationTemplateArn (string) --

          The Amazon Resource Name (ARN) for the recommendation template.

        • recommendationTypes (list) --

          An array of strings that specify the recommendation template type or types.

          Alarm

          The template is an AlarmRecommendation template.

          Sop

          The template is a SopRecommendation template.

          Test

          The template is a TestRecommendation template.

          • (string) --
        • startTime (datetime) --

          The start time for the action.

        • status (string) --

          The status of the action.

        • tags (dict) --

          The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

          • (string) --
            • (string) --
        • templatesLocation (dict) --

          The file location of the template.

          • bucket (string) --

            The name of the Amazon S3 bucket.

          • prefix (string) --

            The prefix for the Amazon S3 bucket.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
list_resiliency_policies(**kwargs)

Lists the resiliency policies for the AWS Resilience Hub applications.

See also: AWS API Documentation

Request Syntax

response = client.list_resiliency_policies(
    maxResults=123,
    nextToken='string',
    policyName='string'
)
Parameters
  • maxResults (integer) -- The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • nextToken (string) -- Null, or the token from a previous call to get the next set of results.
  • policyName (string) -- The name of the policy
Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'resiliencyPolicies': [
        {
            'creationTime': datetime(2015, 1, 1),
            'dataLocationConstraint': 'AnyLocation'|'SameContinent'|'SameCountry',
            'estimatedCostTier': 'L1'|'L2'|'L3'|'L4',
            'policy': {
                'string': {
                    'rpoInSecs': 123,
                    'rtoInSecs': 123
                }
            },
            'policyArn': 'string',
            'policyDescription': 'string',
            'policyName': 'string',
            'tags': {
                'string': 'string'
            },
            'tier': 'MissionCritical'|'Critical'|'Important'|'CoreServices'|'NonCritical'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      The token for the next set of results, or null if there are no more results.

    • resiliencyPolicies (list) --

      The resiliency policies for the AWS Resilience Hub applications.

      • (dict) --

        Defines a resiliency policy.

        • creationTime (datetime) --

          The timestamp for when the resiliency policy was created.

        • dataLocationConstraint (string) --

          Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

        • estimatedCostTier (string) --

          Specifies the estimated cost tier of the resiliency policy.

        • policy (dict) --

          The resiliency policy.

          • (string) --

            • (dict) --

              Defines a failure policy.

              • rpoInSecs (integer) --

                The Recovery Point Objective (RPO), in seconds.

              • rtoInSecs (integer) --

                The Recovery Time Objective (RTO), in seconds.

        • policyArn (string) --

          The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: partition :resiliencehub: region : account :resiliency-policy/ policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

        • policyDescription (string) --

          The description for the policy.

        • policyName (string) --

          The name of the policy

        • tags (dict) --

          The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

          • (string) --
            • (string) --
        • tier (string) --

          The tier for this resiliency policy, ranging from the highest severity ( MissionCritical ) to lowest ( NonCritical ).

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
list_sop_recommendations(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_sop_recommendations(
    assessmentArn='string',
    maxResults=123,
    nextToken='string'
)
Parameters
  • assessmentArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: partition :resiliencehub: region : account :app-assessment/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • maxResults (integer) -- The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • nextToken (string) -- Null, or the token from a previous call to get the next set of results.
Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'sopRecommendations': [
        {
            'appComponentName': 'string',
            'description': 'string',
            'items': [
                {
                    'alreadyImplemented': True|False,
                    'resourceId': 'string',
                    'targetAccountId': 'string',
                    'targetRegion': 'string'
                },
            ],
            'name': 'string',
            'prerequisite': 'string',
            'recommendationId': 'string',
            'referenceId': 'string',
            'serviceType': 'SSM'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      The token for the next set of results, or null if there are no more results.

    • sopRecommendations (list) --

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

      • (dict) --

        Defines a standard operating procedure (SOP) recommendation.

        • appComponentName (string) --

          The name of the Application Component.

        • description (string) --

          The description of the SOP recommendation.

        • items (list) --

          The recommendation items.

          • (dict) --

            Defines a recommendation.

            • alreadyImplemented (boolean) --

              Specifies if the recommendation has already been implemented.

            • resourceId (string) --

              The resource identifier.

            • targetAccountId (string) --

              The target account identifier.

            • targetRegion (string) --

              The target region.

        • name (string) --

          The name of the SOP recommendation.

        • prerequisite (string) --

          The prerequisite for the SOP recommendation.

        • recommendationId (string) --

          Identifier for the SOP recommendation.

        • referenceId (string) --

          The reference identifier for the SOP recommendation.

        • serviceType (string) --

          The service type.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
list_suggested_resiliency_policies(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_suggested_resiliency_policies(
    maxResults=123,
    nextToken='string'
)
Parameters
  • maxResults (integer) -- The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • nextToken (string) -- Null, or the token from a previous call to get the next set of results.
Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'resiliencyPolicies': [
        {
            'creationTime': datetime(2015, 1, 1),
            'dataLocationConstraint': 'AnyLocation'|'SameContinent'|'SameCountry',
            'estimatedCostTier': 'L1'|'L2'|'L3'|'L4',
            'policy': {
                'string': {
                    'rpoInSecs': 123,
                    'rtoInSecs': 123
                }
            },
            'policyArn': 'string',
            'policyDescription': 'string',
            'policyName': 'string',
            'tags': {
                'string': 'string'
            },
            'tier': 'MissionCritical'|'Critical'|'Important'|'CoreServices'|'NonCritical'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      The token for the next set of results, or null if there are no more results.

    • resiliencyPolicies (list) --

      The suggested resiliency policies for the AWS Resilience Hub applications.

      • (dict) --

        Defines a resiliency policy.

        • creationTime (datetime) --

          The timestamp for when the resiliency policy was created.

        • dataLocationConstraint (string) --

          Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

        • estimatedCostTier (string) --

          Specifies the estimated cost tier of the resiliency policy.

        • policy (dict) --

          The resiliency policy.

          • (string) --

            • (dict) --

              Defines a failure policy.

              • rpoInSecs (integer) --

                The Recovery Point Objective (RPO), in seconds.

              • rtoInSecs (integer) --

                The Recovery Time Objective (RTO), in seconds.

        • policyArn (string) --

          The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: partition :resiliencehub: region : account :resiliency-policy/ policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

        • policyDescription (string) --

          The description for the policy.

        • policyName (string) --

          The name of the policy

        • tags (dict) --

          The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

          • (string) --
            • (string) --
        • tier (string) --

          The tier for this resiliency policy, ranging from the highest severity ( MissionCritical ) to lowest ( NonCritical ).

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
list_tags_for_resource(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    resourceArn='string'
)
Parameters
resourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) for a specific resource in your AWS Resilience Hub application.

Return type
dict
Returns
Response Syntax
{
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • tags (dict) --

      The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

      • (string) --
        • (string) --

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
list_test_recommendations(**kwargs)

Lists the test recommendations for the AWS Resilience Hub application.

See also: AWS API Documentation

Request Syntax

response = client.list_test_recommendations(
    assessmentArn='string',
    maxResults=123,
    nextToken='string'
)
Parameters
  • assessmentArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: partition :resiliencehub: region : account :app-assessment/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • maxResults (integer) -- The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • nextToken (string) -- Null, or the token from a previous call to get the next set of results.
Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'testRecommendations': [
        {
            'appComponentName': 'string',
            'dependsOnAlarms': [
                'string',
            ],
            'description': 'string',
            'intent': 'string',
            'items': [
                {
                    'alreadyImplemented': True|False,
                    'resourceId': 'string',
                    'targetAccountId': 'string',
                    'targetRegion': 'string'
                },
            ],
            'name': 'string',
            'prerequisite': 'string',
            'recommendationId': 'string',
            'referenceId': 'string',
            'risk': 'Small'|'Medium'|'High',
            'type': 'Software'|'Hardware'|'AZ'|'Region'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      The token for the next set of results, or null if there are no more results.

    • testRecommendations (list) --

      The test recommendations for the AWS Resilience Hub application.

      • (dict) --

        Defines a test recommendation.

        • appComponentName (string) --

          The name of the Application Component.

        • dependsOnAlarms (list) --

          A list of recommended alarms that are used in the test and must be exported before or with the test.

          • (string) --
        • description (string) --

          The description for the test recommendation.

        • intent (string) --

          The intent of the test recommendation.

        • items (list) --

          The test recommendation items.

          • (dict) --

            Defines a recommendation.

            • alreadyImplemented (boolean) --

              Specifies if the recommendation has already been implemented.

            • resourceId (string) --

              The resource identifier.

            • targetAccountId (string) --

              The target account identifier.

            • targetRegion (string) --

              The target region.

        • name (string) --

          The name of the test recommendation.

        • prerequisite (string) --

          The prerequisite of the test recommendation.

        • recommendationId (string) --

          Identifier for the test recommendation.

        • referenceId (string) --

          The reference identifier for the test recommendation.

        • risk (string) --

          The level of risk for this test recommendation.

        • type (string) --

          The type of test recommendation.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
list_unsupported_app_version_resources(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.list_unsupported_app_version_resources(
    appArn='string',
    appVersion='string',
    maxResults=123,
    nextToken='string',
    resolutionId='string'
)
Parameters
  • appArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • appVersion (string) --

    [REQUIRED]

    The version of the application.

  • maxResults (integer) -- The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • nextToken (string) -- Null, or the token from a previous call to get the next set of results.
  • resolutionId (string) -- The identifier for a specific resolution.
Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'resolutionId': 'string',
    'unsupportedResources': [
        {
            'logicalResourceId': {
                'identifier': 'string',
                'logicalStackName': 'string',
                'resourceGroupName': 'string',
                'terraformSourceName': 'string'
            },
            'physicalResourceId': {
                'awsAccountId': 'string',
                'awsRegion': 'string',
                'identifier': 'string',
                'type': 'Arn'|'Native'
            },
            'resourceType': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      The token for the next set of results, or null if there are no more results.

    • resolutionId (string) --

      The identifier for a specific resolution.

    • unsupportedResources (list) --

      The unsupported resources for the application.

      • (dict) --

        Defines a resource that is not supported by AWS Resilience Hub.

        • logicalResourceId (dict) --

          The logical resource identifier for the unsupported resource.

          • identifier (string) --

            The identifier of the resource.

          • logicalStackName (string) --

            The name of the CloudFormation stack this resource belongs to.

          • resourceGroupName (string) --

            The name of the resource group that this resource belongs to.

          • terraformSourceName (string) --

            The name of the Terraform S3 state file this resource belongs to.

        • physicalResourceId (dict) --

          The physical resource identifier for the unsupported resource.

          • awsAccountId (string) --

            The Amazon Web Services account that owns the physical resource.

          • awsRegion (string) --

            The Amazon Web Services Region that the physical resource is located in.

          • identifier (string) --

            The identifier of the physical resource.

          • type (string) --

            Specifies the type of physical resource identifier.

            Arn

            The resource identifier is an Amazon Resource Name (ARN) .

            Native

            The resource identifier is an AWS Resilience Hub-native identifier.

        • resourceType (string) --

          The type of resource.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
publish_app_version(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.publish_app_version(
    appArn='string'
)
Parameters
appArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

Return type
dict
Returns
Response Syntax
{
    'appArn': 'string',
    'appVersion': 'string'
}

Response Structure

  • (dict) --
    • appArn (string) --

      The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

    • appVersion (string) --

      The version of the application.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
put_draft_app_version_template(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.put_draft_app_version_template(
    appArn='string',
    appTemplateBody='string'
)
Parameters
  • appArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • appTemplateBody (string) --

    [REQUIRED]

    A JSON string that provides information about your application structure. To learn more about the appTemplateBody template, see the sample template provided in the Examples section.

    The appTemplateBody JSON string has the following structure:

    • resources The list of logical resources that needs to be included in the application. Type: Array

    Note

    Don't add the resources that you want to exclude.

    Each resources array item includes the following fields:

    • logicalResourceId The logical identifier of the resource. Type: Object Each logicalResourceId object includes the following fields:
      • identifier The identifier of the resource. Type: String
      • logicalStackName The name of the CloudFormation stack this resource belongs to. Type: String
      • resourceGroupName The name of the resource group this resource belongs to. Type: String
      • terraformSourceName The name of the Terraform S3 state file this resource belongs to. Type: String
    • type The type of resource. Type: string
    • name The name of the resource. Type: String
    • appComponents The list of Application Components that this resource belongs to. If an Application Component is not part of the AWS Resilience Hub application, it will be added. Type: Array Each appComponents array item includes the following fields:
      • name The name of the Application Component. Type: String
      • type The type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent. Type: String
      • resourceNames The list of included resources that are assigned to the Application Component. Type: Array of strings
      • additionalInfo Additional configuration parameters for an AWS Resilience Hub application.

      Note

      Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: "failover-regions" Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

    • excludedResources The list of logical resource identifiers to be excluded from the application. Type: Array

    Note

    Don't add the resources that you want to include.

    Each excludedResources array item includes the following fields:

    • logicalResourceIds The logical identifier of the resource. Type: Object

    Note

    You can configure only one of the following fields:

    • logicalStackName
    • resourceGroupName
    • terraformSourceName

    Each logicalResourceIds object includes the following fields:

    • identifier The identifier of the resource. Type: String
    • logicalStackName The name of the CloudFormation stack this resource belongs to. Type: String
    • resourceGroupName The name of the resource group this resource belongs to. Type: String
    • terraformSourceName The name of the Terraform S3 state file this resource belongs to. Type: String
Return type

dict

Returns

Response Syntax

{
    'appArn': 'string',
    'appVersion': 'string'
}

Response Structure

  • (dict) --

    • appArn (string) --

      The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

    • appVersion (string) --

      The version of the application.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
remove_draft_app_version_resource_mappings(**kwargs)

Removes resource mappings from a draft application version.

See also: AWS API Documentation

Request Syntax

response = client.remove_draft_app_version_resource_mappings(
    appArn='string',
    appRegistryAppNames=[
        'string',
    ],
    logicalStackNames=[
        'string',
    ],
    resourceGroupNames=[
        'string',
    ],
    resourceNames=[
        'string',
    ],
    terraformSourceNames=[
        'string',
    ]
)
Parameters
  • appArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • appRegistryAppNames (list) --

    The names of the registered applications you want to remove from the resource mappings.

    • (string) --
  • logicalStackNames (list) --

    The names of the CloudFormation stacks you want to remove from the resource mappings.

    • (string) --
  • resourceGroupNames (list) --

    The names of the resource groups you want to remove from the resource mappings.

    • (string) --
  • resourceNames (list) --

    The names of the resources you want to remove from the resource mappings.

    • (string) --
  • terraformSourceNames (list) --

    The names of the Terraform sources you want to remove from the resource mappings.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'appArn': 'string',
    'appVersion': 'string'
}

Response Structure

  • (dict) --

    • appArn (string) --

      The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

    • appVersion (string) --

      The version of the application.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
resolve_app_version_resources(**kwargs)

Resolves the resources for an application version.

See also: AWS API Documentation

Request Syntax

response = client.resolve_app_version_resources(
    appArn='string',
    appVersion='string'
)
Parameters
  • appArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • appVersion (string) --

    [REQUIRED]

    The version of the application.

Return type

dict

Returns

Response Syntax

{
    'appArn': 'string',
    'appVersion': 'string',
    'resolutionId': 'string',
    'status': 'Pending'|'InProgress'|'Failed'|'Success'
}

Response Structure

  • (dict) --

    • appArn (string) --

      The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

    • appVersion (string) --

      The version of the application.

    • resolutionId (string) --

      The identifier for a specific resolution.

    • status (string) --

      The status of the action.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
start_app_assessment(**kwargs)

Creates a new application assessment for an application.

See also: AWS API Documentation

Request Syntax

response = client.start_app_assessment(
    appArn='string',
    appVersion='string',
    assessmentName='string',
    clientToken='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • appArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • appVersion (string) --

    [REQUIRED]

    The version of the application.

  • assessmentName (string) --

    [REQUIRED]

    The name for the assessment.

  • clientToken (string) --

    Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

    This field is autopopulated if not provided.

  • tags (dict) --

    The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'assessment': {
        'appArn': 'string',
        'appVersion': 'string',
        'assessmentArn': 'string',
        'assessmentName': 'string',
        'assessmentStatus': 'Pending'|'InProgress'|'Failed'|'Success',
        'compliance': {
            'string': {
                'achievableRpoInSecs': 123,
                'achievableRtoInSecs': 123,
                'complianceStatus': 'PolicyBreached'|'PolicyMet',
                'currentRpoInSecs': 123,
                'currentRtoInSecs': 123,
                'message': 'string',
                'rpoDescription': 'string',
                'rpoReferenceId': 'string',
                'rtoDescription': 'string',
                'rtoReferenceId': 'string'
            }
        },
        'complianceStatus': 'PolicyBreached'|'PolicyMet',
        'cost': {
            'amount': 123.0,
            'currency': 'string',
            'frequency': 'Hourly'|'Daily'|'Monthly'|'Yearly'
        },
        'endTime': datetime(2015, 1, 1),
        'invoker': 'User'|'System',
        'message': 'string',
        'policy': {
            'creationTime': datetime(2015, 1, 1),
            'dataLocationConstraint': 'AnyLocation'|'SameContinent'|'SameCountry',
            'estimatedCostTier': 'L1'|'L2'|'L3'|'L4',
            'policy': {
                'string': {
                    'rpoInSecs': 123,
                    'rtoInSecs': 123
                }
            },
            'policyArn': 'string',
            'policyDescription': 'string',
            'policyName': 'string',
            'tags': {
                'string': 'string'
            },
            'tier': 'MissionCritical'|'Critical'|'Important'|'CoreServices'|'NonCritical'
        },
        'resiliencyScore': {
            'disruptionScore': {
                'string': 123.0
            },
            'score': 123.0
        },
        'resourceErrorsDetails': {
            'hasMoreErrors': True|False,
            'resourceErrors': [
                {
                    'logicalResourceId': 'string',
                    'physicalResourceId': 'string',
                    'reason': 'string'
                },
            ]
        },
        'startTime': datetime(2015, 1, 1),
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • assessment (dict) --

      The assessment created.

      • appArn (string) --

        The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

      • appVersion (string) --

        The version of the application.

      • assessmentArn (string) --

        The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: partition :resiliencehub: region : account :app-assessment/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

      • assessmentName (string) --

        The name of the assessment.

      • assessmentStatus (string) --

        The current status of the assessment for the resiliency policy.

      • compliance (dict) --

        The application compliance against the resiliency policy.

        • (string) --

          • (dict) --

            Defines the compliance against the resiliency policy for a disruption.

            • achievableRpoInSecs (integer) --

              The Recovery Point Objective (RPO) that is achievable, in seconds.

            • achievableRtoInSecs (integer) --

              The Recovery Time Objective (RTO) that is achievable, in seconds

            • complianceStatus (string) --

              The current status of compliance for the resiliency policy.

            • currentRpoInSecs (integer) --

              The current RPO, in seconds.

            • currentRtoInSecs (integer) --

              The current RTO, in seconds.

            • message (string) --

              The disruption compliance message.

            • rpoDescription (string) --

              The RPO description.

            • rpoReferenceId (string) --

              The RPO reference identifier.

            • rtoDescription (string) --

              The RTO description.

            • rtoReferenceId (string) --

              The RTO reference identifier.

      • complianceStatus (string) --

        The current status of the compliance for the resiliency policy.

      • cost (dict) --

        The cost for the application.

        • amount (float) --

          The cost amount.

        • currency (string) --

          The cost currency, for example USD .

        • frequency (string) --

          The cost frequency.

      • endTime (datetime) --

        The end time for the action.

      • invoker (string) --

        The entity that invoked the assessment.

      • message (string) --

        Error or warning message from the assessment execution

      • policy (dict) --

        The resiliency policy.

        • creationTime (datetime) --

          The timestamp for when the resiliency policy was created.

        • dataLocationConstraint (string) --

          Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

        • estimatedCostTier (string) --

          Specifies the estimated cost tier of the resiliency policy.

        • policy (dict) --

          The resiliency policy.

          • (string) --

            • (dict) --

              Defines a failure policy.

              • rpoInSecs (integer) --

                The Recovery Point Objective (RPO), in seconds.

              • rtoInSecs (integer) --

                The Recovery Time Objective (RTO), in seconds.

        • policyArn (string) --

          The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: partition :resiliencehub: region : account :resiliency-policy/ policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

        • policyDescription (string) --

          The description for the policy.

        • policyName (string) --

          The name of the policy

        • tags (dict) --

          The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

          • (string) --
            • (string) --
        • tier (string) --

          The tier for this resiliency policy, ranging from the highest severity ( MissionCritical ) to lowest ( NonCritical ).

      • resiliencyScore (dict) --

        The current resiliency score for the application.

        • disruptionScore (dict) --

          The disruption score for a valid key.

          • (string) --
            • (float) --
        • score (float) --

          The outage score for a valid key.

      • resourceErrorsDetails (dict) --

        A resource error object containing a list of errors retrieving an application's resources.

        • hasMoreErrors (boolean) --

          This indicates if there are more errors not listed in the resourceErrors list.

        • resourceErrors (list) --

          A list of errors retrieving an application's resources.

          • (dict) --

            Defines application resource errors.

            • logicalResourceId (string) --

              This is the identifier of the resource.

            • physicalResourceId (string) --

              This is the identifier of the physical resource.

            • reason (string) --

              This is the error message.

      • startTime (datetime) --

        The starting time for the action.

      • tags (dict) --

        The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

        • (string) --
          • (string) --

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ServiceQuotaExceededException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
tag_resource(**kwargs)

Applies one or more tags to a resource.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource.

  • tags (dict) --

    [REQUIRED]

    The tags to assign to the resource. Each tag consists of a key/value pair.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
untag_resource(**kwargs)

Removes one or more tags from a resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource.

  • tagKeys (list) --

    [REQUIRED]

    The keys of the tags you want to remove.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
update_app(**kwargs)

Updates an application.

See also: AWS API Documentation

Request Syntax

response = client.update_app(
    appArn='string',
    assessmentSchedule='Disabled'|'Daily',
    clearResiliencyPolicyArn=True|False,
    description='string',
    policyArn='string'
)
Parameters
  • appArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • assessmentSchedule (string) -- Assessment execution schedule with 'Daily' or 'Disabled' values.
  • clearResiliencyPolicyArn (boolean) -- Specifies if the resiliency policy ARN should be cleared.
  • description (string) -- The optional description for an app.
  • policyArn (string) -- The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: partition :resiliencehub: region : account :resiliency-policy/ policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
Return type

dict

Returns

Response Syntax

{
    'app': {
        'appArn': 'string',
        'assessmentSchedule': 'Disabled'|'Daily',
        'complianceStatus': 'PolicyBreached'|'PolicyMet'|'NotAssessed'|'ChangesDetected',
        'creationTime': datetime(2015, 1, 1),
        'description': 'string',
        'lastAppComplianceEvaluationTime': datetime(2015, 1, 1),
        'lastResiliencyScoreEvaluationTime': datetime(2015, 1, 1),
        'name': 'string',
        'policyArn': 'string',
        'resiliencyScore': 123.0,
        'status': 'Active'|'Deleting',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • app (dict) --

      The specified application, returned as an object with details including compliance status, creation time, description, resiliency score, and more.

      • appArn (string) --

        The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

      • assessmentSchedule (string) --

        Assessment execution schedule with 'Daily' or 'Disabled' values.

      • complianceStatus (string) --

        The current status of compliance for the resiliency policy.

      • creationTime (datetime) --

        The timestamp for when the app was created.

      • description (string) --

        The optional description for an app.

      • lastAppComplianceEvaluationTime (datetime) --

        The timestamp for the most recent compliance evaluation.

      • lastResiliencyScoreEvaluationTime (datetime) --

        The timestamp for the most recent resiliency score evaluation.

      • name (string) --

        The name for the application.

      • policyArn (string) --

        The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: partition :resiliencehub: region : account :resiliency-policy/ policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

      • resiliencyScore (float) --

        The current resiliency score for the application.

      • status (string) --

        The status of the application.

      • tags (dict) --

        The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

        • (string) --
          • (string) --

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
update_app_version(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.update_app_version(
    additionalInfo={
        'string': [
            'string',
        ]
    },
    appArn='string'
)
Parameters
  • additionalInfo (dict) --

    Additional configuration parameters for an AWS Resilience Hub application.

    Note

    Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

    Key: "failover-regions"

    Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

    • (string) --
      • (list) --
        • (string) --
  • appArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

Return type

dict

Returns

Response Syntax

{
    'additionalInfo': {
        'string': [
            'string',
        ]
    },
    'appArn': 'string',
    'appVersion': 'string'
}

Response Structure

  • (dict) --

    • additionalInfo (dict) --

      Additional configuration parameters for an AWS Resilience Hub application.

      Note

      Currently, this parameter supports only failover region and account.

      • (string) --
        • (list) --
          • (string) --
    • appArn (string) --

      The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

    • appVersion (string) --

      The AWS Resilience Hub application version.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
update_app_version_app_component(**kwargs)

Updates an existing 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.

See also: AWS API Documentation

Request Syntax

response = client.update_app_version_app_component(
    additionalInfo={
        'string': [
            'string',
        ]
    },
    appArn='string',
    id='string',
    name='string',
    type='string'
)
Parameters
  • additionalInfo (dict) --

    Currently, there is no supported additional information for Application Components.

    • (string) --
      • (list) --
        • (string) --
  • appArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • id (string) --

    [REQUIRED]

    The identifier of the Application Component.

  • name (string) -- The name of the Application Component.
  • type (string) -- The type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.
Return type

dict

Returns

Response Syntax

{
    'appArn': 'string',
    'appComponent': {
        'additionalInfo': {
            'string': [
                'string',
            ]
        },
        'id': 'string',
        'name': 'string',
        'type': 'string'
    },
    'appVersion': 'string'
}

Response Structure

  • (dict) --

    • appArn (string) --

      The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

    • appComponent (dict) --

      Defines an Application Component.

      • additionalInfo (dict) --

        Additional configuration parameters for an AWS Resilience Hub application.

        Note

        Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

        Key: "failover-regions"

        Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

        • (string) --
          • (list) --
            • (string) --
      • id (string) --

        Unique identifier of the Application Component.

      • name (string) --

        The name of the Application Component.

      • type (string) --

        The type of Application Component.

    • appVersion (string) --

      The AWS Resilience Hub application version.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
update_app_version_resource(**kwargs)

Updates the resource details in the AWS Resilience Hub application.

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.

See also: AWS API Documentation

Request Syntax

response = client.update_app_version_resource(
    additionalInfo={
        'string': [
            'string',
        ]
    },
    appArn='string',
    appComponents=[
        'string',
    ],
    awsAccountId='string',
    awsRegion='string',
    excluded=True|False,
    logicalResourceId={
        'identifier': 'string',
        'logicalStackName': 'string',
        'resourceGroupName': 'string',
        'terraformSourceName': 'string'
    },
    physicalResourceId='string',
    resourceName='string',
    resourceType='string'
)
Parameters
  • additionalInfo (dict) --

    Currently, there is no supported additional information for resources.

    • (string) --
      • (list) --
        • (string) --
  • appArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • appComponents (list) --

    The list of Application Components that this resource belongs to. If an Application Component is not part of the AWS Resilience Hub application, it will be added.

    • (string) --
  • awsAccountId (string) -- The Amazon Web Services account that owns the physical resource.
  • awsRegion (string) -- The Amazon Web Services region that owns the physical resource.
  • excluded (boolean) --

    Indicates if a resource is excluded from an AWS Resilience Hub application.

    Note

    You can exclude only imported resources from an AWS Resilience Hub application.

  • logicalResourceId (dict) --

    The logical identifier of the resource.

    • identifier (string) -- [REQUIRED]

      The identifier of the resource.

    • logicalStackName (string) --

      The name of the CloudFormation stack this resource belongs to.

    • resourceGroupName (string) --

      The name of the resource group that this resource belongs to.

    • terraformSourceName (string) --

      The name of the Terraform S3 state file this resource belongs to.

  • physicalResourceId (string) -- The physical identifier of the resource.
  • resourceName (string) -- The name of the resource.
  • resourceType (string) -- The type of resource.
Return type

dict

Returns

Response Syntax

{
    'appArn': 'string',
    'appVersion': 'string',
    'physicalResource': {
        'additionalInfo': {
            'string': [
                'string',
            ]
        },
        'appComponents': [
            {
                'additionalInfo': {
                    'string': [
                        'string',
                    ]
                },
                'id': 'string',
                'name': 'string',
                'type': 'string'
            },
        ],
        'excluded': True|False,
        'logicalResourceId': {
            'identifier': 'string',
            'logicalStackName': 'string',
            'resourceGroupName': 'string',
            'terraformSourceName': 'string'
        },
        'physicalResourceId': {
            'awsAccountId': 'string',
            'awsRegion': 'string',
            'identifier': 'string',
            'type': 'Arn'|'Native'
        },
        'resourceName': 'string',
        'resourceType': 'string'
    }
}

Response Structure

  • (dict) --

    • appArn (string) --

      The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

    • appVersion (string) --

      The AWS Resilience Hub application version.

    • physicalResource (dict) --

      Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.

      • additionalInfo (dict) --

        Additional configuration parameters for an AWS Resilience Hub application.

        Note

        Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

        Key: "failover-regions"

        Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

        • (string) --
          • (list) --
            • (string) --
      • appComponents (list) --

        The application components that belong to this resource.

        • (dict) --

          Defines an Application Component.

          • additionalInfo (dict) --

            Additional configuration parameters for an AWS Resilience Hub application.

            Note

            Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

            Key: "failover-regions"

            Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

            • (string) --
              • (list) --
                • (string) --
          • id (string) --

            Unique identifier of the Application Component.

          • name (string) --

            The name of the Application Component.

          • type (string) --

            The type of Application Component.

      • excluded (boolean) --

        Indicates if a resource is included or excluded from the assessment.

      • logicalResourceId (dict) --

        The logical identifier of the resource.

        • identifier (string) --

          The identifier of the resource.

        • logicalStackName (string) --

          The name of the CloudFormation stack this resource belongs to.

        • resourceGroupName (string) --

          The name of the resource group that this resource belongs to.

        • terraformSourceName (string) --

          The name of the Terraform S3 state file this resource belongs to.

      • physicalResourceId (dict) --

        The physical identifier of the resource.

        • awsAccountId (string) --

          The Amazon Web Services account that owns the physical resource.

        • awsRegion (string) --

          The Amazon Web Services Region that the physical resource is located in.

        • identifier (string) --

          The identifier of the physical resource.

        • type (string) --

          Specifies the type of physical resource identifier.

          Arn

          The resource identifier is an Amazon Resource Name (ARN) .

          Native

          The resource identifier is an AWS Resilience Hub-native identifier.

      • resourceName (string) --

        The name of the resource.

      • resourceType (string) --

        The type of resource.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ServiceQuotaExceededException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException
update_resiliency_policy(**kwargs)

Updates a resiliency policy.

See also: AWS API Documentation

Request Syntax

response = client.update_resiliency_policy(
    dataLocationConstraint='AnyLocation'|'SameContinent'|'SameCountry',
    policy={
        'string': {
            'rpoInSecs': 123,
            'rtoInSecs': 123
        }
    },
    policyArn='string',
    policyDescription='string',
    policyName='string',
    tier='MissionCritical'|'Critical'|'Important'|'CoreServices'|'NonCritical'
)
Parameters
  • dataLocationConstraint (string) -- Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
  • policy (dict) --

    The type of resiliency policy to be created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.

    • (string) --
      • (dict) --

        Defines a failure policy.

        • rpoInSecs (integer) -- [REQUIRED]

          The Recovery Point Objective (RPO), in seconds.

        • rtoInSecs (integer) -- [REQUIRED]

          The Recovery Time Objective (RTO), in seconds.

  • policyArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: partition :resiliencehub: region : account :resiliency-policy/ policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • policyDescription (string) -- The description for the policy.
  • policyName (string) -- The name of the policy
  • tier (string) -- The tier for this resiliency policy, ranging from the highest severity ( MissionCritical ) to lowest ( NonCritical ).
Return type

dict

Returns

Response Syntax

{
    'policy': {
        'creationTime': datetime(2015, 1, 1),
        'dataLocationConstraint': 'AnyLocation'|'SameContinent'|'SameCountry',
        'estimatedCostTier': 'L1'|'L2'|'L3'|'L4',
        'policy': {
            'string': {
                'rpoInSecs': 123,
                'rtoInSecs': 123
            }
        },
        'policyArn': 'string',
        'policyDescription': 'string',
        'policyName': 'string',
        'tags': {
            'string': 'string'
        },
        'tier': 'MissionCritical'|'Critical'|'Important'|'CoreServices'|'NonCritical'
    }
}

Response Structure

  • (dict) --

    • policy (dict) --

      The type of resiliency policy that was updated, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.

      • creationTime (datetime) --

        The timestamp for when the resiliency policy was created.

      • dataLocationConstraint (string) --

        Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

      • estimatedCostTier (string) --

        Specifies the estimated cost tier of the resiliency policy.

      • policy (dict) --

        The resiliency policy.

        • (string) --

          • (dict) --

            Defines a failure policy.

            • rpoInSecs (integer) --

              The Recovery Point Objective (RPO), in seconds.

            • rtoInSecs (integer) --

              The Recovery Time Objective (RTO), in seconds.

      • policyArn (string) --

        The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: partition :resiliencehub: region : account :resiliency-policy/ policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

      • policyDescription (string) --

        The description for the policy.

      • policyName (string) --

        The name of the policy

      • tags (dict) --

        The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

        • (string) --
          • (string) --
      • tier (string) --

        The tier for this resiliency policy, ranging from the highest severity ( MissionCritical ) to lowest ( NonCritical ).

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException

Paginators

The available paginators are: