ApplicationInsights / Client / describe_problem

describe_problem#

ApplicationInsights.Client.describe_problem(**kwargs)#

Describes an application problem.

See also: AWS API Documentation

Request Syntax

response = client.describe_problem(
    ProblemId='string',
    AccountId='string'
)
Parameters:

  • ProblemId (string) –

    [REQUIRED]

    The ID of the problem.

  • AccountId (string) – The Amazon Web Services account ID for the owner of the resource group affected by the problem.

Return type:

dict

Returns:

Response Syntax

{
    'Problem': {
        'Id': 'string',
        'Title': 'string',
        'ShortName': 'string',
        'Insights': 'string',
        'Status': 'IGNORE'|'RESOLVED'|'PENDING'|'RECURRING'|'RECOVERING',
        'AffectedResource': 'string',
        'StartTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1),
        'SeverityLevel': 'Informative'|'Low'|'Medium'|'High',
        'AccountId': 'string',
        'ResourceGroupName': 'string',
        'Feedback': {
            'string': 'NOT_SPECIFIED'|'USEFUL'|'NOT_USEFUL'
        },
        'RecurringCount': 123,
        'LastRecurrenceTime': datetime(2015, 1, 1),
        'Visibility': 'IGNORED'|'VISIBLE',
        'ResolutionMethod': 'MANUAL'|'AUTOMATIC'|'UNRESOLVED'
    },
    'SNSNotificationArn': 'string'
}

Response Structure

  • (dict) –

    • Problem (dict) –

      Information about the problem.

      • Id (string) –

        The ID of the problem.

      • Title (string) –

        The name of the problem.

      • ShortName (string) –

        The short name of the problem associated with the SNS notification.

      • Insights (string) –

        A detailed analysis of the problem using machine learning.

      • Status (string) –

        The status of the problem.

      • AffectedResource (string) –

        The resource affected by the problem.

      • StartTime (datetime) –

        The time when the problem started, in epoch seconds.

      • EndTime (datetime) –

        The time when the problem ended, in epoch seconds.

      • SeverityLevel (string) –

        A measure of the level of impact of the problem.

      • AccountId (string) –

        The Amazon Web Services account ID for the owner of the resource group affected by the problem.

      • ResourceGroupName (string) –

        The name of the resource group affected by the problem.

      • Feedback (dict) –

        Feedback provided by the user about the problem.

        • (string) –

          • (string) –

      • RecurringCount (integer) –

        The number of times that the same problem reoccurred after the first time it was resolved.

      • LastRecurrenceTime (datetime) –

        The last time that the problem reoccurred after its last resolution.

      • Visibility (string) –

        Specifies whether or not you can view the problem. Updates to ignored problems do not generate notifications.

      • ResolutionMethod (string) –

        Specifies how the problem was resolved. If the value is AUTOMATIC, the system resolved the problem. If the value is MANUAL, the user resolved the problem. If the value is UNRESOLVED, then the problem is not resolved.

    • SNSNotificationArn (string) –

      The SNS notification topic ARN of the problem.

Exceptions

  • ApplicationInsights.Client.exceptions.InternalServerException

  • ApplicationInsights.Client.exceptions.ValidationException

  • ApplicationInsights.Client.exceptions.ResourceNotFoundException