---
title: "POST /describe-app-version-resource"
method: POST
path: "/describe-app-version-resource"
---

# POST /describe-app-version-resource

`POST /describe-app-version-resource`

Describes a resource of the Resilience Hub application.

This API accepts only one of the following parameters to describe the resource:

*   `resourceName`
    
*   `logicalResourceId`
    
*   `physicalResourceId` (Along with `physicalResourceId`, you can also provide `awsAccountId`, and `awsRegion`)

## Request body

- object
  - `appArn` string, required — Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html"> Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i> guide.
  - `appVersion` string, required — Resilience Hub application version.
  - `awsAccountId` string — Amazon Web Services account that owns the physical resource.
  - `awsRegion` string — Amazon Web Services region that owns the physical resource.
  - `logicalResourceId` object — Defines a logical resource identifier.
    - `eksSourceName` string — <p>Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.</p> <note> <p>This parameter accepts values in "eks-cluster/namespace" format.</p> </note>
    - `identifier` string — 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 — Physical identifier of the resource.
  - `resourceName` string — Name of the resource.

## Response `200`

Success

- DescribeAppVersionResourceResponse
  - `appArn` string, required — Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html"> Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i> guide.
  - `appVersion` string, required — Resilience Hub application version.
  - `physicalResource` object — 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` object — <p>Additional configuration parameters for an Resilience Hub application. If you want to implement <code>additionalInfo</code> through the Resilience Hub console rather than using an API call, see <a href="https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html">Configure the application configuration parameters</a>.</p> <note> <p>Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.</p> <p>Key: <code>"failover-regions"</code> </p> <p>Value: <code>"[{"region":"&lt;REGION&gt;", "accounts":[{"id":"&lt;ACCOUNT_ID&gt;"}]}]"</code> </p> </note>
    - `appComponents` AppComponent[] — The application components that belong to this resource.
      - `additionalInfo` object — <p>Additional configuration parameters for an Resilience Hub application. If you want to implement <code>additionalInfo</code> through the Resilience Hub console rather than using an API call, see <a href="https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html">Configure the application configuration parameters</a>.</p> <note> <p>Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.</p> <p>Key: <code>"failover-regions"</code> </p> <p>Value: <code>"[{"region":"&lt;REGION&gt;", "accounts":[{"id":"&lt;ACCOUNT_ID&gt;"}]}]"</code> </p> </note>
      - `id` string — Identifier of the Application Component.
      - `name` string, required — Name of the Application Component.
      - `type` string, required — The type of Application Component.
    - `excluded` boolean — Indicates if a resource is included or excluded from the assessment.
    - `logicalResourceId` object, required — Logical identifier of the resource.
      - `eksSourceName` string — <p>Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.</p> <note> <p>This parameter accepts values in "eks-cluster/namespace" format.</p> </note>
      - `identifier` string, required — 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.
    - `parentResourceName` string — Name of the parent resource.
    - `physicalResourceId` object, required — Identifier of the physical resource.
      - `awsAccountId` string — The Amazon Web Services account that owns the physical resource.
      - `awsRegion` string — The Amazon Web Services Region that the physical resource is located in.
      - `identifier` string, required — Identifier of the physical resource.
      - `type` 'Arn' | 'Native', required — <p>Specifies the type of physical resource identifier.</p> <dl> <dt>Arn</dt> <dd> <p>The resource identifier is an Amazon Resource Name (ARN) and it can identify the following list of resources:</p> <ul> <li> <p> <code>AWS::ECS::Service</code> </p> </li> <li> <p> <code>AWS::EFS::FileSystem</code> </p> </li> <li> <p> <code>AWS::ElasticLoadBalancingV2::LoadBalancer</code> </p> </li> <li> <p> <code>AWS::Lambda::Function</code> </p> </li> <li> <p> <code>AWS::SNS::Topic</code> </p> </li> </ul> </dd> <dt>Native</dt> <dd> <p>The resource identifier is an Resilience Hub-native identifier and it can identify the following list of resources:</p> <ul> <li> <p> <code>AWS::ApiGateway::RestApi</code> </p> </li> <li> <p> <code>AWS::ApiGatewayV2::Api</code> </p> </li> <li> <p> <code>AWS::AutoScaling::AutoScalingGroup</code> </p> </li> <li> <p> <code>AWS::DocDB::DBCluster</code> </p> </li> <li> <p> <code>AWS::DocDB::DBGlobalCluster</code> </p> </li> <li> <p> <code>AWS::DocDB::DBInstance</code> </p> </li> <li> <p> <code>AWS::DynamoDB::GlobalTable</code> </p> </li> <li> <p> <code>AWS::DynamoDB::Table</code> </p> </li> <li> <p> <code>AWS::EC2::EC2Fleet</code> </p> </li> <li> <p> <code>AWS::EC2::Instance</code> </p> </li> <li> <p> <code>AWS::EC2::NatGateway</code> </p> </li> <li> <p> <code>AWS::EC2::Volume</code> </p> </li> <li> <p> <code>AWS::ElasticLoadBalancing::LoadBalancer</code> </p> </li> <li> <p> <code>AWS::RDS::DBCluster</code> </p> </li> <li> <p> <code>AWS::RDS::DBInstance</code> </p> </li> <li> <p> <code>AWS::RDS::GlobalCluster</code> </p> </li> <li> <p> <code>AWS::Route53::RecordSet</code> </p> </li> <li> <p> <code>AWS::S3::Bucket</code> </p> </li> <li> <p> <code>AWS::SQS::Queue</code> </p> </li> </ul> </dd> </dl>
    - `resourceName` string — The name of the resource.
    - `resourceType` string, required — Type of resource.
    - `sourceType` 'AppTemplate' | 'Discovered' — Type of input source.

## Other responses

- `480` — InternalServerException
- `481` — ResourceNotFoundException
- `482` — ConflictException
- `483` — ThrottlingException
- `484` — ValidationException
- `485` — AccessDeniedException

---

[API](https://skmtc.net/aws/apis/resiliencehub.md) · [All operations](https://skmtc.net/aws/apis/resiliencehub/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/resiliencehub/versions/163b82209f70/schema)