delete_app_version_app_component

ResilienceHub.Client.delete_app_version_app_component(**kwargs)

Deletes an Application Component from the AWS Resilience Hub application.

Note

  • This API updates the AWS Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the AWS Resilience Hub application using the PublishAppVersion API.
  • You will not be able to delete an Application Component if it has resources associated with it.

See also: AWS API Documentation

Request Syntax

response = client.delete_app_version_app_component(
    appArn='string',
    clientToken='string',
    id='string'
)
Parameters
  • appArn (string) --

    [REQUIRED]

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

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

    [REQUIRED]

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

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

    • appComponent (dict) --

      Defines an Application Component.

      • additionalInfo (dict) --

        Additional configuration parameters for an AWS Resilience Hub application.

        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 AWS 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