ApplicationInsights / Client / list_problems

list_problems

ApplicationInsights.Client.list_problems(**kwargs)

Lists the problems with your application.

See also: AWS API Documentation

Request Syntax

response = client.list_problems(
    AccountId='string',
    ResourceGroupName='string',
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    MaxResults=123,
    NextToken='string',
    ComponentName='string',
    Visibility='IGNORED'|'VISIBLE'
)

Parameters:

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

• ResourceGroupName (string) – The name of the resource group.

• StartTime (datetime) – The time when the problem was detected, in epoch seconds. If you don’t specify a time frame for the request, problems within the past seven days are returned.

• EndTime (datetime) – The time when the problem ended, in epoch seconds. If not specified, problems within the past seven days are returned.

• MaxResults (integer) – The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

• NextToken (string) – The token to request the next page of results.

• ComponentName (string) – The name of the component.

• Visibility (string) – Specifies whether or not you can view the problem. If not specified, visible and ignored problems are returned.

Return type:

dict

Returns:

Response Syntax

{
    'ProblemList': [
        {
            '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'
        },
    ],
    'NextToken': 'string',
    'ResourceGroupName': 'string',
    'AccountId': 'string'
}

Response Structure

• (dict) –

  • ProblemList (list) –

    The list of problems.

    • (dict) –

      Describes a problem that is detected by correlating observations.

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

  • NextToken (string) –

    The token used to retrieve the next page of results. This value is null when there are no more results to return.

  • ResourceGroupName (string) –

    The name of the resource group.

  • AccountId (string) –

    The Amazon Web Services account ID for the resource group owner.

Exceptions

• ApplicationInsights.Client.exceptions.ValidationException

• ApplicationInsights.Client.exceptions.ResourceNotFoundException

• ApplicationInsights.Client.exceptions.InternalServerException