Class: AWS.Resiliencehub

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

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

      • appArn — required — (String)

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

      • assessmentSchedule — (String)

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

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

        The current status of compliance for the resiliency policy.

        Possible values include:
        • "PolicyBreached"
        • "PolicyMet"
        • "NotAssessed"
        • "ChangesDetected"
      • creationTime — required — (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.

      • name — required — (String)

        The name for the application.

      • policyArn — (String)

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

      • resiliencyScore — (Float)

        The current resiliency score for the application.

      • status — (String)

        The status of the application.

        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.

var params = {
  appArn: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  type: 'STRING_VALUE', /* required */
  additionalInfo: {
    '<String128WithoutWhitespace>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<String128WithoutWhitespace>': ... */
  },
  clientToken: 'STRING_VALUE',
  id: 'STRING_VALUE'
};
resiliencehub.createAppVersionAppComponent(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: {}) —
  • additionalInfo — (map<Array<String>>)

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

  • appArn — (String)

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

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

    The identifier of the Application Component.

  • name — (String)

    The name of the Application Component.

  • type — (String)

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

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

    • appComponent — (map)

      The list of Application Components that belong to this resource.

      • additionalInfo — (map<Array<String>>)

        Additional configuration parameters for an AWS Resilience Hub application.

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

        Unique identifier of the Application Component.

      • name — required — (String)

        The name of the Application Component.

      • type — required — (String)

        The type of Application Component.

    • appVersion — (String)

      The AWS Resilience Hub application version.

Returns:

• (AWS.Request) —

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

var params = {
  appArn: 'STRING_VALUE', /* required */
  appComponents: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  logicalResourceId: { /* required */
    identifier: 'STRING_VALUE', /* required */
    eksSourceName: 'STRING_VALUE',
    logicalStackName: 'STRING_VALUE',
    resourceGroupName: 'STRING_VALUE',
    terraformSourceName: 'STRING_VALUE'
  },
  physicalResourceId: 'STRING_VALUE', /* required */
  resourceName: 'STRING_VALUE', /* required */
  resourceType: 'STRING_VALUE', /* required */
  additionalInfo: {
    '<String128WithoutWhitespace>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<String128WithoutWhitespace>': ... */
  },
  awsAccountId: 'STRING_VALUE',
  awsRegion: 'STRING_VALUE',
  clientToken: 'STRING_VALUE'
};
resiliencehub.createAppVersionResource(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: {}) —
  • additionalInfo — (map<Array<String>>)

    Currently, there is no supported additional information for resources.

  • appArn — (String)

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

  • appComponents — (Array<String>)

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

  • awsAccountId — (String)

    The Amazon Web Services account that owns the physical resource.

  • awsRegion — (String)

    The Amazon Web Services region that owns the physical resource.

  • clientToken — (String)

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

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

    The logical identifier of the resource.

    • eksSourceName — (String)

      The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

      Note: This parameter accepts values in "eks-cluster/namespace" format.
    • identifier — required — (String)

      The identifier of the resource.

    • logicalStackName — (String)

      The name of the CloudFormation stack this resource belongs to.

    • resourceGroupName — (String)

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

    • terraformSourceName — (String)

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

  • physicalResourceId — (String)

    The physical identifier of the resource.

  • resourceName — (String)

    The name of the resource.

  • resourceType — (String)

    The type of resource.

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

    • appVersion — (String)

      The AWS Resilience Hub application version.

    • physicalResource — (map)

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

      • additionalInfo — (map<Array<String>>)

        Additional configuration parameters for an AWS Resilience Hub application.

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

        The application components that belong to this resource.

        • additionalInfo — (map<Array<String>>)

          Additional configuration parameters for an AWS Resilience Hub application.

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

          Unique identifier of the Application Component.

        • name — required — (String)

          The name of the Application Component.

        • type — required — (String)

          The type of Application Component.

      • excluded — (Boolean)

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

      • logicalResourceId — required — (map)

        The logical identifier of the resource.

        • eksSourceName — (String)

          The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

          Note: This parameter accepts values in "eks-cluster/namespace" format.
        • identifier — required — (String)

          The identifier of the resource.

        • logicalStackName — (String)

          The name of the CloudFormation stack this resource belongs to.

        • resourceGroupName — (String)

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

        • terraformSourceName — (String)

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

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

        • identifier — required — (String)

          The identifier of the physical resource.

        • type — required — (String)

          Specifies the type of physical resource identifier.

          Arn

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

          Native

          The resource identifier is an Resilience Hub-native identifier.

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

        The name of the resource.

      • resourceType — required — (String)

        The type of resource.

Returns:

• (AWS.Request) —

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

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

  • bucketName — (String)

    The name of the Amazon S3 bucket that will contain the recommendation template.

  • clientToken — (String)

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

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

      • assessmentArn — required — (String)

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

      • endTime — (Date)

        The end time for the action.

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

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

      • recommendationTemplateArn — required — (String)

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

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

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

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.

    • rpoInSecs — required — (Integer)

      The Recovery Point Objective (RPO), in seconds.

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

        • rpoInSecs — required — (Integer)

          The Recovery Point Objective (RPO), in seconds.

        • rtoInSecs — required — (Integer)

          The Recovery Time Objective (RTO), in seconds.

      • policyArn — (String)

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

      • policyDescription — (String)

        The description for the policy.

      • policyName — (String)

        The name of the policy

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

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

  • clientToken — (String)

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

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

    A boolean option to force the deletion of an 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 AWS Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

Returns:

• (AWS.Request) —

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

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

  • clientToken — (String)

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

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

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

var params = {
  appArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  eksSourceClusterNamespace: {
    eksClusterArn: 'STRING_VALUE', /* required */
    namespace: 'STRING_VALUE' /* required */
  },
  sourceArn: 'STRING_VALUE',
  terraformSource: {
    s3StateFileUrl: 'STRING_VALUE' /* required */
  }
};
resiliencehub.deleteAppInputSource(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 AWS Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • clientToken — (String)

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

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

    The namespace on your Amazon Elastic Kubernetes Service cluster that you want to delete from the Resilience Hub application.

    • eksClusterArn — required — (String)

      The Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. The format for this ARN is: arn:aws:eks:region:account-id:cluster/cluster-name. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

    • namespace — required — (String)

      Name of the namespace that is located on your Amazon Elastic Kubernetes Service cluster.

  • sourceArn — (String)

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

  • terraformSource — (map)

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

    • s3StateFileUrl — required — (String)

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

    • appInputSource — (map)

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

      • eksSourceClusterNamespace — (map)

        The namespace on your Amazon Elastic Kubernetes Service cluster.

        • eksClusterArn — required — (String)

          The Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. The format for this ARN is: arn:aws:eks:region:account-id:cluster/cluster-name. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

        • namespace — required — (String)

          Name of the namespace that is located on your Amazon Elastic Kubernetes Service cluster.

      • importType — required — (String)

        The resource type of the input source.

        Possible values include:
        • "CfnStack"
        • "Resource"
        • "AppRegistryApp"
        • "ResourceGroup"
        • "Terraform"
        • "EKS"
      • resourceCount — (Integer)

        The number of resources.

      • sourceArn — (String)

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

      • sourceName — (String)

        The name of the input source.

      • terraformSource — (map)

        The name of the Terraform s3 state file.

        • s3StateFileUrl — required — (String)

          The URL of the Terraform s3 state file you need to import.

Returns:

• (AWS.Request) —

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

var params = {
  appArn: 'STRING_VALUE', /* required */
  id: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
resiliencehub.deleteAppVersionAppComponent(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 AWS Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • clientToken — (String)

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

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

    The identifier of the Application Component.

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

    • appComponent — (map)

      The list of Application Components that belong to this resource.

      • additionalInfo — (map<Array<String>>)

        Additional configuration parameters for an AWS Resilience Hub application.

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

        Unique identifier of the Application Component.

      • name — required — (String)

        The name of the Application Component.

      • type — required — (String)

        The type of Application Component.

    • appVersion — (String)

      The AWS Resilience Hub application version.

Returns:

• (AWS.Request) —

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

var params = {
  appArn: 'STRING_VALUE', /* required */
  awsAccountId: 'STRING_VALUE',
  awsRegion: 'STRING_VALUE',
  clientToken: 'STRING_VALUE',
  logicalResourceId: {
    identifier: 'STRING_VALUE', /* required */
    eksSourceName: 'STRING_VALUE',
    logicalStackName: 'STRING_VALUE',
    resourceGroupName: 'STRING_VALUE',
    terraformSourceName: 'STRING_VALUE'
  },
  physicalResourceId: 'STRING_VALUE',
  resourceName: 'STRING_VALUE'
};
resiliencehub.deleteAppVersionResource(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 AWS Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • awsAccountId — (String)

    The Amazon Web Services account that owns the physical resource.

  • awsRegion — (String)

    The Amazon Web Services region that owns the physical resource.

  • clientToken — (String)

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

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

    The logical identifier of the resource.

    • eksSourceName — (String)

      The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

      Note: This parameter accepts values in "eks-cluster/namespace" format.
    • identifier — required — (String)

      The identifier of the resource.

    • logicalStackName — (String)

      The name of the CloudFormation stack this resource belongs to.

    • resourceGroupName — (String)

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

    • terraformSourceName — (String)

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

  • physicalResourceId — (String)

    The physical identifier of the resource.

  • resourceName — (String)

    The name of the resource.

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

    • appVersion — (String)

      The AWS Resilience Hub application version.

    • physicalResource — (map)

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

      • additionalInfo — (map<Array<String>>)

        Additional configuration parameters for an AWS Resilience Hub application.

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

        The application components that belong to this resource.

        • additionalInfo — (map<Array<String>>)

          Additional configuration parameters for an AWS Resilience Hub application.

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

          Unique identifier of the Application Component.

        • name — required — (String)

          The name of the Application Component.

        • type — required — (String)

          The type of Application Component.

      • excluded — (Boolean)

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

      • logicalResourceId — required — (map)

        The logical identifier of the resource.

        • eksSourceName — (String)

          The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

          Note: This parameter accepts values in "eks-cluster/namespace" format.
        • identifier — required — (String)

          The identifier of the resource.

        • logicalStackName — (String)

          The name of the CloudFormation stack this resource belongs to.

        • resourceGroupName — (String)

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

        • terraformSourceName — (String)

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

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

        • identifier — required — (String)

          The identifier of the physical resource.

        • type — required — (String)

          Specifies the type of physical resource identifier.

          Arn

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

          Native

          The resource identifier is an Resilience Hub-native identifier.

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

        The name of the resource.

      • resourceType — required — (String)

        The type of resource.

Returns:

• (AWS.Request) —

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

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.

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

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

Returns:

• (AWS.Request) —

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

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

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.

      • appArn — required — (String)

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

      • assessmentSchedule — (String)

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

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

        The current status of compliance for the resiliency policy.

        Possible values include:
        • "PolicyBreached"
        • "PolicyMet"
        • "NotAssessed"
        • "ChangesDetected"
      • creationTime — required — (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.

      • name — required — (String)

        The name for the application.

      • policyArn — (String)

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

      • resiliencyScore — (Float)

        The current resiliency score for the application.

      • status — (String)

        The status of the application.

        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.

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

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 Resilience Hub application, returned as an object. This object includes Amazon Resource Names (ARNs), compliance information, compliance status, cost, messages, resiliency scores, and more.

      • appArn — (String)

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

      • appVersion — (String)

        The version of the application.

      • assessmentArn — required — (String)

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

      • assessmentName — (String)

        The name of the assessment.

      • assessmentStatus — required — (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

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

        • amount — required — (Float)

          The cost amount.

        • currency — required — (String)

          The cost currency, for example USD.

        • frequency — required — (String)

          The cost frequency.

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

        The end time for the action.

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

          • rpoInSecs — required — (Integer)

            The Recovery Point Objective (RPO), in seconds.

          • rtoInSecs — required — (Integer)

            The Recovery Time Objective (RTO), in seconds.

        • policyArn — (String)

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

        • policyDescription — (String)

          The description for the policy.

        • policyName — (String)

          The name of the policy

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

        • disruptionScore — required — (map<Float>)

          The disruption score for a valid key.

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

var params = {
  appArn: 'STRING_VALUE', /* required */
  appVersion: 'STRING_VALUE' /* required */
};
resiliencehub.describeAppVersion(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 AWS Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • appVersion — (String)

    The AWS Resilience Hub application version.

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:

    • additionalInfo — (map<Array<String>>)

      Additional configuration parameters for an AWS Resilience Hub application.

      Note: Currently, this parameter supports only failover region and account.
    • appArn — (String)

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

    • appVersion — (String)

      The AWS Resilience Hub application version.

Returns:

• (AWS.Request) —

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

var params = {
  appArn: 'STRING_VALUE', /* required */
  appVersion: 'STRING_VALUE', /* required */
  id: 'STRING_VALUE' /* required */
};
resiliencehub.describeAppVersionAppComponent(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 AWS Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • appVersion — (String)

    The AWS Resilience Hub application version.

  • id — (String)

    The identifier of the Application Component.

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

    • appComponent — (map)

      The list of Application Components that belong to this resource.

      • additionalInfo — (map<Array<String>>)

        Additional configuration parameters for an AWS Resilience Hub application.

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

        Unique identifier of the Application Component.

      • name — required — (String)

        The name of the Application Component.

      • type — required — (String)

        The type of Application Component.

    • appVersion — (String)

      The AWS Resilience Hub application version.

Returns:

• (AWS.Request) —

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

var params = {
  appArn: 'STRING_VALUE', /* required */
  appVersion: 'STRING_VALUE', /* required */
  awsAccountId: 'STRING_VALUE',
  awsRegion: 'STRING_VALUE',
  logicalResourceId: {
    identifier: 'STRING_VALUE', /* required */
    eksSourceName: 'STRING_VALUE',
    logicalStackName: 'STRING_VALUE',
    resourceGroupName: 'STRING_VALUE',
    terraformSourceName: 'STRING_VALUE'
  },
  physicalResourceId: 'STRING_VALUE',
  resourceName: 'STRING_VALUE'
};
resiliencehub.describeAppVersionResource(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 AWS Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • appVersion — (String)

    The AWS Resilience Hub application version.

  • awsAccountId — (String)

    The Amazon Web Services account that owns the physical resource.

  • awsRegion — (String)

    The Amazon Web Services region that owns the physical resource.

  • logicalResourceId — (map)

    The logical identifier of the resource.

    • eksSourceName — (String)

      The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

      Note: This parameter accepts values in "eks-cluster/namespace" format.
    • identifier — required — (String)

      The identifier of the resource.

    • logicalStackName — (String)

      The name of the CloudFormation stack this resource belongs to.

    • resourceGroupName — (String)

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

    • terraformSourceName — (String)

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

  • physicalResourceId — (String)

    The physical identifier of the resource.

  • resourceName — (String)

    The name of the resource.

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

    • appVersion — (String)

      The AWS Resilience Hub application version.

    • physicalResource — (map)

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

      • additionalInfo — (map<Array<String>>)

        Additional configuration parameters for an AWS Resilience Hub application.

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

        The application components that belong to this resource.

        • additionalInfo — (map<Array<String>>)

          Additional configuration parameters for an AWS Resilience Hub application.

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

          Unique identifier of the Application Component.

        • name — required — (String)

          The name of the Application Component.

        • type — required — (String)

          The type of Application Component.

      • excluded — (Boolean)

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

      • logicalResourceId — required — (map)

        The logical identifier of the resource.

        • eksSourceName — (String)

          The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

          Note: This parameter accepts values in "eks-cluster/namespace" format.
        • identifier — required — (String)

          The identifier of the resource.

        • logicalStackName — (String)

          The name of the CloudFormation stack this resource belongs to.

        • resourceGroupName — (String)

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

        • terraformSourceName — (String)

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

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

        • identifier — required — (String)

          The identifier of the physical resource.

        • type — required — (String)

          Specifies the type of physical resource identifier.

          Arn

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

          Native

          The resource identifier is an Resilience Hub-native identifier.

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

        The name of the resource.

      • resourceType — required — (String)

        The type of resource.

Returns:

• (AWS.Request) —

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

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

  • appVersion — (String)

    The version of the application.

  • resolutionId — (String)

    The identifier for a specific resolution.

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

    • appVersion — (String)

      The version of the application.

    • errorMessage — (String)

      The returned error message for the request.

    • resolutionId — (String)

      The identifier for a specific resolution.

    • status — (String)

      The status of the action.

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

Returns:

• (AWS.Request) —

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

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

  • appVersion — (String)

    The version of the application.

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

    • appTemplateBody — (String)

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

      The appTemplateBody JSON string has the following structure:

      • resources

        The list of logical resources that needs to be included in the Resilience Hub application.

        Type: Array

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

        Each resources array item includes the following fields:

        • logicalResourceId

          The logical identifier of the resource.

          Type: Object

          Each logicalResourceId object includes the following fields:

          • identifier

            The identifier of the resource.

            Type: String

          • logicalStackName

            The name of the CloudFormation stack this resource belongs to.

            Type: String

          • resourceGroupName

            The name of the resource group this resource belongs to.

            Type: String

          • terraformSourceName

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

            Type: String

        • type

          The type of resource.

          Type: string

        • name

          The name of the resource.

          Type: String

        • additionalInfo

          Additional configuration parameters for an AWS Resilience Hub application.

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

      • appComponents

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

        Type: Array

        Each appComponents array item includes the following fields:

        • name

          The name of the Application Component.

          Type: String

        • type

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

          Type: String

        • resourceNames

          The list of included resources that are assigned to the Application Component.

          Type: Array of strings

        • additionalInfo

          Additional configuration parameters for an AWS Resilience Hub application.

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

      • excludedResources

        The list of logical resource identifiers to be excluded from the application.

        Type: Array

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

        Each excludedResources array item includes the following fields:

        • logicalResourceIds

          The logical identifier of the resource.

          Type: Object

          Note: You can configure only one of the following fields:

          • logicalStackName
          • resourceGroupName
          • terraformSourceName

          Each logicalResourceIds object includes the following fields:

          • identifier

            The identifier of the resource.

            Type: String

          • logicalStackName

            The name of the CloudFormation stack this resource belongs to.

            Type: String

          • resourceGroupName

            The name of the resource group this resource belongs to.

            Type: String

          • terraformSourceName

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

            Type: String

      • version

        The AWS Resilience Hub application version.

      • additionalInfo

        Additional configuration parameters for an AWS Resilience Hub application.

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

      The version of the application.

Returns:

• (AWS.Request) —

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

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

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

    • appVersion — (String)

      The version of the application.

    • errorMessage — (String)

      The returned error message for the request.

    • status — (String)

      The status of the action.

      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.

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

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.

        • rpoInSecs — required — (Integer)

          The Recovery Point Objective (RPO), in seconds.

        • rtoInSecs — required — (Integer)

          The Recovery Time Objective (RTO), in seconds.

      • policyArn — (String)

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

      • policyDescription — (String)

        The description for the policy.

      • policyName — (String)

        The name of the policy

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

var params = {
  appArn: 'STRING_VALUE', /* required */
  eksSources: [
    {
      eksClusterArn: 'STRING_VALUE', /* required */
      namespaces: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  importStrategy: AddOnly | ReplaceAll,
  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 AWS Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • eksSources — (Array<map>)

    The input sources of the Amazon Elastic Kubernetes Service resources you need to import.

    • eksClusterArn — required — (String)

      The Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. The format for this ARN is: arn:aws:eks:region:account-id:cluster/cluster-name. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

    • namespaces — required — (Array<String>)

      The list of namespaces located on your Amazon Elastic Kubernetes Service cluster.

  • importStrategy — (String)

    The import strategy you would like to set to import resources into Resilience Hub application.

    Possible values include:
    • "AddOnly"
    • "ReplaceAll"
  • sourceArns — (Array<String>)

    The Amazon Resource Names (ARNs) for the resources.

  • terraformSources — (Array<map>)

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

    • s3StateFileUrl — required — (String)

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

    • appVersion — (String)

      The version of the application.

    • eksSources — (Array<map>)

      The input sources of the Amazon Elastic Kubernetes Service resources you have imported.

      • eksClusterArn — required — (String)

        The Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. The format for this ARN is: arn:aws:eks:region:account-id:cluster/cluster-name. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

      • namespaces — required — (Array<String>)

        The list of namespaces located on your Amazon Elastic Kubernetes Service cluster.

    • sourceArns — (Array<String>)

      The Amazon Resource Names (ARNs) for the resources you have 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 have imported.

      • s3StateFileUrl — required — (String)

        The URL of the Terraform s3 state file you need to import.

Returns:

• (AWS.Request) —

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

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

  • maxResults — (Integer)

    The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

  • nextToken — (String)

    Null, or the token from a previous call to get the next set of results.

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

      • name — required — (String)

        The name of the alarm recommendation.

      • prerequisite — (String)

        The prerequisite for the alarm recommendation.

      • recommendationId — required — (String)

        The identifier of the alarm recommendation.

      • referenceId — required — (String)

        The reference identifier of the alarm recommendation.

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

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

  • assessmentName — (String)

    The name for the assessment.

  • assessmentStatus — (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 AWS Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

      • appVersion — (String)

        The version of the application.

      • assessmentArn — required — (String)

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

      • assessmentName — (String)

        The name of the assessment.

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

        • amount — required — (Float)

          The cost amount.

        • currency — required — (String)

          The cost currency, for example USD.

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

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

  • maxResults — (Integer)

    The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

  • nextToken — (String)

    Null, or the token from a previous call to get the next set of results.

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 Resilience Hub Application Component, returned as an object. This object contains the names of the Application Components, compliances, costs, resiliency scores, outage scores, and more.

      • 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

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

        • amount — required — (Float)

          The cost amount.

        • currency — required — (String)

          The cost currency, for example USD.

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

        • disruptionScore — required — (map<Float>)

          The disruption score for a valid key.

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

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

  • maxResults — (Integer)

    The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

  • nextToken — (String)

    Null, or the token from a previous call to get the next set of results.

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 the names of the Application Components, configuration recommendations, and recommendation statuses.

      • appComponentName — required — (String)

        The name of the Application Component.

      • configRecommendations — required — (Array<map>)

        The list of recommendations.

        • appComponentName — (String)

          The name of the Application Component.

        • 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

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

          • amount — required — (Float)

            The cost amount.

          • currency — required — (String)

            The cost currency, for example USD.

          • frequency — required — (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"
        • name — required — (String)

          The name of the recommendation configuration.

        • optimizationType — required — (String)

          The type of optimization.

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

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

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

        • referenceId — required — (String)

          The reference identifier for the recommendation configuration.

        • suggestedChanges — (Array<String>)

          List of the suggested configuration changes.

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

var params = {
  appArn: 'STRING_VALUE', /* required */
  appVersion: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
resiliencehub.listAppInputSources(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 AWS Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • appVersion — (String)

    The AWS Resilience Hub application version.

  • maxResults — (Integer)

    Maximum number of input sources to be displayed per Resilience Hub application.

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

    • appInputSources — (Array<map>)

      The list of Resilience Hub application input sources.

      • eksSourceClusterNamespace — (map)

        The namespace on your Amazon Elastic Kubernetes Service cluster.

        • eksClusterArn — required — (String)

          The Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. The format for this ARN is: arn:aws:eks:region:account-id:cluster/cluster-name. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

        • namespace — required — (String)

          Name of the namespace that is located on your Amazon Elastic Kubernetes Service cluster.

      • importType — required — (String)

        The resource type of the input source.

        Possible values include:
        • "CfnStack"
        • "Resource"
        • "AppRegistryApp"
        • "ResourceGroup"
        • "Terraform"
        • "EKS"
      • resourceCount — (Integer)

        The number of resources.

      • sourceArn — (String)

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

      • sourceName — (String)

        The name of the input source.

      • terraformSource — (map)

        The name of the Terraform s3 state file.

        • s3StateFileUrl — required — (String)

          The URL of the Terraform s3 state file you need to import.

    • nextToken — (String)

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

Returns:

• (AWS.Request) —

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

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

  • maxResults — (Integer)

    The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

  • name — (String)

    The name for the one of the listed applications.

  • nextToken — (String)

    Null, or the token from a previous call to get the next set of results.

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.

      • appArn — required — (String)

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

      • assessmentSchedule — (String)

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

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

        The current status of compliance for the resiliency policy.

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

        The timestamp for when the app was created.

      • description — (String)

        The optional description for an app.

      • name — required — (String)

        The name of the application.

      • resiliencyScore — (Float)

        The current resiliency score for the application.

      • status — (String)

        The status of the application.

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

var params = {
  appArn: 'STRING_VALUE', /* required */
  appVersion: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
resiliencehub.listAppVersionAppComponents(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 AWS Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

  • appVersion — (String)

    The version of the Application Component.

  • maxResults — (Integer)

    Maximum number of Application Components to be displayed per AWS Resilience Hub application version.

  • nextToken — (String)

    Null, or the token from a previous call to get the next set of results.

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

    • appComponents — (Array<map>)

      Defines an Application Component.

      • additionalInfo — (map<Array<String>>)

        Additional configuration parameters for an AWS Resilience Hub application.

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

        Unique identifier of the Application Component.

      • name — required — (String)

        The name of the Application Component.

      • type — required — (String)

        The type of Application Component.

    • appVersion — (String)

      The AWS Resilience Hub application version.

    • nextToken — (String)

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

Returns:

• (AWS.Request) —

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

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

  • appVersion — (String)

    The version of the application.

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

      • eksSourceName — (String)

        The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

        Note: This parameter accepts values in "eks-cluster/namespace" format.
      • logicalStackName — (String)

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

      • mappingType — required — (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 an Resource Groups. The name of the resource group is contained in the resourceGroupName property.

        Possible values include:
        • "CfnStack"
        • "Resource"
        • "AppRegistryApp"
        • "ResourceGroup"
        • "Terraform"
        • "EKS"
      • physicalResourceId — required — (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.

        • identifier — required — (String)

          The identifier of the physical resource.

        • type — required — (String)

          Specifies the type of physical resource identifier.

          Arn

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

          Native

          The resource identifier is an 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.

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

  • appVersion — (String)

    The version of the application.

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

      • additionalInfo — (map<Array<String>>)

        Additional configuration parameters for an AWS Resilience Hub application.

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

        The application components that belong to this resource.

        • additionalInfo — (map<Array<String>>)

          Additional configuration parameters for an AWS Resilience Hub application.

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

          Unique identifier of the Application Component.

        • name — required — (String)

          The name of the Application Component.

        • type — required — (String)

          The type of Application Component.

      • excluded — (Boolean)

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

      • logicalResourceId — required — (map)

        The logical identifier of the resource.

        • eksSourceName — (String)

          The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

          Note: This parameter accepts values in "eks-cluster/namespace" format.
        • identifier — required — (String)

          The identifier of the resource.

        • logicalStackName — (String)

          The name of the CloudFormation stack this resource belongs to.

        • resourceGroupName — (String)

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

        • terraformSourceName — (String)

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

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

        • identifier — required — (String)

          The identifier of the physical resource.

        • type — required — (String)

          Specifies the type of physical resource identifier.

          Arn

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

          Native

          The resource identifier is an Resilience Hub-native identifier.

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

        The name of the resource.

      • resourceType — required — (String)

        The type of resource.

    • resolutionId — (String)

      The ID for a specific resolution.

Returns:

• (AWS.Request) —

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

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

  • maxResults — (Integer)

    The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

  • nextToken — (String)

    Null, or the token from a previous call to get the next set of results.

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.

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

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

  • maxResults — (Integer)

    The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

  • name — (String)

    The name for one of the listed recommendation templates.

  • nextToken — (String)

    Null, or the token from a previous call to get the next set of results.

  • recommendationTemplateArn — (String)

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

  • reverseOrder — (Boolean)

    The default is to sort by ascending startTime. To sort by descending startTime, set reverseOrder to true.

  • status — (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 AWS Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

      • assessmentArn — required — (String)

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

      • endTime — (Date)

        The end time for the action.

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

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

      • recommendationTemplateArn — required — (String)

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

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

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