ResilienceHub / Client / list_app_version_app_components

list_app_version_app_components#

ResilienceHub.Client.list_app_version_app_components(**kwargs)#

Lists all the Application Components in the Resilience Hub application.

See also: AWS API Documentation

Request Syntax

response = client.list_app_version_app_components(
    appArn='string',
    appVersion='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • appArn (string) –

    [REQUIRED]

    The 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]

    The version of the Application Component.

  • maxResults (integer) – Maximum number of Application Components to be displayed per Resilience Hub application version.

  • nextToken (string) – Null, or the token from a previous call to get the next set of results.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • appArn (string) –

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

    • appComponents (list) –

      Defines an Application Component.

      • (dict) –

        Defines an Application Component.

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

          Unique identifier of the Application Component.

        • name (string) –

          The name of the Application Component.

        • type (string) –

          The type of Application Component.

    • appVersion (string) –

      The Resilience Hub application version.

    • nextToken (string) –

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

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