ResilienceHub / Client / create_app_version_app_component

create_app_version_app_component#

ResilienceHub.Client.create_app_version_app_component(**kwargs)#

Creates a new Application Component in the Resilience Hub application.

Note

This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API.

See also: AWS API Documentation

Request Syntax

response = client.create_app_version_app_component(
    additionalInfo={
        'string': [
            'string',
        ]
    },
    appArn='string',
    clientToken='string',
    id='string',
    name='string',
    type='string'
)
Parameters:

  • additionalInfo (dict) –

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

    • (string) –

      • (list) –

        • (string) –

  • 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 Amazon Web Services 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.

    This field is autopopulated if not provided.

  • id (string) – Identifier of the Application Component.

  • name (string) –

    [REQUIRED]

    Name of the Application Component.

  • type (string) –

    [REQUIRED]

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

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 Amazon Web Services 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