ResilienceHub / Client / delete_app_version_resource

delete_app_version_resource#

ResilienceHub.Client.delete_app_version_resource(**kwargs)#

Deletes a resource from the Resilience Hub application.

Note

You can only delete a manually added resource. To exclude non-manually added resources, use the UpdateAppVersionResource API.
This action has no effect outside Resilience Hub.
This API updates the Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the Resilience Hub application using the PublishAppVersion API.

Request Syntax

response = client.delete_app_version_resource(
    appArn='string',
    awsAccountId='string',
    awsRegion='string',
    clientToken='string',
    logicalResourceId={
        'eksSourceName': 'string',
        'identifier': 'string',
        'logicalStackName': 'string',
        'resourceGroupName': 'string',
        'terraformSourceName': 'string'
    },
    physicalResourceId='string',
    resourceName='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.
awsAccountId (string) – The Amazon Web Services account that owns the physical resource.
awsRegion (string) – The Amazon Web Services region that owns the physical resource.
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.
logicalResourceId (dict) –
The logical identifier of the resource.
- eksSourceName (string) –
  
  The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
  
  Note
  This parameter accepts values in “eks-cluster/namespace” format.
- identifier (string) – [REQUIRED]
  
  The identifier of the resource.
- logicalStackName (string) –
  
  The name of the CloudFormation stack this resource belongs to.
- resourceGroupName (string) –
  
  The name of the resource group that this resource belongs to.
- terraformSourceName (string) –
  
  The name of the Terraform S3 state file this resource belongs to.
physicalResourceId (string) – The physical identifier of the resource.
resourceName (string) – The name of the resource.

Return type:

dict

Returns:

Response Syntax

{
    'appArn': 'string',
    'appVersion': 'string',
    'physicalResource': {
        'additionalInfo': {
            'string': [
                'string',
            ]
        },
        'appComponents': [
            {
                'additionalInfo': {
                    'string': [
                        'string',
                    ]
                },
                'id': 'string',
                'name': 'string',
                'type': 'string'
            },
        ],
        'excluded': True|False,
        'logicalResourceId': {
            'eksSourceName': 'string',
            'identifier': 'string',
            'logicalStackName': 'string',
            'resourceGroupName': 'string',
            'terraformSourceName': 'string'
        },
        'parentResourceName': 'string',
        'physicalResourceId': {
            'awsAccountId': 'string',
            'awsRegion': 'string',
            'identifier': 'string',
            'type': 'Arn'|'Native'
        },
        'resourceName': 'string',
        'resourceType': 'string',
        'sourceType': 'AppTemplate'|'Discovered'
    }
}

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.
- appVersion (string) –
  
  The Resilience Hub application version.
- physicalResource (dict) –
  
  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.
  - 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) –
  - appComponents (list) –
    
    The application components that belong to this resource.
    - (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.
  - excluded (boolean) –
    
    Indicates if a resource is included or excluded from the assessment.
  - logicalResourceId (dict) –
    
    The logical identifier of the resource.
    - eksSourceName (string) –
      
      The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
      
      Note
      This parameter accepts values in “eks-cluster/namespace” format.
    - identifier (string) –
      
      The identifier of the resource.
    - logicalStackName (string) –
      
      The name of the CloudFormation stack this resource belongs to.
    - resourceGroupName (string) –
      
      The name of the resource group that this resource belongs to.
    - terraformSourceName (string) –
      
      The name of the Terraform S3 state file this resource belongs to.
  - parentResourceName (string) –
    
    The name of the parent resource.
  - physicalResourceId (dict) –
    
    The physical identifier of the resource.
    - awsAccountId (string) –
      
      The Amazon Web Services account that owns the physical resource.
    - awsRegion (string) –
      
      The Amazon Web Services Region that the physical resource is located in.
    - identifier (string) –
      
      The identifier of the physical resource.
    - type (string) –
      
      Specifies the type of physical resource identifier.
      
      Arn
      
      The resource identifier is an Amazon Resource Name (ARN) .
      
      Native
      
      The resource identifier is an Resilience Hub-native identifier.
  - resourceName (string) –
    
    The name of the resource.
  - resourceType (string) –
    
    The type of resource.
  - sourceType (string) –
    
    The type of input source.

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