ResilienceHub / Client / describe_app_version_app_component

describe_app_version_app_component#

ResilienceHub.Client.describe_app_version_app_component(**kwargs)#

Describes an Application Component in the Resilience Hub application.

See also: AWS API Documentation

Request Syntax

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

  • appArn (string) –

    [REQUIRED]

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

  • appVersion (string) –

    [REQUIRED]

    Resilience Hub application version.

  • id (string) –

    [REQUIRED]

    Identifier of the Application Component.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • appArn (string) –

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

    • appComponent (dict) –

      List of Application Components that belong to this resource.

      • additionalInfo (dict) –

        Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

        Note

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

        Key: "failover-regions"

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

        • (string) –

          • (list) –

            • (string) –

      • id (string) –

        Identifier of the Application Component.

      • name (string) –

        Name of the Application Component.

      • type (string) –

        The type of Application Component.

    • appVersion (string) –

      Resilience Hub application version.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException

  • ResilienceHub.Client.exceptions.ResourceNotFoundException

  • ResilienceHub.Client.exceptions.ConflictException

  • ResilienceHub.Client.exceptions.ThrottlingException

  • ResilienceHub.Client.exceptions.ValidationException

  • ResilienceHub.Client.exceptions.AccessDeniedException