ApplicationInsights

Client

class ApplicationInsights.Client

A low-level client representing Amazon CloudWatch Application Insights:

import boto3

client = boto3.client('application-insights')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_application(**kwargs)

Adds an application that is created from a resource group.

See also: AWS API Documentation

Request Syntax

response = client.create_application(
    ResourceGroupName='string'
)
Parameters
ResourceGroupName (string) --

[REQUIRED]

The name of the resource group.

Return type
dict
Returns
Response Syntax
{
    'ApplicationInfo': {
        'ResourceGroupName': 'string',
        'LifeCycle': 'string',
        'Remarks': 'string'
    }
}

Response Structure

  • (dict) --
    • ApplicationInfo (dict) --

      Information about the application.

      • ResourceGroupName (string) --

        The name of the resource group used for the application.

      • LifeCycle (string) --

        The lifecycle of the application.

      • Remarks (string) --

        The issues on the user side that are blocking Application Insights from fully monitoring the application.

create_component(**kwargs)

Creates a custom component by grouping similar standalone instances to monitor.

See also: AWS API Documentation

Request Syntax

response = client.create_component(
    ResourceGroupName='string',
    ComponentName='string',
    ResourceList=[
        'string',
    ]
)
Parameters
  • ResourceGroupName (string) --

    [REQUIRED]

    The name of the resource group.

  • ComponentName (string) --

    [REQUIRED]

    The name of the component.

  • ResourceList (list) --

    [REQUIRED]

    The list of resource ARNs that belong to the component.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

delete_application(**kwargs)

Removes the specified application from monitoring. Does not delete the application.

See also: AWS API Documentation

Request Syntax

response = client.delete_application(
    ResourceGroupName='string'
)
Parameters
ResourceGroupName (string) --

[REQUIRED]

The name of the resource group.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
delete_component(**kwargs)

Ungroups a custom component. When you ungroup custom components, all applicable monitors that are set up for the component are removed and the instances revert to their standalone status.

See also: AWS API Documentation

Request Syntax

response = client.delete_component(
    ResourceGroupName='string',
    ComponentName='string'
)
Parameters
  • ResourceGroupName (string) --

    [REQUIRED]

    The name of the resource group.

  • ComponentName (string) --

    [REQUIRED]

    The name of the component.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

describe_application(**kwargs)

Describes the application.

See also: AWS API Documentation

Request Syntax

response = client.describe_application(
    ResourceGroupName='string'
)
Parameters
ResourceGroupName (string) --

[REQUIRED]

The name of the resource group.

Return type
dict
Returns
Response Syntax
{
    'ApplicationInfo': {
        'ResourceGroupName': 'string',
        'LifeCycle': 'string',
        'Remarks': 'string'
    }
}

Response Structure

  • (dict) --
    • ApplicationInfo (dict) --

      Information about the application.

      • ResourceGroupName (string) --

        The name of the resource group used for the application.

      • LifeCycle (string) --

        The lifecycle of the application.

      • Remarks (string) --

        The issues on the user side that are blocking Application Insights from fully monitoring the application.

describe_component(**kwargs)

Describes a component and lists the resources that are grouped together in a component.

See also: AWS API Documentation

Request Syntax

response = client.describe_component(
    ResourceGroupName='string',
    ComponentName='string'
)
Parameters
  • ResourceGroupName (string) --

    [REQUIRED]

    The name of the resource group.

  • ComponentName (string) --

    [REQUIRED]

    The name of the component.

Return type

dict

Returns

Response Syntax

{
    'ApplicationComponent': {
        'ComponentName': 'string',
        'ResourceType': 'string',
        'Tier': 'string',
        'Monitor': True|False
    },
    'ResourceList': [
        'string',
    ]
}

Response Structure

  • (dict) --

    • ApplicationComponent (dict) --

      Describes a standalone resource or similarly grouped resources that the application is made up of.

      • ComponentName (string) --

        The name of the component.

      • ResourceType (string) --

        The resource type. Supported resource types include EC2 instances, Auto Scaling group, Classic ELB, Application ELB, and SQS Queue.

      • Tier (string) --

        The stack tier of the application component.

      • Monitor (boolean) --

        Indicates whether the application component is monitored.

    • ResourceList (list) --

      The list of resource ARNs that belong to the component.

      • (string) --

describe_component_configuration(**kwargs)

Describes the monitoring configuration of the component.

See also: AWS API Documentation

Request Syntax

response = client.describe_component_configuration(
    ResourceGroupName='string',
    ComponentName='string'
)
Parameters
  • ResourceGroupName (string) --

    [REQUIRED]

    The name of the resource group.

  • ComponentName (string) --

    [REQUIRED]

    The name of the component.

Return type

dict

Returns

Response Syntax

{
    'Monitor': True|False,
    'Tier': 'string',
    'ComponentConfiguration': 'string'
}

Response Structure

  • (dict) --

    • Monitor (boolean) --

      Indicates whether the application component is monitored.

    • Tier (string) --

      The tier of the application component. Supported tiers include DOT_NET_WORKER , DOT_NET_WEB_TIER , SQL_SERVER , and DEFAULT

    • ComponentConfiguration (string) --

      The configuration settings of the component. The value is the escaped JSON of the configuration.

describe_component_configuration_recommendation(**kwargs)

Describes the recommended monitoring configuration of the component.

See also: AWS API Documentation

Request Syntax

response = client.describe_component_configuration_recommendation(
    ResourceGroupName='string',
    ComponentName='string',
    Tier='string'
)
Parameters
  • ResourceGroupName (string) --

    [REQUIRED]

    The name of the resource group.

  • ComponentName (string) --

    [REQUIRED]

    The name of the component.

  • Tier (string) --

    [REQUIRED]

    The tier of the application component. Supported tiers include DOT_NET_WORKER , DOT_NET_WEB_TIER , SQL_SERVER , and DEFAULT .

Return type

dict

Returns

Response Syntax

{
    'ComponentConfiguration': 'string'
}

Response Structure

  • (dict) --

    • ComponentConfiguration (string) --

      The recommended configuration settings of the component. The value is the escaped JSON of the configuration.

describe_observation(**kwargs)

Describes an anomaly or error with the application.

See also: AWS API Documentation

Request Syntax

response = client.describe_observation(
    ObservationId='string'
)
Parameters
ObservationId (string) --

[REQUIRED]

The ID of the observation.

Return type
dict
Returns
Response Syntax
{
    'Observation': {
        'Id': 'string',
        'StartTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1),
        'SourceType': 'string',
        'SourceARN': 'string',
        'LogGroup': 'string',
        'LineTime': datetime(2015, 1, 1),
        'LogText': 'string',
        'LogFilter': 'ERROR'|'WARN'|'INFO',
        'MetricNamespace': 'string',
        'MetricName': 'string',
        'Unit': 'string',
        'Value': 123.0
    }
}

Response Structure

  • (dict) --
    • Observation (dict) --

      Information about the observation.

      • Id (string) --

        The ID of the observation type.

      • StartTime (datetime) --

        The time when the observation was first detected, in epoch seconds.

      • EndTime (datetime) --

        The time when the observation ended, in epoch seconds.

      • SourceType (string) --

        The source type of the observation.

      • SourceARN (string) --

        The source resource ARN of the observation.

      • LogGroup (string) --

        The log group name.

      • LineTime (datetime) --

        The timestamp in the CloudWatch Logs that specifies when the matched line occurred.

      • LogText (string) --

        The log text of the observation.

      • LogFilter (string) --

        The log filter of the observation.

      • MetricNamespace (string) --

        The namespace of the observation metric.

      • MetricName (string) --

        The name of the observation metric.

      • Unit (string) --

        The unit of the source observation metric.

      • Value (float) --

        The value of the source observation metric.

describe_problem(**kwargs)

Describes an application problem.

See also: AWS API Documentation

Request Syntax

response = client.describe_problem(
    ProblemId='string'
)
Parameters
ProblemId (string) --

[REQUIRED]

The ID of the problem.

Return type
dict
Returns
Response Syntax
{
    'Problem': {
        'Id': 'string',
        'Title': 'string',
        'Insights': 'string',
        'Status': 'IGNORE'|'RESOLVED'|'PENDING',
        'AffectedResource': 'string',
        'StartTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1),
        'SeverityLevel': 'LOW'|'MEDIUM'|'HIGH',
        'ResourceGroupName': 'string',
        'Feedback': {
            'string': 'NOT_SPECIFIED'|'USEFUL'|'NOT_USEFUL'
        }
    }
}

Response Structure

  • (dict) --
    • Problem (dict) --

      Information about the problem.

      • Id (string) --

        The ID of the problem.

      • Title (string) --

        The name of the problem.

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

      • ResourceGroupName (string) --

        The name of the resource group affected by the problem.

      • Feedback (dict) --

        Feedback provided by the user about the problem.

        • (string) --
          • (string) --
describe_problem_observations(**kwargs)

Describes the anomalies or errors associated with the problem.

See also: AWS API Documentation

Request Syntax

response = client.describe_problem_observations(
    ProblemId='string'
)
Parameters
ProblemId (string) --

[REQUIRED]

The ID of the problem.

Return type
dict
Returns
Response Syntax
{
    'RelatedObservations': {
        'ObservationList': [
            {
                'Id': 'string',
                'StartTime': datetime(2015, 1, 1),
                'EndTime': datetime(2015, 1, 1),
                'SourceType': 'string',
                'SourceARN': 'string',
                'LogGroup': 'string',
                'LineTime': datetime(2015, 1, 1),
                'LogText': 'string',
                'LogFilter': 'ERROR'|'WARN'|'INFO',
                'MetricNamespace': 'string',
                'MetricName': 'string',
                'Unit': 'string',
                'Value': 123.0
            },
        ]
    }
}

Response Structure

  • (dict) --
    • RelatedObservations (dict) --

      Observations related to the problem.

      • ObservationList (list) --

        The list of observations related to the problem.

        • (dict) --

          Describes an anomaly or error with the application.

          • Id (string) --

            The ID of the observation type.

          • StartTime (datetime) --

            The time when the observation was first detected, in epoch seconds.

          • EndTime (datetime) --

            The time when the observation ended, in epoch seconds.

          • SourceType (string) --

            The source type of the observation.

          • SourceARN (string) --

            The source resource ARN of the observation.

          • LogGroup (string) --

            The log group name.

          • LineTime (datetime) --

            The timestamp in the CloudWatch Logs that specifies when the matched line occurred.

          • LogText (string) --

            The log text of the observation.

          • LogFilter (string) --

            The log filter of the observation.

          • MetricNamespace (string) --

            The namespace of the observation metric.

          • MetricName (string) --

            The name of the observation metric.

          • Unit (string) --

            The unit of the source observation metric.

          • Value (float) --

            The value of the source observation metric.

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_applications(**kwargs)

Lists the IDs of the applications that you are monitoring.

See also: AWS API Documentation

Request Syntax

response = client.list_applications(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • 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.
Return type

dict

Returns

Response Syntax

{
    'ApplicationInfoList': [
        {
            'ResourceGroupName': 'string',
            'LifeCycle': 'string',
            'Remarks': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • ApplicationInfoList (list) --

      The list of applications.

      • (dict) --

        Describes the status of the application.

        • ResourceGroupName (string) --

          The name of the resource group used for the application.

        • LifeCycle (string) --

          The lifecycle of the application.

        • Remarks (string) --

          The issues on the user side that are blocking Application Insights from fully monitoring the application.

    • NextToken (string) --

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

list_components(**kwargs)

Lists the auto-grouped, standalone, and custom components of the application.

See also: AWS API Documentation

Request Syntax

response = client.list_components(
    ResourceGroupName='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • ResourceGroupName (string) --

    [REQUIRED]

    The name of the resource group.

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

dict

Returns

Response Syntax

{
    'ApplicationComponentList': [
        {
            'ComponentName': 'string',
            'ResourceType': 'string',
            'Tier': 'string',
            'Monitor': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • ApplicationComponentList (list) --

      The list of application components.

      • (dict) --

        Describes a standalone resource or similarly grouped resources that the application is made up of.

        • ComponentName (string) --

          The name of the component.

        • ResourceType (string) --

          The resource type. Supported resource types include EC2 instances, Auto Scaling group, Classic ELB, Application ELB, and SQS Queue.

        • Tier (string) --

          The stack tier of the application component.

        • Monitor (boolean) --

          Indicates whether the application component is monitored.

    • NextToken (string) --

      The token to request the next page of results.

list_problems(**kwargs)

Lists the problems with your application.

See also: AWS API Documentation

Request Syntax

response = client.list_problems(
    ResourceGroupName='string',
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    MaxResults=123,
    NextToken='string'
)
Parameters
  • 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.
Return type

dict

Returns

Response Syntax

{
    'ProblemList': [
        {
            'Id': 'string',
            'Title': 'string',
            'Insights': 'string',
            'Status': 'IGNORE'|'RESOLVED'|'PENDING',
            'AffectedResource': 'string',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'SeverityLevel': 'LOW'|'MEDIUM'|'HIGH',
            'ResourceGroupName': 'string',
            'Feedback': {
                'string': 'NOT_SPECIFIED'|'USEFUL'|'NOT_USEFUL'
            }
        },
    ],
    'NextToken': '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.

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

        • ResourceGroupName (string) --

          The name of the resource group affected by the problem.

        • Feedback (dict) --

          Feedback provided by the user about the problem.

          • (string) --
            • (string) --
    • NextToken (string) --

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

update_component(**kwargs)

Updates the custom component name and/or the list of resources that make up the component.

See also: AWS API Documentation

Request Syntax

response = client.update_component(
    ResourceGroupName='string',
    ComponentName='string',
    NewComponentName='string',
    ResourceList=[
        'string',
    ]
)
Parameters
  • ResourceGroupName (string) --

    [REQUIRED]

    The name of the resource group.

  • ComponentName (string) --

    [REQUIRED]

    The name of the component.

  • NewComponentName (string) -- The new name of the component.
  • ResourceList (list) --

    The list of resource ARNs that belong to the component.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_component_configuration(**kwargs)

Updates the monitoring configurations for the component. The configuration input parameter is an escaped JSON of the configuration and should match the schema of what is returned by DescribeComponentConfigurationRecommendation .

See also: AWS API Documentation

Request Syntax

response = client.update_component_configuration(
    ResourceGroupName='string',
    ComponentName='string',
    Monitor=True|False,
    Tier='string',
    ComponentConfiguration='string'
)
Parameters
  • ResourceGroupName (string) --

    [REQUIRED]

    The name of the resource group.

  • ComponentName (string) --

    [REQUIRED]

    The name of the component.

  • Monitor (boolean) -- Indicates whether the application component is monitored.
  • Tier (string) -- The tier of the application component. Supported tiers include DOT_NET_WORKER , DOT_NET_WEB_TIER , SQL_SERVER , and DEFAULT .
  • ComponentConfiguration (string) -- The configuration settings of the component. The value is the escaped JSON of the configuration. For more information about the JSON format, see Working with JSON . You can send a request to DescribeComponentConfigurationRecommendation to see the recommended configuration for a component.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Paginators

The available paginators are: