list_app_version_resources

ResilienceHub.Client.list_app_version_resources(**kwargs)

Lists all the resources in an AWS Resilience Hub application.

See also: AWS API Documentation

Request Syntax

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

Parameters

• appArn (string) --

  [REQUIRED]

  The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

• appVersion (string) --

  [REQUIRED]

  The version of the application.

• maxResults (integer) -- 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.
• nextToken (string) -- Null, or the token from a previous call to get the next set of results.
• resolutionId (string) -- The identifier for a specific resolution.

Return type

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.

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