You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.Resiliencehub

Inherits:
AWS.Service show all
Identifier:
resiliencehub
API Version:
2020-04-30
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using Resiliencehub

var resiliencehub = new AWS.Resiliencehub();
resiliencehub.addDraftAppVersionResourceMappings(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Resiliencehub object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var resiliencehub = new AWS.Resiliencehub({apiVersion: '2020-04-30'});

You can also set the API version globally in AWS.config.apiVersions using the resiliencehub service identifier:

AWS.config.apiVersions = {
  resiliencehub: '2020-04-30',
  // other service API versions
};

var resiliencehub = new AWS.Resiliencehub();

Version:

  • 2020-04-30

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Resiliencehub(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Resiliencehub object

var resiliencehub = new AWS.Resiliencehub({apiVersion: '2020-04-30'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.Resiliencehub.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.Resiliencehub.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.Resiliencehub.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

addDraftAppVersionResourceMappings(params = {}, callback) ⇒ AWS.Request

Adds the resource mapping for the draft application version.

Examples:

Calling the addDraftAppVersionResourceMappings operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  resourceMappings: [ /* required */
    {
      mappingType: CfnStack | Resource | AppRegistryApp | ResourceGroup | Terraform, /* required */
      physicalResourceId: { /* required */
        identifier: 'STRING_VALUE', /* required */
        type: Arn | Native, /* required */
        awsAccountId: 'STRING_VALUE',
        awsRegion: 'STRING_VALUE'
      },
      appRegistryAppName: 'STRING_VALUE',
      logicalStackName: 'STRING_VALUE',
      resourceGroupName: 'STRING_VALUE',
      resourceName: 'STRING_VALUE',
      terraformSourceName: 'STRING_VALUE'
    },
    /* more items */
  ]
};
resiliencehub.addDraftAppVersionResourceMappings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appArn — (String)

      The Amazon Resource Name (ARN) of the 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.

    • resourceMappings — (Array<map>)

      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.

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

      • mappingTyperequired — (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.

        Possible values include:
        • "CfnStack"
        • "Resource"
        • "AppRegistryApp"
        • "ResourceGroup"
        • "Terraform"
      • physicalResourceIdrequired — (map)

        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.

        • identifierrequired — (String)

          The identifier of the physical resource.

        • typerequired — (String)

          Specifies the type of physical resource identifier.

          Arn

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

          Native

          The resource identifier is a Resilience Hub-native identifier.

          Possible values include:
          • "Arn"
          • "Native"
      • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • appArn — (String)

        The Amazon Resource Name (ARN) of the 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.

      • appVersion — (String)

        The version of the application.

      • resourceMappings — (Array<map>)

        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.

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

        • mappingTyperequired — (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.

          Possible values include:
          • "CfnStack"
          • "Resource"
          • "AppRegistryApp"
          • "ResourceGroup"
          • "Terraform"
        • physicalResourceIdrequired — (map)

          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.

          • identifierrequired — (String)

            The identifier of the physical resource.

          • typerequired — (String)

            Specifies the type of physical resource identifier.

            Arn

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

            Native

            The resource identifier is a Resilience Hub-native identifier.

            Possible values include:
            • "Arn"
            • "Native"
        • 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createApp(params = {}, callback) ⇒ AWS.Request

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

 <p>After you create a 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).</p> 

Service Reference:

Examples:

Calling the createApp operation

var params = {
  name: 'STRING_VALUE', /* required */
  assessmentSchedule: Disabled | Daily,
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  policyArn: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
resiliencehub.createApp(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • assessmentSchedule — (String)

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

      Possible values include:
      • "Disabled"
      • "Daily"
    • 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.

      If a token is not provided, the SDK will use a version 4 UUID.
    • description — (String)

      The optional description for an app.

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

    • tags — (map<String>)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • app — (map)

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

        • appArnrequired — (String)

          The Amazon Resource Name (ARN) of the 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.

        • assessmentSchedule — (String)

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

          Possible values include:
          • "Disabled"
          • "Daily"
        • complianceStatus — (String)

          The current status of compliance for the resiliency policy.

          Possible values include:
          • "PolicyBreached"
          • "PolicyMet"
          • "NotAssessed"
          • "ChangesDetected"
        • creationTimerequired — (Date)

          The timestamp for when the app was created.

        • description — (String)

          The optional description for an app.

        • lastAppComplianceEvaluationTime — (Date)

          The timestamp for the most recent compliance evaluation.

        • lastResiliencyScoreEvaluationTime — (Date)

          The timestamp for the most recent resiliency score evaluation.

        • namerequired — (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.

        • resiliencyScore — (Float)

          The current resiliency score for the application.

        • status — (String)

          The status of the action.

          Possible values include:
          • "Active"
          • "Deleting"
        • tags — (map<String>)

          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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createRecommendationTemplate(params = {}, callback) ⇒ AWS.Request

Creates a new recommendation template.

Service Reference:

Examples:

Calling the createRecommendationTemplate operation

var params = {
  assessmentArn: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  bucketName: 'STRING_VALUE',
  clientToken: 'STRING_VALUE',
  format: CfnYaml | CfnJson,
  recommendationIds: [
    'STRING_VALUE',
    /* more items */
  ],
  recommendationTypes: [
    Alarm | Sop | Test,
    /* more items */
  ],
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
resiliencehub.createRecommendationTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • 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.

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

      If a token is not provided, the SDK will use a version 4 UUID.
    • format — (String)

      The format for the recommendation template.

      CfnJson

      The template is CloudFormation JSON.

      CfnYaml

      The template is CloudFormation YAML.

      Possible values include:
      • "CfnYaml"
      • "CfnJson"
    • name — (String)

      The name for the recommendation template.

    • recommendationIds — (Array<String>)

      Identifiers for the recommendations used to create a recommendation template.

    • recommendationTypes — (Array<String>)

      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.

    • tags — (map<String>)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • recommendationTemplate — (map)

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

        • assessmentArnrequired — (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.

        • endTime — (Date)

          The end time for the action.

        • formatrequired — (String)

          The format of the recommendation template.

          CfnJson

          The template is CloudFormation JSON.

          CfnYaml

          The template is CloudFormation YAML.

          Possible values include:
          • "CfnYaml"
          • "CfnJson"
        • message — (String)

          The message for the recommendation template.

        • namerequired — (String)

          The name for the recommendation template.

        • needsReplacements — (Boolean)

          Indicates if replacements are needed.

        • recommendationIds — (Array<String>)

          Identifiers for the recommendations used in the recommendation template.

        • recommendationTemplateArnrequired — (String)

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

        • recommendationTypesrequired — (Array<String>)

          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.

        • startTime — (Date)

          The start time for the action.

        • statusrequired — (String)

          The status of the action.

          Possible values include:
          • "Pending"
          • "InProgress"
          • "Failed"
          • "Success"
        • tags — (map<String>)

          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.

        • templatesLocation — (map)

          The file location of the template.

          • bucket — (String)

            The name of the Amazon S3 bucket.

          • prefix — (String)

            The prefix for the Amazon S3 bucket.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createResiliencyPolicy(params = {}, callback) ⇒ AWS.Request

Creates a resiliency policy for an application.

Service Reference:

Examples:

Calling the createResiliencyPolicy operation

var params = {
  policy: { /* required */
    '<DisruptionType>': {
      rpoInSecs: 'NUMBER_VALUE', /* required */
      rtoInSecs: 'NUMBER_VALUE' /* required */
    },
    /* '<DisruptionType>': ... */
  },
  policyName: 'STRING_VALUE', /* required */
  tier: MissionCritical | Critical | Important | CoreServices | NonCritical, /* required */
  clientToken: 'STRING_VALUE',
  dataLocationConstraint: AnyLocation | SameContinent | SameCountry,
  policyDescription: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
resiliencehub.createResiliencyPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • 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.

      If a token is not provided, the SDK will use a version 4 UUID.
    • dataLocationConstraint — (String)

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

      Possible values include:
      • "AnyLocation"
      • "SameContinent"
      • "SameCountry"
    • policy — (map<map>)

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

      • rpoInSecsrequired — (Integer)

        The Recovery Point Objective (RPO), in seconds.

      • rtoInSecsrequired — (Integer)

        The Recovery Time Objective (RTO), in seconds.

    • policyDescription — (String)

      The description for the policy.

    • policyName — (String)

      The name of the policy

    • tags — (map<String>)

      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.

    • tier — (String)

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

      Possible values include:
      • "MissionCritical"
      • "Critical"
      • "Important"
      • "CoreServices"
      • "NonCritical"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • policy — (map)

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

        • creationTime — (Date)

          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.

          Possible values include:
          • "AnyLocation"
          • "SameContinent"
          • "SameCountry"
        • estimatedCostTier — (String)

          Specifies the estimated cost tier of the resiliency policy.

          Possible values include:
          • "L1"
          • "L2"
          • "L3"
          • "L4"
        • policy — (map<map>)

          The resiliency policy.

          • rpoInSecsrequired — (Integer)

            The Recovery Point Objective (RPO), in seconds.

          • rtoInSecsrequired — (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.

        • policyDescription — (String)

          The description for the policy.

        • policyName — (String)

          The name of the policy

        • tags — (map<String>)

          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.

        • tier — (String)

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

          Possible values include:
          • "MissionCritical"
          • "Critical"
          • "Important"
          • "CoreServices"
          • "NonCritical"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteApp(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteApp operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  forceDelete: true || false
};
resiliencehub.deleteApp(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appArn — (String)

      The Amazon Resource Name (ARN) of the 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.

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

      If a token is not provided, the SDK will use a version 4 UUID.
    • forceDelete — (Boolean)

      A boolean option to force the deletion of a Resilience Hub application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • appArn — (String)

        The Amazon Resource Name (ARN) of the 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteAppAssessment(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteAppAssessment operation

var params = {
  assessmentArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
resiliencehub.deleteAppAssessment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • 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.

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

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

      • assessmentStatus — (String)

        The current status of the assessment for the resiliency policy.

        Possible values include:
        • "Pending"
        • "InProgress"
        • "Failed"
        • "Success"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteRecommendationTemplate(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteRecommendationTemplate operation

var params = {
  recommendationTemplateArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
resiliencehub.deleteRecommendationTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • 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.

      If a token is not provided, the SDK will use a version 4 UUID.
    • recommendationTemplateArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • recommendationTemplateArn — (String)

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

      • status — (String)

        The status of the action.

        Possible values include:
        • "Pending"
        • "InProgress"
        • "Failed"
        • "Success"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteResiliencyPolicy(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteResiliencyPolicy operation

var params = {
  policyArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
resiliencehub.deleteResiliencyPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • 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.

      If a token is not provided, the SDK will use a version 4 UUID.
    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeApp(params = {}, callback) ⇒ AWS.Request

Describes an AWS Resilience Hub application.

Service Reference:

Examples:

Calling the describeApp operation

var params = {
  appArn: 'STRING_VALUE' /* required */
};
resiliencehub.describeApp(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appArn — (String)

      The Amazon Resource Name (ARN) of the 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • app — (map)

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

        • appArnrequired — (String)

          The Amazon Resource Name (ARN) of the 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.

        • assessmentSchedule — (String)

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

          Possible values include:
          • "Disabled"
          • "Daily"
        • complianceStatus — (String)

          The current status of compliance for the resiliency policy.

          Possible values include:
          • "PolicyBreached"
          • "PolicyMet"
          • "NotAssessed"
          • "ChangesDetected"
        • creationTimerequired — (Date)

          The timestamp for when the app was created.

        • description — (String)

          The optional description for an app.

        • lastAppComplianceEvaluationTime — (Date)

          The timestamp for the most recent compliance evaluation.

        • lastResiliencyScoreEvaluationTime — (Date)

          The timestamp for the most recent resiliency score evaluation.

        • namerequired — (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.

        • resiliencyScore — (Float)

          The current resiliency score for the application.

        • status — (String)

          The status of the action.

          Possible values include:
          • "Active"
          • "Deleting"
        • tags — (map<String>)

          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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeAppAssessment(params = {}, callback) ⇒ AWS.Request

Describes an assessment for an AWS Resilience Hub application.

Service Reference:

Examples:

Calling the describeAppAssessment operation

var params = {
  assessmentArn: 'STRING_VALUE' /* required */
};
resiliencehub.describeAppAssessment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • assessment — (map)

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

        • appVersion — (String)

          The version of the application.

        • assessmentArnrequired — (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.

        • assessmentName — (String)

          The name of the assessment.

        • assessmentStatusrequired — (String)

          The current status of the assessment for the resiliency policy.

          Possible values include:
          • "Pending"
          • "InProgress"
          • "Failed"
          • "Success"
        • compliance — (map<map>)

          The application compliance against the resiliency policy.

          • achievableRpoInSecs — (Integer)

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

          • achievableRtoInSecs — (Integer)

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

          • complianceStatusrequired — (String)

            The current status of compliance for the resiliency policy.

            Possible values include:
            • "PolicyBreached"
            • "PolicyMet"
          • 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.

          Possible values include:
          • "PolicyBreached"
          • "PolicyMet"
        • cost — (map)

          The cost for the application.

          • amountrequired — (Float)

            The cost amount.

          • currencyrequired — (String)

            The cost currency, for example USD.

          • frequencyrequired — (String)

            The cost frequency.

            Possible values include:
            • "Hourly"
            • "Daily"
            • "Monthly"
            • "Yearly"
        • endTime — (Date)

          The end time for the action.

        • invokerrequired — (String)

          The entity that invoked the assessment.

          Possible values include:
          • "User"
          • "System"
        • message — (String)

          Error or warning message from the assessment execution

        • policy — (map)

          The resiliency policy.

          • creationTime — (Date)

            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.

            Possible values include:
            • "AnyLocation"
            • "SameContinent"
            • "SameCountry"
          • estimatedCostTier — (String)

            Specifies the estimated cost tier of the resiliency policy.

            Possible values include:
            • "L1"
            • "L2"
            • "L3"
            • "L4"
          • policy — (map<map>)

            The resiliency policy.

            • rpoInSecsrequired — (Integer)

              The Recovery Point Objective (RPO), in seconds.

            • rtoInSecsrequired — (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.

          • policyDescription — (String)

            The description for the policy.

          • policyName — (String)

            The name of the policy

          • tags — (map<String>)

            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.

          • tier — (String)

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

            Possible values include:
            • "MissionCritical"
            • "Critical"
            • "Important"
            • "CoreServices"
            • "NonCritical"
        • resiliencyScore — (map)

          The current resiliency score for the application.

          • disruptionScorerequired — (map<Float>)

            The disruption score for a valid key.

          • scorerequired — (Float)

            The outage score for a valid key.

        • resourceErrorsDetails — (map)

          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 — (Array<map>)

            A list of errors retrieving an application's resources.

            • 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 — (Date)

          The starting time for the action.

        • tags — (map<String>)

          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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeAppVersionResourcesResolutionStatus(params = {}, callback) ⇒ AWS.Request

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

Examples:

Calling the describeAppVersionResourcesResolutionStatus operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  appVersion: 'STRING_VALUE', /* required */
  resolutionId: 'STRING_VALUE'
};
resiliencehub.describeAppVersionResourcesResolutionStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appArn — (String)

      The Amazon Resource Name (ARN) of the 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.

    • appVersion — (String)

      The version of the application.

    • resolutionId — (String)

      The identifier for a specific resolution.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • appArn — (String)

        The Amazon Resource Name (ARN) of the 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.

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

        Possible values include:
        • "Pending"
        • "InProgress"
        • "Failed"
        • "Success"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeAppVersionTemplate(params = {}, callback) ⇒ AWS.Request

Describes details about an AWS Resilience Hub

Service Reference:

Examples:

Calling the describeAppVersionTemplate operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  appVersion: 'STRING_VALUE' /* required */
};
resiliencehub.describeAppVersionTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appArn — (String)

      The Amazon Resource Name (ARN) of the 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.

    • appVersion — (String)

      The version of the application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • appArn — (String)

        The Amazon Resource Name (ARN) of the 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.

      • appTemplateBody — (String)

        The body of the template.

      • appVersion — (String)

        The version of the application.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeDraftAppVersionResourcesImportStatus(params = {}, callback) ⇒ AWS.Request

Describes the status of importing resources to an application version.

Examples:

Calling the describeDraftAppVersionResourcesImportStatus operation

var params = {
  appArn: 'STRING_VALUE' /* required */
};
resiliencehub.describeDraftAppVersionResourcesImportStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appArn — (String)

      The Amazon Resource Name (ARN) of the 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • appArn — (String)

        The Amazon Resource Name (ARN) of the 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.

      • appVersion — (String)

        The version of the application.

      • errorMessage — (String)

        The returned error message for the request.

      • status — (String)

        The status of the action.

        Possible values include:
        • "Pending"
        • "InProgress"
        • "Failed"
        • "Success"
      • statusChangeTime — (Date)

        The timestamp for when the status last changed.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeResiliencyPolicy(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeResiliencyPolicy operation

var params = {
  policyArn: 'STRING_VALUE' /* required */
};
resiliencehub.describeResiliencyPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • policy — (map)

        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 — (Date)

          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.

          Possible values include:
          • "AnyLocation"
          • "SameContinent"
          • "SameCountry"
        • estimatedCostTier — (String)

          Specifies the estimated cost tier of the resiliency policy.

          Possible values include:
          • "L1"
          • "L2"
          • "L3"
          • "L4"
        • policy — (map<map>)

          The resiliency policy.

          • rpoInSecsrequired — (Integer)

            The Recovery Point Objective (RPO), in seconds.

          • rtoInSecsrequired — (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.

        • policyDescription — (String)

          The description for the policy.

        • policyName — (String)

          The name of the policy

        • tags — (map<String>)

          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.

        • tier — (String)

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

          Possible values include:
          • "MissionCritical"
          • "Critical"
          • "Important"
          • "CoreServices"
          • "NonCritical"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

importResourcesToDraftAppVersion(params = {}, callback) ⇒ AWS.Request

Imports resources from sources such as a CloudFormation stack, resource-groups, or application registry app to a draft application version.

Examples:

Calling the importResourcesToDraftAppVersion operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  sourceArns: [
    'STRING_VALUE',
    /* more items */
  ],
  terraformSources: [
    {
      s3StateFileUrl: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
resiliencehub.importResourcesToDraftAppVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appArn — (String)

      The Amazon Resource Name (ARN) of the 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.

    • sourceArns — (Array<String>)

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

    • terraformSources — (Array<map>)

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

      • s3StateFileUrlrequired — (String)

        The Terraform s3 state file you need to import.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • appArn — (String)

        The Amazon Resource Name (ARN) of the 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.

      • appVersion — (String)

        The version of the application.

      • sourceArns — (Array<String>)

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

      • status — (String)

        The status of the action.

        Possible values include:
        • "Pending"
        • "InProgress"
        • "Failed"
        • "Success"
      • terraformSources — (Array<map>)

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

        • s3StateFileUrlrequired — (String)

          The Terraform s3 state file you need to import.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listAlarmRecommendations(params = {}, callback) ⇒ AWS.Request

Lists the alarm recommendations for a AWS Resilience Hub application.

Service Reference:

Examples:

Calling the listAlarmRecommendations operation

var params = {
  assessmentArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
resiliencehub.listAlarmRecommendations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • 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.

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • alarmRecommendations — (Array<map>)

        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.

        • appComponentName — (String)

          The application component for the CloudWatch alarm recommendation.

        • description — (String)

          The description of the recommendation.

        • items — (Array<map>)

          The list of CloudWatch alarm recommendations.

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

        • namerequired — (String)

          The name of the alarm recommendation.

        • prerequisite — (String)

          The prerequisite for the alarm recommendation.

        • recommendationIdrequired — (String)

          The identifier of the alarm recommendation.

        • referenceIdrequired — (String)

          The reference identifier of the alarm recommendation.

        • typerequired — (String)

          The type of alarm recommendation.

          Possible values include:
          • "Metric"
          • "Composite"
          • "Canary"
          • "Logs"
          • "Event"
      • nextToken — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listAppAssessments(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listAppAssessments operation

var params = {
  appArn: 'STRING_VALUE',
  assessmentName: 'STRING_VALUE',
  assessmentStatus: [
    Pending | InProgress | Failed | Success,
    /* more items */
  ],
  complianceStatus: PolicyBreached | PolicyMet,
  invoker: User | System,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  reverseOrder: true || false
};
resiliencehub.listAppAssessments(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appArn — (String)

      The Amazon Resource Name (ARN) of the 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.

    • assessmentName — (String)

      The name for the assessment.

    • assessmentStatus — (Array<String>)

      The current status of the assessment for the resiliency policy.

    • complianceStatus — (String)

      The current status of compliance for the resiliency policy.

      Possible values include:
      • "PolicyBreached"
      • "PolicyMet"
    • invoker — (String)

      Specifies the entity that invoked a specific assessment, either a User or the System.

      Possible values include:
      • "User"
      • "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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • assessmentSummaries — (Array<map>)

        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.

        • appArn — (String)

          The Amazon Resource Name (ARN) of the 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.

        • appVersion — (String)

          The version of the application.

        • assessmentArnrequired — (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.

        • assessmentName — (String)

          The name of the assessment.

        • assessmentStatusrequired — (String)

          The current status of the assessment for the resiliency policy.

          Possible values include:
          • "Pending"
          • "InProgress"
          • "Failed"
          • "Success"
        • complianceStatus — (String)

          The current status of compliance for the resiliency policy.

          Possible values include:
          • "PolicyBreached"
          • "PolicyMet"
        • cost — (map)

          The cost for the application.

          • amountrequired — (Float)

            The cost amount.

          • currencyrequired — (String)

            The cost currency, for example USD.

          • frequencyrequired — (String)

            The cost frequency.

            Possible values include:
            • "Hourly"
            • "Daily"
            • "Monthly"
            • "Yearly"
        • endTime — (Date)

          The end time for the action.

        • invoker — (String)

          The entity that invoked the assessment.

          Possible values include:
          • "User"
          • "System"
        • message — (String)

          The message from the assessment run.

        • resiliencyScore — (Float)

          The current resiliency score for the application.

        • startTime — (Date)

          The starting time for the action.

      • nextToken — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listAppComponentCompliances(params = {}, callback) ⇒ AWS.Request

Lists the compliances for an AWS Resilience Hub component.

Service Reference:

Examples:

Calling the listAppComponentCompliances operation

var params = {
  assessmentArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
resiliencehub.listAppComponentCompliances(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • 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.

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • componentCompliances — (Array<map>)

        The compliances for an AWS Resilience Hub application component, returned as an object. This object contains component names, compliances, costs, resiliency scores, outage scores, and more.

        • appComponentName — (String)

          The name of the application component.

        • compliance — (map<map>)

          The compliance of the application component against the resiliency policy.

          • achievableRpoInSecs — (Integer)

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

          • achievableRtoInSecs — (Integer)

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

          • complianceStatusrequired — (String)

            The current status of compliance for the resiliency policy.

            Possible values include:
            • "PolicyBreached"
            • "PolicyMet"
          • 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 — (map)

          The cost for the application.

          • amountrequired — (Float)

            The cost amount.

          • currencyrequired — (String)

            The cost currency, for example USD.

          • frequencyrequired — (String)

            The cost frequency.

            Possible values include:
            • "Hourly"
            • "Daily"
            • "Monthly"
            • "Yearly"
        • message — (String)

          The compliance message.

        • resiliencyScore — (map)

          The current resiliency score for the application.

          • disruptionScorerequired — (map<Float>)

            The disruption score for a valid key.

          • scorerequired — (Float)

            The outage score for a valid key.

        • status — (String)

          The status of the action.

          Possible values include:
          • "PolicyBreached"
          • "PolicyMet"
      • nextToken — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listAppComponentRecommendations(params = {}, callback) ⇒ AWS.Request

Lists the recommendations for an AWS Resilience Hub component.

Service Reference:

Examples:

Calling the listAppComponentRecommendations operation

var params = {
  assessmentArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
resiliencehub.listAppComponentRecommendations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • 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.

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • componentRecommendations — (Array<map>)

        The recommendations for an Resilience Hub application component, returned as an object. This object contains component names, configuration recommendations, and recommendation statuses.

        • appComponentNamerequired — (String)

          The name of the application component.

        • configRecommendationsrequired — (Array<map>)

          The list of recommendations.

          • appComponentName — (String)

            The application component name.

          • compliance — (map<map>)

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

            • achievableRpoInSecs — (Integer)

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

            • achievableRtoInSecs — (Integer)

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

            • complianceStatusrequired — (String)

              The current status of compliance for the resiliency policy.

              Possible values include:
              • "PolicyBreached"
              • "PolicyMet"
            • 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 — (map)

            The cost for the application.

            • amountrequired — (Float)

              The cost amount.

            • currencyrequired — (String)

              The cost currency, for example USD.

            • frequencyrequired — (String)

              The cost frequency.

              Possible values include:
              • "Hourly"
              • "Daily"
              • "Monthly"
              • "Yearly"
          • description — (String)

            The optional description for an app.

          • haArchitecture — (String)

            The architecture type.

            Possible values include:
            • "MultiSite"
            • "WarmStandby"
            • "PilotLight"
            • "BackupAndRestore"
            • "NoRecoveryPlan"
          • namerequired — (String)

            The name of the recommendation configuration.

          • optimizationTyperequired — (String)

            The type of optimization.

            Possible values include:
            • "LeastCost"
            • "LeastChange"
            • "BestAZRecovery"
            • "LeastErrors"
            • "BestAttainable"
          • recommendationCompliance — (map<map>)

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

            • expectedComplianceStatusrequired — (String)

              The expected compliance status after applying the recommended configuration change.

              Possible values include:
              • "PolicyBreached"
              • "PolicyMet"
            • 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.

          • referenceIdrequired — (String)

            The reference identifier for the recommendation configuration.

          • suggestedChanges — (Array<String>)

            List of the suggested configuration changes.

        • recommendationStatusrequired — (String)

          The recommendation status.

          Possible values include:
          • "BreachedUnattainable"
          • "BreachedCanMeet"
          • "MetCanImprove"
      • nextToken — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listApps(params = {}, callback) ⇒ AWS.Request

Lists your Resilience Hub applications.

Service Reference:

Examples:

Calling the listApps operation

var params = {
  appArn: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  name: 'STRING_VALUE',
  nextToken: 'STRING_VALUE'
};
resiliencehub.listApps(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appArn — (String)

      The Amazon Resource Name (ARN) of the 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.

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • appSummaries — (Array<map>)

        Summaries for the Resilience Hub application.

        • appArnrequired — (String)

          The Amazon Resource Name (ARN) of the 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.

        • assessmentSchedule — (String)

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

          Possible values include:
          • "Disabled"
          • "Daily"
        • complianceStatus — (String)

          The current status of compliance for the resiliency policy.

          Possible values include:
          • "PolicyBreached"
          • "PolicyMet"
          • "NotAssessed"
          • "ChangesDetected"
        • creationTimerequired — (Date)

          The timestamp for when the app was created.

        • description — (String)

          The optional description for an app.

        • namerequired — (String)

          The name of the application.

        • resiliencyScore — (Float)

          The current resiliency score for the application.

      • nextToken — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listAppVersionResourceMappings(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listAppVersionResourceMappings operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  appVersion: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
resiliencehub.listAppVersionResourceMappings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appArn — (String)

      The Amazon Resource Name (ARN) of the 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.

    • appVersion — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

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

      • resourceMappings — (Array<map>)

        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.

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

        • mappingTyperequired — (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.

          Possible values include:
          • "CfnStack"
          • "Resource"
          • "AppRegistryApp"
          • "ResourceGroup"
          • "Terraform"
        • physicalResourceIdrequired — (map)

          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.

          • identifierrequired — (String)

            The identifier of the physical resource.

          • typerequired — (String)

            Specifies the type of physical resource identifier.

            Arn

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

            Native

            The resource identifier is a Resilience Hub-native identifier.

            Possible values include:
            • "Arn"
            • "Native"
        • 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listAppVersionResources(params = {}, callback) ⇒ AWS.Request

Lists all the resources in an application version.

Service Reference:

Examples:

Calling the listAppVersionResources operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  appVersion: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  resolutionId: 'STRING_VALUE'
};
resiliencehub.listAppVersionResources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appArn — (String)

      The Amazon Resource Name (ARN) of the 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.

    • appVersion — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

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

      • physicalResources — (Array<map>)

        The physical resources in the application version.

        • appComponents — (Array<map>)

          The application components that belong to this resource.

          • namerequired — (String)

            The name of the application component.

          • typerequired — (String)

            The type of application component.

        • logicalResourceIdrequired — (map)

          The logical identifier of the resource.

          • identifierrequired — (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.

        • physicalResourceIdrequired — (map)

          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.

          • identifierrequired — (String)

            The identifier of the physical resource.

          • typerequired — (String)

            Specifies the type of physical resource identifier.

            Arn

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

            Native

            The resource identifier is a Resilience Hub-native identifier.

            Possible values include:
            • "Arn"
            • "Native"
        • resourceName — (String)

          The name of the resource.

        • resourceTyperequired — (String)

          The type of resource.

      • resolutionId — (String)

        The identifier for a specific resolution.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listAppVersions(params = {}, callback) ⇒ AWS.Request

Lists the different versions for the Resilience Hub applications.

Service Reference:

Examples:

Calling the listAppVersions operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
resiliencehub.listAppVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appArn — (String)

      The Amazon Resource Name (ARN) of the 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.

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • appVersions — (Array<map>)

        The version of the application.

        • appVersionrequired — (String)

          The version of the application.

      • nextToken — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listRecommendationTemplates(params = {}, callback) ⇒ AWS.Request

Lists the recommendation templates for the Resilience Hub applications.

Service Reference:

Examples:

Calling the listRecommendationTemplates operation

var params = {
  assessmentArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  name: 'STRING_VALUE',
  nextToken: 'STRING_VALUE',
  recommendationTemplateArn: 'STRING_VALUE',
  reverseOrder: true || false,
  status: [
    Pending | InProgress | Failed | Success,
    /* more items */
  ]
};
resiliencehub.listRecommendationTemplates(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • 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.

    • 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 — (Array<String>)

      The status of the action.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

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

      • recommendationTemplates — (Array<map>)

        The recommendation templates for the Resilience Hub applications.

        • appArn — (String)

          The Amazon Resource Name (ARN) of the 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.

        • assessmentArnrequired — (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.

        • endTime — (Date)

          The end time for the action.

        • formatrequired — (String)

          The format of the recommendation template.

          CfnJson

          The template is CloudFormation JSON.

          CfnYaml

          The template is CloudFormation YAML.

          Possible values include:
          • "CfnYaml"
          • "CfnJson"
        • message — (String)

          The message for the recommendation template.

        • namerequired — (String)

          The name for the recommendation template.

        • needsReplacements — (Boolean)

          Indicates if replacements are needed.

        • recommendationIds — (Array<String>)

          Identifiers for the recommendations used in the recommendation template.

        • recommendationTemplateArnrequired — (String)

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

        • recommendationTypesrequired — (Array<String>)

          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.

        • startTime — (Date)

          The start time for the action.

        • statusrequired — (String)

          The status of the action.

          Possible values include:
          • "Pending"
          • "InProgress"
          • "Failed"
          • "Success"
        • tags — (map<String>)

          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.

        • templatesLocation — (map)

          The file location of the template.

          • bucket — (String)

            The name of the Amazon S3 bucket.

          • prefix — (String)

            The prefix for the Amazon S3 bucket.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listResiliencyPolicies(params = {}, callback) ⇒ AWS.Request

Lists the resiliency policies for the Resilience Hub applications.

Service Reference:

Examples:

Calling the listResiliencyPolicies operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  policyName: 'STRING_VALUE'
};
resiliencehub.listResiliencyPolicies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • 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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

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

      • resiliencyPolicies — (Array<map>)

        The resiliency policies for the Resilience Hub applications.

        • creationTime — (Date)

          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.

          Possible values include:
          • "AnyLocation"
          • "SameContinent"
          • "SameCountry"
        • estimatedCostTier — (String)

          Specifies the estimated cost tier of the resiliency policy.

          Possible values include:
          • "L1"
          • "L2"
          • "L3"
          • "L4"
        • policy — (map<map>)

          The resiliency policy.

          • rpoInSecsrequired — (Integer)

            The Recovery Point Objective (RPO), in seconds.

          • rtoInSecsrequired — (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.

        • policyDescription — (String)

          The description for the policy.

        • policyName — (String)

          The name of the policy

        • tags — (map<String>)

          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.

        • tier — (String)

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

          Possible values include:
          • "MissionCritical"
          • "Critical"
          • "Important"
          • "CoreServices"
          • "NonCritical"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listSopRecommendations(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listSopRecommendations operation

var params = {
  assessmentArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
resiliencehub.listSopRecommendations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • 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.

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

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

      • sopRecommendations — (Array<map>)

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

        • appComponentName — (String)

          The application component name.

        • description — (String)

          The description of the SOP recommendation.

        • items — (Array<map>)

          The recommendation items.

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

        • recommendationIdrequired — (String)

          Identifier for the SOP recommendation.

        • referenceIdrequired — (String)

          The reference identifier for the SOP recommendation.

        • serviceTyperequired — (String)

          The service type.

          Possible values include:
          • "SSM"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listSuggestedResiliencyPolicies(params = {}, callback) ⇒ AWS.Request

Lists the suggested resiliency policies for the Resilience Hub applications.

Service Reference:

Examples:

Calling the listSuggestedResiliencyPolicies operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
resiliencehub.listSuggestedResiliencyPolicies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

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

      • resiliencyPolicies — (Array<map>)

        The suggested resiliency policies for the Resilience Hub applications.

        • creationTime — (Date)

          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.

          Possible values include:
          • "AnyLocation"
          • "SameContinent"
          • "SameCountry"
        • estimatedCostTier — (String)

          Specifies the estimated cost tier of the resiliency policy.

          Possible values include:
          • "L1"
          • "L2"
          • "L3"
          • "L4"
        • policy — (map<map>)

          The resiliency policy.

          • rpoInSecsrequired — (Integer)

            The Recovery Point Objective (RPO), in seconds.

          • rtoInSecsrequired — (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.

        • policyDescription — (String)

          The description for the policy.

        • policyName — (String)

          The name of the policy

        • tags — (map<String>)

          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.

        • tier — (String)

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

          Possible values include:
          • "MissionCritical"
          • "Critical"
          • "Important"
          • "CoreServices"
          • "NonCritical"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
resiliencehub.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • tags — (map<String>)

        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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTestRecommendations(params = {}, callback) ⇒ AWS.Request

Lists the test recommendations for the Resilience Hub application.

Service Reference:

Examples:

Calling the listTestRecommendations operation

var params = {
  assessmentArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
resiliencehub.listTestRecommendations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • 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.

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

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

      • testRecommendations — (Array<map>)

        The test recommendations for the Resilience Hub application.

        • appComponentName — (String)

          The name of the application component.

        • dependsOnAlarms — (Array<String>)

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

        • description — (String)

          The description for the test recommendation.

        • intent — (String)

          The intent of the test recommendation.

        • items — (Array<map>)

          The test recommendation items.

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

        • referenceIdrequired — (String)

          The reference identifier for the test recommendation.

        • risk — (String)

          The level of risk for this test recommendation.

          Possible values include:
          • "Small"
          • "Medium"
          • "High"
        • type — (String)

          The type of test recommendation.

          Possible values include:
          • "Software"
          • "Hardware"
          • "AZ"
          • "Region"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listUnsupportedAppVersionResources(params = {}, callback) ⇒ AWS.Request

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 Resilience Hub.

Examples:

Calling the listUnsupportedAppVersionResources operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  appVersion: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  resolutionId: 'STRING_VALUE'
};
resiliencehub.listUnsupportedAppVersionResources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appArn — (String)

      The Amazon Resource Name (ARN) of the 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.

    • appVersion — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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 — (Array<map>)

        The unsupported resources for the application.

        • logicalResourceIdrequired — (map)

          The logical resource identifier for the unsupported resource.

          • identifierrequired — (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.

        • physicalResourceIdrequired — (map)

          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.

          • identifierrequired — (String)

            The identifier of the physical resource.

          • typerequired — (String)

            Specifies the type of physical resource identifier.

            Arn

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

            Native

            The resource identifier is a Resilience Hub-native identifier.

            Possible values include:
            • "Arn"
            • "Native"
        • resourceTyperequired — (String)

          The type of resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

publishAppVersion(params = {}, callback) ⇒ AWS.Request

Publishes a new version of a specific Resilience Hub application.

Service Reference:

Examples:

Calling the publishAppVersion operation

var params = {
  appArn: 'STRING_VALUE' /* required */
};
resiliencehub.publishAppVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appArn — (String)

      The Amazon Resource Name (ARN) of the 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • appArn — (String)

        The Amazon Resource Name (ARN) of the 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.

      • appVersion — (String)

        The version of the application.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putDraftAppVersionTemplate(params = {}, callback) ⇒ AWS.Request

Adds or updates the app template for a draft version of a Resilience Hub app.

Service Reference:

Examples:

Calling the putDraftAppVersionTemplate operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  appTemplateBody: 'STRING_VALUE' /* required */
};
resiliencehub.putDraftAppVersionTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appArn — (String)

      The Amazon Resource Name (ARN) of the 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.

    • appTemplateBody — (String)

      A JSON string that contains the body of the app template.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • appArn — (String)

        The Amazon Resource Name (ARN) of the 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.

      • appVersion — (String)

        The version of the application.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

removeDraftAppVersionResourceMappings(params = {}, callback) ⇒ AWS.Request

Removes resource mappings from a draft application version.

Examples:

Calling the removeDraftAppVersionResourceMappings operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  appRegistryAppNames: [
    'STRING_VALUE',
    /* more items */
  ],
  logicalStackNames: [
    'STRING_VALUE',
    /* more items */
  ],
  resourceGroupNames: [
    'STRING_VALUE',
    /* more items */
  ],
  resourceNames: [
    'STRING_VALUE',
    /* more items */
  ],
  terraformSourceNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
resiliencehub.removeDraftAppVersionResourceMappings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appArn — (String)

      The Amazon Resource Name (ARN) of the 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.

    • appRegistryAppNames — (Array<String>)

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

    • logicalStackNames — (Array<String>)

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

    • resourceGroupNames — (Array<String>)

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

    • resourceNames — (Array<String>)

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

    • terraformSourceNames — (Array<String>)

      </p> 

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • appArn — (String)

        The Amazon Resource Name (ARN) of the 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.

      • appVersion — (String)

        The version of the application.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

resolveAppVersionResources(params = {}, callback) ⇒ AWS.Request

Resolves the resources for an application version.

Service Reference:

Examples:

Calling the resolveAppVersionResources operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  appVersion: 'STRING_VALUE' /* required */
};
resiliencehub.resolveAppVersionResources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appArn — (String)

      The Amazon Resource Name (ARN) of the 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.

    • appVersion — (String)

      The version of the application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • appArn — (String)

        The Amazon Resource Name (ARN) of the 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.

      • appVersion — (String)

        The version of the application.

      • resolutionId — (String)

        The identifier for a specific resolution.

      • status — (String)

        The status of the action.

        Possible values include:
        • "Pending"
        • "InProgress"
        • "Failed"
        • "Success"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startAppAssessment(params = {}, callback) ⇒ AWS.Request

Creates a new application assessment for an application.

Service Reference:

Examples:

Calling the startAppAssessment operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  appVersion: 'STRING_VALUE', /* required */
  assessmentName: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
resiliencehub.startAppAssessment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appArn — (String)

      The Amazon Resource Name (ARN) of the 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.

    • appVersion — (String)

      The version of the application.

    • assessmentName — (String)

      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.

      If a token is not provided, the SDK will use a version 4 UUID.
    • tags — (map<String>)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • assessment — (map)

        The assessment created.

        • appArn — (String)

          The Amazon Resource Name (ARN) of the 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.

        • appVersion — (String)

          The version of the application.

        • assessmentArnrequired — (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.

        • assessmentName — (String)

          The name of the assessment.

        • assessmentStatusrequired — (String)

          The current status of the assessment for the resiliency policy.

          Possible values include:
          • "Pending"
          • "InProgress"
          • "Failed"
          • "Success"
        • compliance — (map<map>)

          The application compliance against the resiliency policy.

          • achievableRpoInSecs — (Integer)

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

          • achievableRtoInSecs — (Integer)

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

          • complianceStatusrequired — (String)

            The current status of compliance for the resiliency policy.

            Possible values include:
            • "PolicyBreached"
            • "PolicyMet"
          • 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.

          Possible values include:
          • "PolicyBreached"
          • "PolicyMet"
        • cost — (map)

          The cost for the application.

          • amountrequired — (Float)

            The cost amount.

          • currencyrequired — (String)

            The cost currency, for example USD.

          • frequencyrequired — (String)

            The cost frequency.

            Possible values include:
            • "Hourly"
            • "Daily"
            • "Monthly"
            • "Yearly"
        • endTime — (Date)

          The end time for the action.

        • invokerrequired — (String)

          The entity that invoked the assessment.

          Possible values include:
          • "User"
          • "System"
        • message — (String)

          Error or warning message from the assessment execution

        • policy — (map)

          The resiliency policy.

          • creationTime — (Date)

            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.

            Possible values include:
            • "AnyLocation"
            • "SameContinent"
            • "SameCountry"
          • estimatedCostTier — (String)

            Specifies the estimated cost tier of the resiliency policy.

            Possible values include:
            • "L1"
            • "L2"
            • "L3"
            • "L4"
          • policy — (map<map>)

            The resiliency policy.

            • rpoInSecsrequired — (Integer)

              The Recovery Point Objective (RPO), in seconds.

            • rtoInSecsrequired — (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.

          • policyDescription — (String)

            The description for the policy.

          • policyName — (String)

            The name of the policy

          • tags — (map<String>)

            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.

          • tier — (String)

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

            Possible values include:
            • "MissionCritical"
            • "Critical"
            • "Important"
            • "CoreServices"
            • "NonCritical"
        • resiliencyScore — (map)

          The current resiliency score for the application.

          • disruptionScorerequired — (map<Float>)

            The disruption score for a valid key.

          • scorerequired — (Float)

            The outage score for a valid key.

        • resourceErrorsDetails — (map)

          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 — (Array<map>)

            A list of errors retrieving an application's resources.

            • 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 — (Date)

          The starting time for the action.

        • tags — (map<String>)

          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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Applies one or more tags to a resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
resiliencehub.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

    • tags — (map<String>)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes one or more tags from a resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
resiliencehub.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

    • tagKeys — (Array<String>)

      The keys of the tags to remove.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateApp(params = {}, callback) ⇒ AWS.Request

Updates an application.

Service Reference:

Examples:

Calling the updateApp operation

var params = {
  appArn: 'STRING_VALUE', /* required */
  assessmentSchedule: Disabled | Daily,
  clearResiliencyPolicyArn: true || false,
  description: 'STRING_VALUE',
  policyArn: 'STRING_VALUE'
};
resiliencehub.updateApp(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appArn — (String)

      The Amazon Resource Name (ARN) of the 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.

    • assessmentSchedule — (String)

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

      Possible values include:
      • "Disabled"
      • "Daily"
    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • app — (map)

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

        • appArnrequired — (String)

          The Amazon Resource Name (ARN) of the 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.

        • assessmentSchedule — (String)

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

          Possible values include:
          • "Disabled"
          • "Daily"
        • complianceStatus — (String)

          The current status of compliance for the resiliency policy.

          Possible values include:
          • "PolicyBreached"
          • "PolicyMet"
          • "NotAssessed"
          • "ChangesDetected"
        • creationTimerequired — (Date)

          The timestamp for when the app was created.

        • description — (String)

          The optional description for an app.

        • lastAppComplianceEvaluationTime — (Date)

          The timestamp for the most recent compliance evaluation.

        • lastResiliencyScoreEvaluationTime — (Date)

          The timestamp for the most recent resiliency score evaluation.

        • namerequired — (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.

        • resiliencyScore — (Float)

          The current resiliency score for the application.

        • status — (String)

          The status of the action.

          Possible values include:
          • "Active"
          • "Deleting"
        • tags — (map<String>)

          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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateResiliencyPolicy(params = {}, callback) ⇒ AWS.Request

Updates a resiliency policy.

Service Reference:

Examples:

Calling the updateResiliencyPolicy operation

var params = {
  policyArn: 'STRING_VALUE', /* required */
  dataLocationConstraint: AnyLocation | SameContinent | SameCountry,
  policy: {
    '<DisruptionType>': {
      rpoInSecs: 'NUMBER_VALUE', /* required */
      rtoInSecs: 'NUMBER_VALUE' /* required */
    },
    /* '<DisruptionType>': ... */
  },
  policyDescription: 'STRING_VALUE',
  policyName: 'STRING_VALUE',
  tier: MissionCritical | Critical | Important | CoreServices | NonCritical
};
resiliencehub.updateResiliencyPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • dataLocationConstraint — (String)

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

      Possible values include:
      • "AnyLocation"
      • "SameContinent"
      • "SameCountry"
    • policy — (map<map>)

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

      • rpoInSecsrequired — (Integer)

        The Recovery Point Objective (RPO), in seconds.

      • rtoInSecsrequired — (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.

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

      Possible values include:
      • "MissionCritical"
      • "Critical"
      • "Important"
      • "CoreServices"
      • "NonCritical"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • policy — (map)

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

        • creationTime — (Date)

          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.

          Possible values include:
          • "AnyLocation"
          • "SameContinent"
          • "SameCountry"
        • estimatedCostTier — (String)

          Specifies the estimated cost tier of the resiliency policy.

          Possible values include:
          • "L1"
          • "L2"
          • "L3"
          • "L4"
        • policy — (map<map>)

          The resiliency policy.

          • rpoInSecsrequired — (Integer)

            The Recovery Point Objective (RPO), in seconds.

          • rtoInSecsrequired — (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.

        • policyDescription — (String)

          The description for the policy.

        • policyName — (String)

          The name of the policy

        • tags — (map<String>)

          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.

        • tier — (String)

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

          Possible values include:
          • "MissionCritical"
          • "Critical"
          • "Important"
          • "CoreServices"
          • "NonCritical"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.