AWS Resilience Hub

2023/05/02 - AWS Resilience Hub - 5 updated api methods

Changes  This release will improve resource level transparency in applications by discovering previously hidden resources.

CreateAppVersionResource (updated) Link ¶
Changes (response) 
{'physicalResource': {'parentResourceName': 'string',
                      'sourceType': 'AppTemplate | Discovered'}}

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

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={
        'eksSourceName': 'string',
        '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]

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.

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

  • eksSourceName (string) --

    The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

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

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': {
            '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.

        • (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.

            • (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.

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

DeleteAppVersionResource (updated) Link ¶
Changes (response) 
{'physicalResource': {'parentResourceName': 'string',
                      'sourceType': 'AppTemplate | Discovered'}}

Deletes a resource from the Resilience Hub application.

See also: AWS API Documentation

Request Syntax

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'
)
type appArn:

string

param appArn:

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

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.

  • eksSourceName (string) --

    The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

  • 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': {
            '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.

        • (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.

            • (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.

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

DescribeAppVersionResource (updated) Link ¶
Changes (response) 
{'physicalResource': {'parentResourceName': 'string',
                      'sourceType': 'AppTemplate | Discovered'}}

Describes a resource of the Resilience Hub application.

See also: AWS API Documentation

Request Syntax

client.describe_app_version_resource(
    appArn='string',
    appVersion='string',
    awsAccountId='string',
    awsRegion='string',
    logicalResourceId={
        'eksSourceName': 'string',
        '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 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 appVersion:

string

param appVersion:

[REQUIRED]

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

  • eksSourceName (string) --

    The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

  • 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': {
            '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.

        • (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.

            • (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.

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

ListAppVersionResources (updated) Link ¶
Changes (response) 
{'physicalResources': {'parentResourceName': 'string',
                       'sourceType': 'AppTemplate | Discovered'}}

Lists all the resources in an 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]

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.

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': {
                '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'
        },
    ],
    '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 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.

          • (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.

              • (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.

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

    • resolutionId (string) --

      The ID for a specific resolution.

UpdateAppVersionResource (updated) Link ¶
Changes (response) 
{'physicalResource': {'parentResourceName': 'string',
                      'sourceType': 'AppTemplate | Discovered'}}

Updates the resource details in the Resilience Hub application.

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={
        'eksSourceName': 'string',
        '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]

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.

type appComponents:

list

param appComponents:

The list of Application Components that this resource belongs to. If an Application Component is not part of the 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 Resilience Hub application.

type logicalResourceId:

dict

param logicalResourceId:

The logical identifier of the resource.

  • eksSourceName (string) --

    The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

  • 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': {
            '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.

        • (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.

            • (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.

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