ResilienceHubV2 / Client / get_dependency_insights

get_dependency_insights

ResilienceHubV2.Client.get_dependency_insights(**kwargs)

Retrieves the dependency insights generated for a service. The response reports the current generation status; insights are populated once generation has completed. If generation failed, the response includes an error code, whose possible values are listed under the response’s errorCode field, and a message describing the cause. To use this operation, you must have the resiliencehub:GetDependencyInsights permission on the service.

See also: AWS API Documentation

Request Syntax

response = client.get_dependency_insights(
    serviceArn='string'
)
Parameters:

serviceArn (string) –

[REQUIRED]

ARN identifier.

Return type:

dict

Returns:

Response Syntax

{
    'overview': 'string',
    'insights': [
        {
            'category': 'CROSS_REGION'|'NEW_DEPENDENCY'|'THIRD_PARTY'|'UNEVEN_USAGE'|'AWS_SERVICE',
            'description': 'string'
        },
    ],
    'status': 'IN_PROGRESS'|'COMPLETED'|'FAILED',
    'createdAt': datetime(2015, 1, 1),
    'errorCode': 'INSUFFICIENT_DATA'|'LLM_GENERATION_FAILED'|'INTERNAL_ERROR',
    'errorMessage': 'string'
}

Response Structure

  • (dict) –

    • overview (string) –

      A summary of the dependency insights for the service. This field is not returned until the status is COMPLETED.

    • insights (list) –

      The list of dependency insights generated for the service. This field is not returned until the status is COMPLETED.

      • (dict) –

        Contains a single insight about a service’s dependencies.

        • category (string) –

          The category of the insight. Valid values:

          • CROSS_REGION - The insight relates to dependencies used across multiple Regions.

          • NEW_DEPENDENCY - The insight relates to a recently detected dependency.

          • THIRD_PARTY - The insight relates to a third-party dependency.

          • UNEVEN_USAGE - The insight relates to a dependency with uneven usage across the service.

          • AWS_SERVICE - The insight relates to a dependency on an Amazon Web Services service.

        • description (string) –

          A human-readable explanation of the insight, describing the dependency behavior or condition that was detected.

    • status (string) –

      The status of the dependency insights generation. Valid values:

      • IN_PROGRESS - Insights generation is in progress.

      • COMPLETED - Insights generation completed successfully.

      • FAILED - Insights generation failed. See errorCode and errorMessage for details.

    • createdAt (datetime) –

      The timestamp when the dependency insights were generated.

    • errorCode (string) –

      The error code returned when insights generation failed. Valid values:

      • INSUFFICIENT_DATA - There was not enough dependency data to generate insights.

      • LLM_GENERATION_FAILED - The insights could not be generated.

      • INTERNAL_ERROR - An internal error occurred while generating insights.

    • errorMessage (string) –

      A message describing why insights generation failed.

Exceptions