Amazon CloudWatch Application Insights

Updates the application.

See also: AWS API Documentation

Request Syntax

client.update_application(
    ResourceGroupName='string',
    OpsCenterEnabled=True|False,
    OpsItemSNSTopicArn='string',
    RemoveSNSTopic=True|False
)

type ResourceGroupName:

string

param ResourceGroupName:

[REQUIRED]

The name of the resource group.

type OpsCenterEnabled:

boolean

param OpsCenterEnabled:

When set to true, creates opsItems for any problems detected on an application.

type OpsItemSNSTopicArn:

string

param OpsItemSNSTopicArn:

The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to receive notifications for updates to the opsItem.

type RemoveSNSTopic:

boolean

param RemoveSNSTopic:

Disassociates the SNS topic from the opsItem created for detected problems.

rtype:

dict

returns:

Response Syntax

{
    'ApplicationInfo': {
        'ResourceGroupName': 'string',
        'LifeCycle': 'string',
        'OpsItemSNSTopicArn': 'string',
        'OpsCenterEnabled': True|False,
        '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.

    • OpsItemSNSTopicArn (string) --

      The SNS topic provided to Application Insights that is associated to the created opsItems to receive SNS notifications for opsItem updates.

    • OpsCenterEnabled (boolean) --

      Indicates whether Application Insights will create opsItems for any problem detected by Application Insights for an application.

    • Remarks (string) --

      The issues on the user side that block Application Insights from successfully monitoring an application.

{'OpsCenterEnabled': 'boolean', 'OpsItemSNSTopicArn': 'string'}

{'ApplicationInfo': {'OpsCenterEnabled': 'boolean',
                     'OpsItemSNSTopicArn': 'string'}}

Adds an application that is created from a resource group.

See also: AWS API Documentation

Request Syntax

client.create_application(
    ResourceGroupName='string',
    OpsCenterEnabled=True|False,
    OpsItemSNSTopicArn='string'
)

type ResourceGroupName:

string

param ResourceGroupName:

[REQUIRED]

The name of the resource group.

type OpsCenterEnabled:

boolean

param OpsCenterEnabled:

When set to true, creates opsItems for any problems detected on an application.

type OpsItemSNSTopicArn:

string

param OpsItemSNSTopicArn:

The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to receive notifications for updates to the opsItem.

rtype:

dict

returns:

Response Syntax

{
    'ApplicationInfo': {
        'ResourceGroupName': 'string',
        'LifeCycle': 'string',
        'OpsItemSNSTopicArn': 'string',
        'OpsCenterEnabled': True|False,
        '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.

    • OpsItemSNSTopicArn (string) --

      The SNS topic provided to Application Insights that is associated to the created opsItems to receive SNS notifications for opsItem updates.

    • OpsCenterEnabled (boolean) --

      Indicates whether Application Insights will create opsItems for any problem detected by Application Insights for an application.

    • Remarks (string) --

      The issues on the user side that block Application Insights from successfully monitoring an application.

{'ApplicationInfo': {'OpsCenterEnabled': 'boolean',
                     'OpsItemSNSTopicArn': 'string'}}

Describes the application.

See also: AWS API Documentation

Request Syntax

client.describe_application(
    ResourceGroupName='string'
)

type ResourceGroupName:

string

param ResourceGroupName:

[REQUIRED]

The name of the resource group.

rtype:

dict

returns:

Response Syntax

{
    'ApplicationInfo': {
        'ResourceGroupName': 'string',
        'LifeCycle': 'string',
        'OpsItemSNSTopicArn': 'string',
        'OpsCenterEnabled': True|False,
        '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.

    • OpsItemSNSTopicArn (string) --

      The SNS topic provided to Application Insights that is associated to the created opsItems to receive SNS notifications for opsItem updates.

    • OpsCenterEnabled (boolean) --

      Indicates whether Application Insights will create opsItems for any problem detected by Application Insights for an application.

    • Remarks (string) --

      The issues on the user side that block Application Insights from successfully monitoring an application.

{'ApplicationInfoList': {'OpsCenterEnabled': 'boolean',
                         'OpsItemSNSTopicArn': 'string'}}

Lists the IDs of the applications that you are monitoring.

See also: AWS API Documentation

Request Syntax

client.list_applications(
    MaxResults=123,
    NextToken='string'
)

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

type NextToken:

string

param NextToken:

The token to request the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'ApplicationInfoList': [
        {
            'ResourceGroupName': 'string',
            'LifeCycle': 'string',
            'OpsItemSNSTopicArn': 'string',
            'OpsCenterEnabled': True|False,
            '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.

      • OpsItemSNSTopicArn (string) --

        The SNS topic provided to Application Insights that is associated to the created opsItems to receive SNS notifications for opsItem updates.

      • OpsCenterEnabled (boolean) --

        Indicates whether Application Insights will create opsItems for any problem detected by Application Insights for an application.

      • Remarks (string) --

        The issues on the user side that block Application Insights from successfully monitoring an 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.