AWS API Changes

2023/02/21 - AWS Resilience Hub - 13 new 2 updated api methods

Changes In this release we improved resilience hub application creation and maintenance by introducing new resource and app component crud APIs, improving visibility and maintenance of application input sources and added support for additional information attributes to be provided by customers.

DeleteAppVersionResource (new)

Link ¶

Deletes a resource from the AWS 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 AWS Resilience Hub.
This API updates the AWS Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the AWS Resilience Hub application using the PublishAppVersion API.

See also: AWS API Documentation

Request Syntax

client.delete_app_version_resource(
    appArn='string',
    awsAccountId='string',
    awsRegion='string',
    clientToken='string',
    logicalResourceId={
        'identifier': 'string',
        'logicalStackName': 'string',
        'resourceGroupName': 'string',
        'terraformSourceName': 'string'
    },
    physicalResourceId='string',
    resourceName='string'
)

type appArn

string

param appArn

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

type awsAccountId

string

param awsAccountId

The Amazon Web Services account that owns the physical resource.

type awsRegion

string

param awsRegion

The Amazon Web Services region that owns the physical resource.

type clientToken

string

param clientToken

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.

type logicalResourceId

dict

param logicalResourceId

The logical identifier of the resource.

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.

type physicalResourceId

string

param physicalResourceId

The physical identifier of the resource.

type resourceName

string

param resourceName

The name of the resource.

rtype

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': {
            'identifier': 'string',
            'logicalStackName': 'string',
            'resourceGroupName': 'string',
            'terraformSourceName': 'string'
        },
        'physicalResourceId': {
            'awsAccountId': 'string',
            'awsRegion': 'string',
            'identifier': 'string',
            'type': 'Arn'|'Native'
        },
        'resourceName': 'string',
        'resourceType': '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.
- appVersion (string) --
  
  The AWS 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 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) --
  - appComponents (list) --
    
    The application components that belong to this resource.
    - (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.
  - excluded (boolean) --
    
    Indicates if a resource is included or excluded from the assessment.
  - logicalResourceId (dict) --
    
    The logical identifier of the resource.
    - 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.
  - 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 AWS Resilience Hub-native identifier.
  - resourceName (string) --
    
    The name of the resource.
  - resourceType (string) --
    
    The type of resource.

CreateAppVersionResource (new)

Link ¶

Adds a resource to the AWS Resilience Hub applicationand assigns it to the specified Application Components. If you specify a new Application Component, AWS Resilience Hub will automatically create the Application Component.

Note

This action has no effect outside AWS Resilience Hub.
This API updates the AWS Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the AWS Resilience Hub application using the PublishAppVersion API.
To update application version with new physicalResourceID , you must call ResolveAppVersionResources API.

See also: AWS API Documentation

Request Syntax

client.create_app_version_resource(
    additionalInfo={
        'string': [
            'string',
        ]
    },
    appArn='string',
    appComponents=[
        'string',
    ],
    awsAccountId='string',
    awsRegion='string',
    clientToken='string',
    logicalResourceId={
        'identifier': 'string',
        'logicalStackName': 'string',
        'resourceGroupName': 'string',
        'terraformSourceName': 'string'
    },
    physicalResourceId='string',
    resourceName='string',
    resourceType='string'
)

type additionalInfo

dict

param additionalInfo

Currently, there is no supported additional information for resources.

(string) --
- (list) --
  - (string) --

type appArn

string

param appArn

[REQUIRED]

type appComponents

list

param appComponents

[REQUIRED]

The list of Application Components that this resource belongs to. If an Application Component is not part of the AWS Resilience Hub application, it will be added.

(string) --

type awsAccountId

string

param awsAccountId

The Amazon Web Services account that owns the physical resource.

type awsRegion

string

param awsRegion

The Amazon Web Services region that owns the physical resource.

type clientToken

string

param clientToken

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.

type logicalResourceId

dict

param logicalResourceId

[REQUIRED]

The logical identifier of the resource.

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.

type physicalResourceId

string

param physicalResourceId

[REQUIRED]

The physical identifier of the resource.

type resourceName

string

param resourceName

[REQUIRED]

The name of the resource.

type resourceType

string

param resourceType

[REQUIRED]

The type of resource.

rtype

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': {
            'identifier': 'string',
            'logicalStackName': 'string',
            'resourceGroupName': 'string',
            'terraformSourceName': 'string'
        },
        'physicalResourceId': {
            'awsAccountId': 'string',
            'awsRegion': 'string',
            'identifier': 'string',
            'type': 'Arn'|'Native'
        },
        'resourceName': 'string',
        'resourceType': '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.
- appVersion (string) --
  
  The AWS 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 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) --
  - appComponents (list) --
    
    The application components that belong to this resource.
    - (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.
  - excluded (boolean) --
    
    Indicates if a resource is included or excluded from the assessment.
  - logicalResourceId (dict) --
    
    The logical identifier of the resource.
    - 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.
  - 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 AWS Resilience Hub-native identifier.
  - resourceName (string) --
    
    The name of the resource.
  - resourceType (string) --
    
    The type of resource.

CreateAppVersionAppComponent (new)

Link ¶

Creates a new Application Component in 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.

See also: AWS API Documentation

Request Syntax

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

type additionalInfo

dict

param additionalInfo

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

(string) --
- (list) --
  - (string) --

type appArn

string

param appArn

[REQUIRED]

type clientToken

string

param clientToken

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.

type id

string

param id

The identifier of the Application Component.

type name

string

param name

[REQUIRED]

The name of the Application Component.

type type

string

param type

[REQUIRED]

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

rtype

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.

UpdateAppVersionResource (new)

Link ¶

Updates the resource details in the AWS Resilience Hub application.

Note

This action has no effect outside AWS Resilience Hub.
This API updates the AWS Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the AWS Resilience Hub application using the PublishAppVersion API.
To update application version with new physicalResourceID , you must call ResolveAppVersionResources API.

See also: AWS API Documentation

Request Syntax

client.update_app_version_resource(
    additionalInfo={
        'string': [
            'string',
        ]
    },
    appArn='string',
    appComponents=[
        'string',
    ],
    awsAccountId='string',
    awsRegion='string',
    excluded=True|False,
    logicalResourceId={
        'identifier': 'string',
        'logicalStackName': 'string',
        'resourceGroupName': 'string',
        'terraformSourceName': 'string'
    },
    physicalResourceId='string',
    resourceName='string',
    resourceType='string'
)

type additionalInfo

dict

param additionalInfo

Currently, there is no supported additional information for resources.

(string) --
- (list) --
  - (string) --

type appArn

string

param appArn

[REQUIRED]

type appComponents

list

param appComponents

The list of Application Components that this resource belongs to. If an Application Component is not part of the AWS Resilience Hub application, it will be added.

(string) --

type awsAccountId

string

param awsAccountId

The Amazon Web Services account that owns the physical resource.

type awsRegion

string

param awsRegion

The Amazon Web Services region that owns the physical resource.

type excluded

boolean

param excluded

Indicates if a resource is excluded from an AWS Resilience Hub application.

Note

You can exclude only imported resources from an AWS Resilience Hub application.

type logicalResourceId

dict

param logicalResourceId

The logical identifier of the resource.

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.

type physicalResourceId

string

param physicalResourceId

The physical identifier of the resource.

type resourceName

string

param resourceName

The name of the resource.

type resourceType

string

param resourceType

The type of resource.

rtype

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': {
            'identifier': 'string',
            'logicalStackName': 'string',
            'resourceGroupName': 'string',
            'terraformSourceName': 'string'
        },
        'physicalResourceId': {
            'awsAccountId': 'string',
            'awsRegion': 'string',
            'identifier': 'string',
            'type': 'Arn'|'Native'
        },
        'resourceName': 'string',
        'resourceType': '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.
- appVersion (string) --
  
  The AWS 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 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) --
  - appComponents (list) --
    
    The application components that belong to this resource.
    - (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.
  - excluded (boolean) --
    
    Indicates if a resource is included or excluded from the assessment.
  - logicalResourceId (dict) --
    
    The logical identifier of the resource.
    - 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.
  - 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 AWS Resilience Hub-native identifier.
  - resourceName (string) --
    
    The name of the resource.
  - resourceType (string) --
    
    The type of resource.

DescribeAppVersion (new)

Link ¶

Describes the AWS Resilience Hub application version.

See also: AWS API Documentation

Request Syntax

client.describe_app_version(
    appArn='string',
    appVersion='string'
)

type appArn

string

param appArn

[REQUIRED]

type appVersion

string

param appVersion

[REQUIRED]

The AWS Resilience Hub application version.

rtype

dict

returns

Response Syntax

{
    'additionalInfo': {
        'string': [
            'string',
        ]
    },
    'appArn': 'string',
    'appVersion': 'string'
}

Response Structure

(dict) --
- additionalInfo (dict) --
  
  Additional configuration parameters for an AWS Resilience Hub application.
  
  Note
  
  Currently, this parameter supports only failover region and account.
  - (string) --
    - (list) --
      - (string) --
- 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.
- appVersion (string) --
  
  The AWS Resilience Hub application version.

DeleteAppVersionAppComponent (new)

Link ¶

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

client.delete_app_version_app_component(
    appArn='string',
    clientToken='string',
    id='string'
)

type appArn

string

param appArn

[REQUIRED]

type clientToken

string

param clientToken

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.

type id

string

param id

[REQUIRED]

The identifier of the Application Component.

rtype

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.

DescribeAppVersionAppComponent (new)

Link ¶

Describes an Application Component in the AWS Resilience Hub application.

See also: AWS API Documentation

Request Syntax

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

type appArn

string

param appArn

[REQUIRED]

type appVersion

string

param appVersion

[REQUIRED]

The AWS Resilience Hub application version.

type id

string

param id

[REQUIRED]

The identifier of the Application Component.

rtype

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.

DescribeAppVersionResource (new)

Link ¶

Describes a resource of the AWS Resilience Hub application.

Note

This API accepts only one of the following parameters to descibe the resource:

resourceName
logicalResourceId
physicalResourceId (Along with physicalResourceId , you can also provide awsAccountId , and awsRegion )

See also: AWS API Documentation

Request Syntax

client.describe_app_version_resource(
    appArn='string',
    appVersion='string',
    awsAccountId='string',
    awsRegion='string',
    logicalResourceId={
        'identifier': 'string',
        'logicalStackName': 'string',
        'resourceGroupName': 'string',
        'terraformSourceName': 'string'
    },
    physicalResourceId='string',
    resourceName='string'
)

type appArn

string

param appArn

[REQUIRED]

type appVersion

string

param appVersion

[REQUIRED]

The AWS Resilience Hub application version.

type awsAccountId

string

param awsAccountId

The Amazon Web Services account that owns the physical resource.

type awsRegion

string

param awsRegion

The Amazon Web Services region that owns the physical resource.

type logicalResourceId

dict

param logicalResourceId

The logical identifier of the resource.

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.

type physicalResourceId

string

param physicalResourceId

The physical identifier of the resource.

type resourceName

string

param resourceName

The name of the resource.

rtype

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': {
            'identifier': 'string',
            'logicalStackName': 'string',
            'resourceGroupName': 'string',
            'terraformSourceName': 'string'
        },
        'physicalResourceId': {
            'awsAccountId': 'string',
            'awsRegion': 'string',
            'identifier': 'string',
            'type': 'Arn'|'Native'
        },
        'resourceName': 'string',
        'resourceType': '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.
- appVersion (string) --
  
  The AWS 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 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) --
  - appComponents (list) --
    
    The application components that belong to this resource.
    - (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.
  - excluded (boolean) --
    
    Indicates if a resource is included or excluded from the assessment.
  - logicalResourceId (dict) --
    
    The logical identifier of the resource.
    - 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.
  - 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 AWS Resilience Hub-native identifier.
  - resourceName (string) --
    
    The name of the resource.
  - resourceType (string) --
    
    The type of resource.

ListAppVersionAppComponents (new)

Link ¶

Lists all the Application Components in the AWS Resilience Hub application.

See also: AWS API Documentation

Request Syntax

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

type appArn

string

param appArn

[REQUIRED]

type appVersion

string

param appVersion

[REQUIRED]

The version of the Application Component.

type maxResults

integer

param maxResults

Maximum number of Application Components to be displayed per AWS Resilience Hub application version.

type nextToken

string

param nextToken

Null, or the token from a previous call to get the next set of results.

rtype

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 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.
- appComponents (list) --
  
  Defines an Application Component.
  - (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.
- nextToken (string) --
  
  The token for the next set of results, or null if there are no more results.

UpdateAppVersion (new)

Link ¶

Updates the AWS Resilience Hub application version.

Note

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

See also: AWS API Documentation

Request Syntax

client.update_app_version(
    additionalInfo={
        'string': [
            'string',
        ]
    },
    appArn='string'
)

type additionalInfo

dict

param additionalInfo

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

type appArn

string

param appArn

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'additionalInfo': {
        'string': [
            'string',
        ]
    },
    'appArn': 'string',
    'appVersion': 'string'
}

Response Structure

(dict) --
- additionalInfo (dict) --
  
  Additional configuration parameters for an AWS Resilience Hub application.
  
  Note
  
  Currently, this parameter supports only failover region and account.
  - (string) --
    - (list) --
      - (string) --
- 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.
- appVersion (string) --
  
  The AWS Resilience Hub application version.

UpdateAppVersionAppComponent (new)

Link ¶

Updates an existing Application Component in the AWS Resilience Hub application.

Note

See also: AWS API Documentation

Request Syntax

client.update_app_version_app_component(
    additionalInfo={
        'string': [
            'string',
        ]
    },
    appArn='string',
    id='string',
    name='string',
    type='string'
)

type additionalInfo

dict

param additionalInfo

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

(string) --
- (list) --
  - (string) --

type appArn

string

param appArn

[REQUIRED]

type id

string

param id

[REQUIRED]

The identifier of the Application Component.

type name

string

param name

The name of the Application Component.

type type

string

param type

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

rtype

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.

ListAppInputSources (new)

Link ¶

Lists all the input sources of the AWS Resilience Hub application. For more information about the input sources supported by AWS Resilience Hub, see Discover the structure and describe your Resilience Hub application .

See also: AWS API Documentation

Request Syntax

client.list_app_input_sources(
    appArn='string',
    appVersion='string',
    maxResults=123,
    nextToken='string'
)

type appArn

string

param appArn

[REQUIRED]

type appVersion

string

param appVersion

[REQUIRED]

The AWS Resilience Hub application version.

type maxResults

integer

param maxResults

Maximum number of input sources to be displayed per AWS Resilience Hub application.

type nextToken

string

param nextToken

Null, or the token from a previous call to get the next set of results.

rtype

dict

returns

Response Syntax

{
    'appInputSources': [
        {
            'importType': 'CfnStack'|'Resource'|'AppRegistryApp'|'ResourceGroup'|'Terraform',
            'resourceCount': 123,
            'sourceArn': 'string',
            'sourceName': 'string',
            'terraformSource': {
                's3StateFileUrl': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- appInputSources (list) --
  
  The list of AWS Resilience Hub application input sources.
  - (dict) --
    
    The list of AWS Resilience Hub application input sources.
    - importType (string) --
      
      The resource type of the input source.
    - resourceCount (integer) --
      
      The number of resources that were imported.
    - sourceArn (string) --
      
      The Amazon Resource Name (ARN) of the input source. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
    - sourceName (string) --
      
      The name of the input source.
    - terraformSource (dict) --
      
      The name of the Terraform s3 state ﬁle.
      - s3StateFileUrl (string) --
        
        The Terraform s3 state file you need to import.
- nextToken (string) --
  
  The token for the next set of results, or null if there are no more results.

DeleteAppInputSource (new)

Link ¶

Deletes the input source and all of its imported resources from the AWS Resilience Hub application.

See also: AWS API Documentation

Request Syntax

client.delete_app_input_source(
    appArn='string',
    clientToken='string',
    sourceArn='string',
    terraformSource={
        's3StateFileUrl': 'string'
    }
)

type appArn

string

param appArn

[REQUIRED]

type clientToken

string

param clientToken

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.

type sourceArn

string

param sourceArn

The Amazon Resource Name (ARN) of the imported resource you want to remove from the AWS Resilience Hub application. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

type terraformSource

dict

param terraformSource

The imported Terraform s3 state ﬁle you want to remove from the AWS Resilience Hub application.

s3StateFileUrl (string) -- [REQUIRED]

The Terraform s3 state file you need to import.

rtype

dict

returns

Response Syntax

{
    'appArn': 'string',
    'appInputSource': {
        'importType': 'CfnStack'|'Resource'|'AppRegistryApp'|'ResourceGroup'|'Terraform',
        'resourceCount': 123,
        'sourceArn': 'string',
        'sourceName': 'string',
        'terraformSource': {
            's3StateFileUrl': '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.
- appInputSource (dict) --
  
  The name of the input source from where the application resource is imported from.
  - importType (string) --
    
    The resource type of the input source.
  - resourceCount (integer) --
    
    The number of resources that were imported.
  - sourceArn (string) --
    
    The Amazon Resource Name (ARN) of the input source. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
  - sourceName (string) --
    
    The name of the input source.
  - terraformSource (dict) --
    
    The name of the Terraform s3 state ﬁle.
    - s3StateFileUrl (string) --
      
      The Terraform s3 state file you need to import.

ImportResourcesToDraftAppVersion (updated)

Link ¶
Changes (request)

{'importStrategy': 'AddOnly | ReplaceAll'}

Imports resources to AWS Resilience Hub application draft version from different input sources. For more information about the input sources supported by AWS Resilience Hub, see Discover the structure and describe your Resilience Hub application .

See also: AWS API Documentation

Request Syntax

client.import_resources_to_draft_app_version(
    appArn='string',
    importStrategy='AddOnly'|'ReplaceAll',
    sourceArns=[
        'string',
    ],
    terraformSources=[
        {
            's3StateFileUrl': 'string'
        },
    ]
)

type appArn

string

param appArn

[REQUIRED]

type importStrategy

string

param importStrategy

The import strategy you would like to set to import resources into AWS Resilience Hub application.

type sourceArns

list

param sourceArns

The Amazon Resource Names (ARNs) for the resources that you want to import.

(string) --

type terraformSources

list

param terraformSources

A list of terraform file s3 URLs you need to import.

(dict) --

The Terraform s3 state file you need to import.
- s3StateFileUrl (string) -- [REQUIRED]
  
  The Terraform s3 state file you need to import.

rtype

dict

returns

Response Syntax

{
    'appArn': 'string',
    'appVersion': 'string',
    'sourceArns': [
        'string',
    ],
    'status': 'Pending'|'InProgress'|'Failed'|'Success',
    'terraformSources': [
        {
            's3StateFileUrl': '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.
- appVersion (string) --
  
  The version of the application.
- sourceArns (list) --
  
  The Amazon Resource Names (ARNs) for the resources that you imported.
  - (string) --
- status (string) --
  
  The status of the action.
- terraformSources (list) --
  
  A list of terraform file s3 URLs you need to import.
  - (dict) --
    
    The Terraform s3 state file you need to import.
    - s3StateFileUrl (string) --
      
      The Terraform s3 state file you need to import.

ListAppVersionResources (updated)

Link ¶
Changes (response)

{'physicalResources': {'additionalInfo': {'string': ['string']},
                       'appComponents': {'additionalInfo': {'string': ['string']},
                                         'id': 'string'},
                       'excluded': 'boolean'}}

Lists all the resources in an AWS Resilience Hub application.

See also: AWS API Documentation

Request Syntax

client.list_app_version_resources(
    appArn='string',
    appVersion='string',
    maxResults=123,
    nextToken='string',
    resolutionId='string'
)

type appArn

string

param appArn

[REQUIRED]

type appVersion

string

param appVersion

[REQUIRED]

The version of the application.

type maxResults

integer

param maxResults

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

type nextToken

string

param nextToken

Null, or the token from a previous call to get the next set of results.

type resolutionId

string

param resolutionId

The identifier for a specific resolution.

rtype

dict

returns

Response Syntax

{
    'nextToken': 'string',
    'physicalResources': [
        {
            'additionalInfo': {
                'string': [
                    'string',
                ]
            },
            'appComponents': [
                {
                    'additionalInfo': {
                        'string': [
                            'string',
                        ]
                    },
                    'id': 'string',
                    'name': 'string',
                    'type': 'string'
                },
            ],
            'excluded': True|False,
            'logicalResourceId': {
                'identifier': 'string',
                'logicalStackName': 'string',
                'resourceGroupName': 'string',
                'terraformSourceName': 'string'
            },
            'physicalResourceId': {
                'awsAccountId': 'string',
                'awsRegion': 'string',
                'identifier': 'string',
                'type': 'Arn'|'Native'
            },
            'resourceName': 'string',
            'resourceType': 'string'
        },
    ],
    'resolutionId': 'string'
}

Response Structure

(dict) --
- nextToken (string) --
  
  The token for the next set of results, or null if there are no more results.
- physicalResources (list) --
  
  The physical resources in the application version.
  - (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 an AWS Resilience Hub-native identifier.
    - 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) --
    - appComponents (list) --
      
      The application components that belong to this resource.
      - (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.
    - excluded (boolean) --
      
      Indicates if a resource is included or excluded from the assessment.
    - logicalResourceId (dict) --
      
      The logical identifier of the resource.
      - 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.
    - 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 AWS Resilience Hub-native identifier.
    - resourceName (string) --
      
      The name of the resource.
    - resourceType (string) --
      
      The type of resource.
- resolutionId (string) --
  
  The ID for a specific resolution.