Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeAppVersionResource

Describes a resource of the AWS Resilience Hub application.

Note

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 Syntax


POST /describe-app-version-resource HTTP/1.1
Content-type: application/json

{
   "appArn": "string",
   "appVersion": "string",
   "awsAccountId": "string",
   "awsRegion": "string",
   "logicalResourceId": { 
      "eksSourceName": "string",
      "identifier": "string",
      "logicalStackName": "string",
      "resourceGroupName": "string",
      "terraformSourceName": "string"
   },
   "physicalResourceId": "string",
   "resourceName": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

appArn

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.

Type: String

Pattern: ^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}$

Required: Yes

appVersion

AWS Resilience Hub application version.

Type: String

Pattern: ^\S{1,50}$

Required: Yes

awsAccountId

AWS account that owns the physical resource.

Type: String

Pattern: ^[0-9]{12}$

Required: No

awsRegion

AWS region that owns the physical resource.

Type: String

Pattern: ^[a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]$

Required: No

logicalResourceId

Logical identifier of the resource.

Type: LogicalResourceId object

Required: No

physicalResourceId

Physical identifier of the resource.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

resourceName

Name of the resource.

Type: String

Pattern: ^[A-Za-z0-9][A-Za-z0-9_\-]{1,59}$

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "appArn": "string",
   "appVersion": "string",
   "physicalResource": { 
      "additionalInfo": { 
         "string" : [ "string" ]
      },
      "appComponents": [ 
         { 
            "additionalInfo": { 
               "string" : [ "string" ]
            },
            "id": "string",
            "name": "string",
            "type": "string"
         }
      ],
      "excluded": boolean,
      "logicalResourceId": { 
         "eksSourceName": "string",
         "identifier": "string",
         "logicalStackName": "string",
         "resourceGroupName": "string",
         "terraformSourceName": "string"
      },
      "parentResourceName": "string",
      "physicalResourceId": { 
         "awsAccountId": "string",
         "awsRegion": "string",
         "identifier": "string",
         "type": "string"
      },
      "resourceName": "string",
      "resourceType": "string",
      "sourceType": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

appArn

Type: String

appVersion

AWS Resilience Hub application version.

Type: String

Pattern: ^\S{1,50}$

physicalResource

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.

Type: PhysicalResource object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

HTTP Status Code: 403

ConflictException

This exception occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

HTTP Status Code: 409

InternalServerException

This exception occurs when there is an internal failure in the AWS Resilience Hub service.

HTTP Status Code: 500

ResourceNotFoundException

This exception occurs when the specified resource could not be found.

HTTP Status Code: 404

ThrottlingException

This exception occurs when you have exceeded the limit on the number of requests per second.

HTTP Status Code: 429

ValidationException

This exception occurs when a request is not valid.

HTTP Status Code: 400