AWS API Changes

2024/10/21 - Amazon CloudWatch Application Insights - 15 updated api methods

Changes This feature enables customers to specify SNS Topic ARN. CloudWatch Application Insights (CWAI) will utilize this ARN to send problem notifications.

AddWorkload (updated)

Link ¶
Changes (both)

{'WorkloadConfiguration': {'Tier': {'SAP_ASE_HIGH_AVAILABILITY',
                                    'SAP_ASE_SINGLE_NODE'}}}

Adds a workload to a component. Each component can have at most five workloads.

See also: AWS API Documentation

Request Syntax

client.add_workload(
    ResourceGroupName='string',
    ComponentName='string',
    WorkloadConfiguration={
        'WorkloadName': 'string',
        'Tier': 'CUSTOM'|'DEFAULT'|'DOT_NET_CORE'|'DOT_NET_WORKER'|'DOT_NET_WEB_TIER'|'DOT_NET_WEB'|'SQL_SERVER'|'SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP'|'MYSQL'|'POSTGRESQL'|'JAVA_JMX'|'ORACLE'|'SAP_HANA_MULTI_NODE'|'SAP_HANA_SINGLE_NODE'|'SAP_HANA_HIGH_AVAILABILITY'|'SAP_ASE_SINGLE_NODE'|'SAP_ASE_HIGH_AVAILABILITY'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'|'SHAREPOINT'|'ACTIVE_DIRECTORY'|'SAP_NETWEAVER_STANDARD'|'SAP_NETWEAVER_DISTRIBUTED'|'SAP_NETWEAVER_HIGH_AVAILABILITY',
        'Configuration': 'string'
    }
)

type ResourceGroupName

string

param ResourceGroupName

[REQUIRED]

The name of the resource group.

type ComponentName

string

param ComponentName

[REQUIRED]

The name of the component.

type WorkloadConfiguration

dict

param WorkloadConfiguration

[REQUIRED]

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

WorkloadName (string) --

The name of the workload.
Tier (string) --

The configuration of the workload tier.
Configuration (string) --

The configuration settings of the workload.

rtype

dict

returns

Response Syntax

{
    'WorkloadId': 'string',
    'WorkloadConfiguration': {
        'WorkloadName': 'string',
        'Tier': 'CUSTOM'|'DEFAULT'|'DOT_NET_CORE'|'DOT_NET_WORKER'|'DOT_NET_WEB_TIER'|'DOT_NET_WEB'|'SQL_SERVER'|'SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP'|'MYSQL'|'POSTGRESQL'|'JAVA_JMX'|'ORACLE'|'SAP_HANA_MULTI_NODE'|'SAP_HANA_SINGLE_NODE'|'SAP_HANA_HIGH_AVAILABILITY'|'SAP_ASE_SINGLE_NODE'|'SAP_ASE_HIGH_AVAILABILITY'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'|'SHAREPOINT'|'ACTIVE_DIRECTORY'|'SAP_NETWEAVER_STANDARD'|'SAP_NETWEAVER_DISTRIBUTED'|'SAP_NETWEAVER_HIGH_AVAILABILITY',
        'Configuration': 'string'
    }
}

Response Structure

(dict) --
- WorkloadId (string) --
  
  The ID of the workload.
- WorkloadConfiguration (dict) --
  
  The configuration settings of the workload. The value is the escaped JSON of the configuration.
  - WorkloadName (string) --
    
    The name of the workload.
  - Tier (string) --
    
    The configuration of the workload tier.
  - Configuration (string) --
    
    The configuration settings of the workload.

CreateApplication (updated)

Link ¶
Changes (request, response)
Request

{'SNSNotificationArn': 'string'}

Response

{'ApplicationInfo': {'SNSNotificationArn': '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,
    CWEMonitorEnabled=True|False,
    OpsItemSNSTopicArn='string',
    SNSNotificationArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    AutoConfigEnabled=True|False,
    AutoCreate=True|False,
    GroupingType='ACCOUNT_BASED',
    AttachMissingPermission=True|False
)

type ResourceGroupName

string

param ResourceGroupName

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 CWEMonitorEnabled

boolean

param CWEMonitorEnabled

Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated , failed deployment , and others.

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 SNSNotificationArn

string

param SNSNotificationArn

The SNS notification topic ARN.

type Tags

list

param Tags

List of tags to add to the application. tag key ( Key ) and an associated tag value ( Value ). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

(dict) --

An object that defines the tags associated with an application. A tag is a label that you optionally define and associate with an application. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria.

Each tag consists of a required tag key and an associated tag value , both of which you define. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:
- Tag keys and values are case sensitive.
- For each associated resource, each tag key must be unique and it can have only one value.
- The aws: prefix is reserved for use by Amazon Web Services; you can’t use it in any tag keys or values that you define. In addition, you can't edit or remove tag keys or values that use this prefix.
- Key (string) -- [REQUIRED]
  
  One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.
- Value (string) -- [REQUIRED]
  
  The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don't want an application to have a specific tag value, don't specify a value for this parameter.

type AutoConfigEnabled

boolean

param AutoConfigEnabled

Indicates whether Application Insights automatically configures unmonitored resources in the resource group.

type AutoCreate

boolean

param AutoCreate

Configures all of the resources in the resource group by applying the recommended configurations.

type GroupingType

string

param GroupingType

Application Insights can create applications based on a resource group or on an account. To create an account-based application using all of the resources in the account, set this parameter to ACCOUNT_BASED .

type AttachMissingPermission

boolean

param AttachMissingPermission

If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing.

rtype

dict

returns

Response Syntax

{
    'ApplicationInfo': {
        'AccountId': 'string',
        'ResourceGroupName': 'string',
        'LifeCycle': 'string',
        'OpsItemSNSTopicArn': 'string',
        'SNSNotificationArn': 'string',
        'OpsCenterEnabled': True|False,
        'CWEMonitorEnabled': True|False,
        'Remarks': 'string',
        'AutoConfigEnabled': True|False,
        'DiscoveryType': 'RESOURCE_GROUP_BASED'|'ACCOUNT_BASED',
        'AttachMissingPermission': True|False
    }
}

Response Structure

(dict) --
- ApplicationInfo (dict) --
  
  Information about the application.
  - AccountId (string) --
    
    The Amazon Web Services account ID for the owner 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.
  - SNSNotificationArn (string) --
    
    The SNS topic ARN that is associated with SNS notifications for updates or issues.
  - OpsCenterEnabled (boolean) --
    
    Indicates whether Application Insights will create opsItems for any problem detected by Application Insights for an application.
  - CWEMonitorEnabled (boolean) --
    
    Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated , failed deployment , and others.
  - Remarks (string) --
    
    The issues on the user side that block Application Insights from successfully monitoring an application. Example remarks include:
    - “Configuring application, detected 1 Errors, 3 Warnings”
    - “Configuring application, detected 1 Unconfigured Components”
  - AutoConfigEnabled (boolean) --
    
    Indicates whether auto-configuration is turned on for this application.
  - DiscoveryType (string) --
    
    The method used by Application Insights to onboard your resources.
  - AttachMissingPermission (boolean) --
    
    If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing.

DescribeApplication (updated)

Link ¶
Changes (response)

{'ApplicationInfo': {'SNSNotificationArn': 'string'}}

Describes the application.

See also: AWS API Documentation

Request Syntax

client.describe_application(
    ResourceGroupName='string',
    AccountId='string'
)

type ResourceGroupName

string

param ResourceGroupName

[REQUIRED]

The name of the resource group.

type AccountId

string

param AccountId

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

rtype

dict

returns

Response Syntax

{
    'ApplicationInfo': {
        'AccountId': 'string',
        'ResourceGroupName': 'string',
        'LifeCycle': 'string',
        'OpsItemSNSTopicArn': 'string',
        'SNSNotificationArn': 'string',
        'OpsCenterEnabled': True|False,
        'CWEMonitorEnabled': True|False,
        'Remarks': 'string',
        'AutoConfigEnabled': True|False,
        'DiscoveryType': 'RESOURCE_GROUP_BASED'|'ACCOUNT_BASED',
        'AttachMissingPermission': True|False
    }
}

Response Structure

(dict) --
- ApplicationInfo (dict) --
  
  Information about the application.
  - AccountId (string) --
    
    The Amazon Web Services account ID for the owner 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.
  - SNSNotificationArn (string) --
    
    The SNS topic ARN that is associated with SNS notifications for updates or issues.
  - OpsCenterEnabled (boolean) --
    
    Indicates whether Application Insights will create opsItems for any problem detected by Application Insights for an application.
  - CWEMonitorEnabled (boolean) --
    
    Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated , failed deployment , and others.
  - Remarks (string) --
    
    The issues on the user side that block Application Insights from successfully monitoring an application. Example remarks include:
    - “Configuring application, detected 1 Errors, 3 Warnings”
    - “Configuring application, detected 1 Unconfigured Components”
  - AutoConfigEnabled (boolean) --
    
    Indicates whether auto-configuration is turned on for this application.
  - DiscoveryType (string) --
    
    The method used by Application Insights to onboard your resources.
  - AttachMissingPermission (boolean) --
    
    If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing.

DescribeComponent (updated)

Link ¶
Changes (response)

{'ApplicationComponent': {'Tier': {'SAP_ASE_HIGH_AVAILABILITY',
                                   'SAP_ASE_SINGLE_NODE'}}}

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

See also: AWS API Documentation

Request Syntax

client.describe_component(
    ResourceGroupName='string',
    ComponentName='string',
    AccountId='string'
)

type ResourceGroupName

string

param ResourceGroupName

[REQUIRED]

The name of the resource group.

type ComponentName

string

param ComponentName

[REQUIRED]

The name of the component.

type AccountId

string

param AccountId

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

rtype

dict

returns

Response Syntax

{
    'ApplicationComponent': {
        'ComponentName': 'string',
        'ComponentRemarks': 'string',
        'ResourceType': 'string',
        'OsType': 'WINDOWS'|'LINUX',
        'Tier': 'CUSTOM'|'DEFAULT'|'DOT_NET_CORE'|'DOT_NET_WORKER'|'DOT_NET_WEB_TIER'|'DOT_NET_WEB'|'SQL_SERVER'|'SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP'|'MYSQL'|'POSTGRESQL'|'JAVA_JMX'|'ORACLE'|'SAP_HANA_MULTI_NODE'|'SAP_HANA_SINGLE_NODE'|'SAP_HANA_HIGH_AVAILABILITY'|'SAP_ASE_SINGLE_NODE'|'SAP_ASE_HIGH_AVAILABILITY'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'|'SHAREPOINT'|'ACTIVE_DIRECTORY'|'SAP_NETWEAVER_STANDARD'|'SAP_NETWEAVER_DISTRIBUTED'|'SAP_NETWEAVER_HIGH_AVAILABILITY',
        'Monitor': True|False,
        'DetectedWorkload': {
            'string': {
                'string': 'string'
            }
        }
    },
    '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.
  - ComponentRemarks (string) --
    
    If logging is supported for the resource type, indicates whether the component has configured logs to be monitored.
  - ResourceType (string) --
    
    The resource type. Supported resource types include EC2 instances, Auto Scaling group, Classic ELB, Application ELB, and SQS Queue.
  - OsType (string) --
    
    The operating system of the component.
  - Tier (string) --
    
    The stack tier of the application component.
  - Monitor (boolean) --
    
    Indicates whether the application component is monitored.
  - DetectedWorkload (dict) --
    
    Workloads detected in the application component.
    - (string) --
      - (dict) --
        
        (string) --
        
        (string) --
- ResourceList (list) --
  
  The list of resource ARNs that belong to the component.
  - (string) --

DescribeComponentConfiguration (updated)

Link ¶
Changes (response)

{'Tier': {'SAP_ASE_SINGLE_NODE', 'SAP_ASE_HIGH_AVAILABILITY'}}

Describes the monitoring configuration of the component.

See also: AWS API Documentation

Request Syntax

client.describe_component_configuration(
    ResourceGroupName='string',
    ComponentName='string',
    AccountId='string'
)

type ResourceGroupName

string

param ResourceGroupName

[REQUIRED]

The name of the resource group.

type ComponentName

string

param ComponentName

[REQUIRED]

The name of the component.

type AccountId

string

param AccountId

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

rtype

dict

returns

Response Syntax

{
    'Monitor': True|False,
    'Tier': 'CUSTOM'|'DEFAULT'|'DOT_NET_CORE'|'DOT_NET_WORKER'|'DOT_NET_WEB_TIER'|'DOT_NET_WEB'|'SQL_SERVER'|'SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP'|'MYSQL'|'POSTGRESQL'|'JAVA_JMX'|'ORACLE'|'SAP_HANA_MULTI_NODE'|'SAP_HANA_SINGLE_NODE'|'SAP_HANA_HIGH_AVAILABILITY'|'SAP_ASE_SINGLE_NODE'|'SAP_ASE_HIGH_AVAILABILITY'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'|'SHAREPOINT'|'ACTIVE_DIRECTORY'|'SAP_NETWEAVER_STANDARD'|'SAP_NETWEAVER_DISTRIBUTED'|'SAP_NETWEAVER_HIGH_AVAILABILITY',
    '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_CORE , DOT_NET_WORKER , DOT_NET_WEB , SQL_SERVER , and DEFAULT
- ComponentConfiguration (string) --
  
  The configuration settings of the component. The value is the escaped JSON of the configuration.

DescribeComponentConfigurationRecommendation (updated)

Link ¶
Changes (request)

{'Tier': {'SAP_ASE_SINGLE_NODE', 'SAP_ASE_HIGH_AVAILABILITY'}}

Describes the recommended monitoring configuration of the component.

See also: AWS API Documentation

Request Syntax

client.describe_component_configuration_recommendation(
    ResourceGroupName='string',
    ComponentName='string',
    Tier='CUSTOM'|'DEFAULT'|'DOT_NET_CORE'|'DOT_NET_WORKER'|'DOT_NET_WEB_TIER'|'DOT_NET_WEB'|'SQL_SERVER'|'SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP'|'MYSQL'|'POSTGRESQL'|'JAVA_JMX'|'ORACLE'|'SAP_HANA_MULTI_NODE'|'SAP_HANA_SINGLE_NODE'|'SAP_HANA_HIGH_AVAILABILITY'|'SAP_ASE_SINGLE_NODE'|'SAP_ASE_HIGH_AVAILABILITY'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'|'SHAREPOINT'|'ACTIVE_DIRECTORY'|'SAP_NETWEAVER_STANDARD'|'SAP_NETWEAVER_DISTRIBUTED'|'SAP_NETWEAVER_HIGH_AVAILABILITY',
    WorkloadName='string',
    RecommendationType='INFRA_ONLY'|'WORKLOAD_ONLY'|'ALL'
)

type ResourceGroupName

string

param ResourceGroupName

[REQUIRED]

The name of the resource group.

type ComponentName

string

param ComponentName

[REQUIRED]

The name of the component.

type Tier

string

param Tier

[REQUIRED]

The tier of the application component.

type WorkloadName

string

param WorkloadName

The name of the workload. The name of the workload is required when the tier of the application component is SAP_ASE_SINGLE_NODE or SAP_ASE_HIGH_AVAILABILITY .

type RecommendationType

string

param RecommendationType

The recommended configuration type.

rtype

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.

DescribeProblem (updated)

Link ¶
Changes (response)

{'Problem': {'ShortName': 'string'}, 'SNSNotificationArn': 'string'}

Describes an application problem.

See also: AWS API Documentation

Request Syntax

client.describe_problem(
    ProblemId='string',
    AccountId='string'
)

type ProblemId

string

param ProblemId

[REQUIRED]

The ID of the problem.

type AccountId

string

param AccountId

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

rtype

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.

DescribeWorkload (updated)

Link ¶
Changes (response)

{'WorkloadConfiguration': {'Tier': {'SAP_ASE_HIGH_AVAILABILITY',
                                    'SAP_ASE_SINGLE_NODE'}}}

Describes a workload and its configuration.

See also: AWS API Documentation

Request Syntax

client.describe_workload(
    ResourceGroupName='string',
    ComponentName='string',
    WorkloadId='string',
    AccountId='string'
)

type ResourceGroupName

string

param ResourceGroupName

[REQUIRED]

The name of the resource group.

type ComponentName

string

param ComponentName

[REQUIRED]

The name of the component.

type WorkloadId

string

param WorkloadId

[REQUIRED]

The ID of the workload.

type AccountId

string

param AccountId

The Amazon Web Services account ID for the workload owner.

rtype

dict

returns

Response Syntax

{
    'WorkloadId': 'string',
    'WorkloadRemarks': 'string',
    'WorkloadConfiguration': {
        'WorkloadName': 'string',
        'Tier': 'CUSTOM'|'DEFAULT'|'DOT_NET_CORE'|'DOT_NET_WORKER'|'DOT_NET_WEB_TIER'|'DOT_NET_WEB'|'SQL_SERVER'|'SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP'|'MYSQL'|'POSTGRESQL'|'JAVA_JMX'|'ORACLE'|'SAP_HANA_MULTI_NODE'|'SAP_HANA_SINGLE_NODE'|'SAP_HANA_HIGH_AVAILABILITY'|'SAP_ASE_SINGLE_NODE'|'SAP_ASE_HIGH_AVAILABILITY'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'|'SHAREPOINT'|'ACTIVE_DIRECTORY'|'SAP_NETWEAVER_STANDARD'|'SAP_NETWEAVER_DISTRIBUTED'|'SAP_NETWEAVER_HIGH_AVAILABILITY',
        'Configuration': 'string'
    }
}

Response Structure

(dict) --
- WorkloadId (string) --
  
  The ID of the workload.
- WorkloadRemarks (string) --
  
  If logging is supported for the resource type, shows whether the component has configured logs to be monitored.
- WorkloadConfiguration (dict) --
  
  The configuration settings of the workload. The value is the escaped JSON of the configuration.
  - WorkloadName (string) --
    
    The name of the workload.
  - Tier (string) --
    
    The configuration of the workload tier.
  - Configuration (string) --
    
    The configuration settings of the workload.

ListApplications (updated)

Link ¶
Changes (response)

{'ApplicationInfoList': {'SNSNotificationArn': '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',
    AccountId='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.

type AccountId

string

param AccountId

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

rtype

dict

returns

Response Syntax

{
    'ApplicationInfoList': [
        {
            'AccountId': 'string',
            'ResourceGroupName': 'string',
            'LifeCycle': 'string',
            'OpsItemSNSTopicArn': 'string',
            'SNSNotificationArn': 'string',
            'OpsCenterEnabled': True|False,
            'CWEMonitorEnabled': True|False,
            'Remarks': 'string',
            'AutoConfigEnabled': True|False,
            'DiscoveryType': 'RESOURCE_GROUP_BASED'|'ACCOUNT_BASED',
            'AttachMissingPermission': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- ApplicationInfoList (list) --
  
  The list of applications.
  - (dict) --
    
    Describes the status of the application.
    - AccountId (string) --
      
      The Amazon Web Services account ID for the owner 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.
    - SNSNotificationArn (string) --
      
      The SNS topic ARN that is associated with SNS notifications for updates or issues.
    - OpsCenterEnabled (boolean) --
      
      Indicates whether Application Insights will create opsItems for any problem detected by Application Insights for an application.
    - CWEMonitorEnabled (boolean) --
      
      Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated , failed deployment , and others.
    - Remarks (string) --
      
      The issues on the user side that block Application Insights from successfully monitoring an application. Example remarks include:
      - “Configuring application, detected 1 Errors, 3 Warnings”
      - “Configuring application, detected 1 Unconfigured Components”
    - AutoConfigEnabled (boolean) --
      
      Indicates whether auto-configuration is turned on for this application.
    - DiscoveryType (string) --
      
      The method used by Application Insights to onboard your resources.
    - AttachMissingPermission (boolean) --
      
      If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing.
- NextToken (string) --
  
  The token used to retrieve the next page of results. This value is null when there are no more results to return.

ListComponents (updated)

Link ¶
Changes (response)

{'ApplicationComponentList': {'Tier': {'SAP_ASE_HIGH_AVAILABILITY',
                                       'SAP_ASE_SINGLE_NODE'}}}

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

See also: AWS API Documentation

Request Syntax

client.list_components(
    ResourceGroupName='string',
    MaxResults=123,
    NextToken='string',
    AccountId='string'
)

type ResourceGroupName

string

param ResourceGroupName

[REQUIRED]

The name of the resource group.

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.

type AccountId

string

param AccountId

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

rtype

dict

returns

Response Syntax

{
    'ApplicationComponentList': [
        {
            'ComponentName': 'string',
            'ComponentRemarks': 'string',
            'ResourceType': 'string',
            'OsType': 'WINDOWS'|'LINUX',
            'Tier': 'CUSTOM'|'DEFAULT'|'DOT_NET_CORE'|'DOT_NET_WORKER'|'DOT_NET_WEB_TIER'|'DOT_NET_WEB'|'SQL_SERVER'|'SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP'|'MYSQL'|'POSTGRESQL'|'JAVA_JMX'|'ORACLE'|'SAP_HANA_MULTI_NODE'|'SAP_HANA_SINGLE_NODE'|'SAP_HANA_HIGH_AVAILABILITY'|'SAP_ASE_SINGLE_NODE'|'SAP_ASE_HIGH_AVAILABILITY'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'|'SHAREPOINT'|'ACTIVE_DIRECTORY'|'SAP_NETWEAVER_STANDARD'|'SAP_NETWEAVER_DISTRIBUTED'|'SAP_NETWEAVER_HIGH_AVAILABILITY',
            'Monitor': True|False,
            'DetectedWorkload': {
                'string': {
                    'string': 'string'
                }
            }
        },
    ],
    '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.
    - ComponentRemarks (string) --
      
      If logging is supported for the resource type, indicates whether the component has configured logs to be monitored.
    - ResourceType (string) --
      
      The resource type. Supported resource types include EC2 instances, Auto Scaling group, Classic ELB, Application ELB, and SQS Queue.
    - OsType (string) --
      
      The operating system of the component.
    - Tier (string) --
      
      The stack tier of the application component.
    - Monitor (boolean) --
      
      Indicates whether the application component is monitored.
    - DetectedWorkload (dict) --
      
      Workloads detected in the application component.
      - (string) --
        
        (dict) --
        
        (string) --
        
        (string) --
- NextToken (string) --
  
  The token to request the next page of results.

ListProblems (updated)

Link ¶
Changes (response)

{'ProblemList': {'ShortName': 'string'}}

Lists the problems with your application.

See also: AWS API Documentation

Request Syntax

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'
)

type AccountId

string

param AccountId

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

type ResourceGroupName

string

param ResourceGroupName

The name of the resource group.

type StartTime

datetime

param StartTime

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.

type EndTime

datetime

param EndTime

The time when the problem ended, in epoch seconds. If not specified, problems within the past seven days are returned.

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.

type ComponentName

string

param ComponentName

The name of the component.

type Visibility

string

param Visibility

Specifies whether or not you can view the problem. If not specified, visible and ignored problems are returned.

rtype

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.

ListWorkloads (updated)

Link ¶
Changes (response)

{'WorkloadList': {'MissingWorkloadConfig': 'boolean',
                  'Tier': {'SAP_ASE_SINGLE_NODE', 'SAP_ASE_HIGH_AVAILABILITY'}}}

Lists the workloads that are configured on a given component.

See also: AWS API Documentation

Request Syntax

client.list_workloads(
    ResourceGroupName='string',
    ComponentName='string',
    MaxResults=123,
    NextToken='string',
    AccountId='string'
)

type ResourceGroupName

string

param ResourceGroupName

[REQUIRED]

The name of the resource group.

type ComponentName

string

param ComponentName

[REQUIRED]

The name of the component.

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.

type AccountId

string

param AccountId

The Amazon Web Services account ID of the owner of the workload.

rtype

dict

returns

Response Syntax

{
    'WorkloadList': [
        {
            'WorkloadId': 'string',
            'ComponentName': 'string',
            'WorkloadName': 'string',
            'Tier': 'CUSTOM'|'DEFAULT'|'DOT_NET_CORE'|'DOT_NET_WORKER'|'DOT_NET_WEB_TIER'|'DOT_NET_WEB'|'SQL_SERVER'|'SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP'|'MYSQL'|'POSTGRESQL'|'JAVA_JMX'|'ORACLE'|'SAP_HANA_MULTI_NODE'|'SAP_HANA_SINGLE_NODE'|'SAP_HANA_HIGH_AVAILABILITY'|'SAP_ASE_SINGLE_NODE'|'SAP_ASE_HIGH_AVAILABILITY'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'|'SHAREPOINT'|'ACTIVE_DIRECTORY'|'SAP_NETWEAVER_STANDARD'|'SAP_NETWEAVER_DISTRIBUTED'|'SAP_NETWEAVER_HIGH_AVAILABILITY',
            'WorkloadRemarks': 'string',
            'MissingWorkloadConfig': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- WorkloadList (list) --
  
  The list of workloads.
  - (dict) --
    
    Describes the workloads on a component.
    - WorkloadId (string) --
      
      The ID of the workload.
    - ComponentName (string) --
      
      The name of the component.
    - WorkloadName (string) --
      
      The name of the workload.
    - Tier (string) --
      
      The tier of the workload.
    - WorkloadRemarks (string) --
      
      If logging is supported for the resource type, shows whether the component has configured logs to be monitored.
    - MissingWorkloadConfig (boolean) --
      
      Indicates whether all of the component configurations required to monitor a workload were provided.
- NextToken (string) --
  
  The token to request the next page of results.

UpdateApplication (updated)

Link ¶
Changes (request, response)
Request

{'SNSNotificationArn': 'string'}

Response

{'ApplicationInfo': {'SNSNotificationArn': 'string'}}

Updates the application.

See also: AWS API Documentation

Request Syntax

client.update_application(
    ResourceGroupName='string',
    OpsCenterEnabled=True|False,
    CWEMonitorEnabled=True|False,
    OpsItemSNSTopicArn='string',
    SNSNotificationArn='string',
    RemoveSNSTopic=True|False,
    AutoConfigEnabled=True|False,
    AttachMissingPermission=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 CWEMonitorEnabled

boolean

param CWEMonitorEnabled

Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated , failed deployment , and others.

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 SNSNotificationArn

string

param SNSNotificationArn

The SNS topic ARN. Allows you to receive SNS notifications for updates and issues with an application.

type RemoveSNSTopic

boolean

param RemoveSNSTopic

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

type AutoConfigEnabled

boolean

param AutoConfigEnabled

Turns auto-configuration on or off.

type AttachMissingPermission

boolean

param AttachMissingPermission

If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing.

rtype

dict

returns

Response Syntax

{
    'ApplicationInfo': {
        'AccountId': 'string',
        'ResourceGroupName': 'string',
        'LifeCycle': 'string',
        'OpsItemSNSTopicArn': 'string',
        'SNSNotificationArn': 'string',
        'OpsCenterEnabled': True|False,
        'CWEMonitorEnabled': True|False,
        'Remarks': 'string',
        'AutoConfigEnabled': True|False,
        'DiscoveryType': 'RESOURCE_GROUP_BASED'|'ACCOUNT_BASED',
        'AttachMissingPermission': True|False
    }
}

Response Structure

(dict) --
- ApplicationInfo (dict) --
  
  Information about the application.
  - AccountId (string) --
    
    The Amazon Web Services account ID for the owner 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.
  - SNSNotificationArn (string) --
    
    The SNS topic ARN that is associated with SNS notifications for updates or issues.
  - OpsCenterEnabled (boolean) --
    
    Indicates whether Application Insights will create opsItems for any problem detected by Application Insights for an application.
  - CWEMonitorEnabled (boolean) --
    
    Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated , failed deployment , and others.
  - Remarks (string) --
    
    The issues on the user side that block Application Insights from successfully monitoring an application. Example remarks include:
    - “Configuring application, detected 1 Errors, 3 Warnings”
    - “Configuring application, detected 1 Unconfigured Components”
  - AutoConfigEnabled (boolean) --
    
    Indicates whether auto-configuration is turned on for this application.
  - DiscoveryType (string) --
    
    The method used by Application Insights to onboard your resources.
  - AttachMissingPermission (boolean) --
    
    If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing.

UpdateComponentConfiguration (updated)

Link ¶
Changes (request)

{'Tier': {'SAP_ASE_SINGLE_NODE', 'SAP_ASE_HIGH_AVAILABILITY'}}

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

client.update_component_configuration(
    ResourceGroupName='string',
    ComponentName='string',
    Monitor=True|False,
    Tier='CUSTOM'|'DEFAULT'|'DOT_NET_CORE'|'DOT_NET_WORKER'|'DOT_NET_WEB_TIER'|'DOT_NET_WEB'|'SQL_SERVER'|'SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP'|'MYSQL'|'POSTGRESQL'|'JAVA_JMX'|'ORACLE'|'SAP_HANA_MULTI_NODE'|'SAP_HANA_SINGLE_NODE'|'SAP_HANA_HIGH_AVAILABILITY'|'SAP_ASE_SINGLE_NODE'|'SAP_ASE_HIGH_AVAILABILITY'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'|'SHAREPOINT'|'ACTIVE_DIRECTORY'|'SAP_NETWEAVER_STANDARD'|'SAP_NETWEAVER_DISTRIBUTED'|'SAP_NETWEAVER_HIGH_AVAILABILITY',
    ComponentConfiguration='string',
    AutoConfigEnabled=True|False
)

type ResourceGroupName

string

param ResourceGroupName

[REQUIRED]

The name of the resource group.

type ComponentName

string

param ComponentName

[REQUIRED]

The name of the component.

type Monitor

boolean

param Monitor

Indicates whether the application component is monitored.

type Tier

string

param Tier

The tier of the application component.

type ComponentConfiguration

string

param ComponentConfiguration

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. For the complete format of the component configuration file, see Component Configuration.

type AutoConfigEnabled

boolean

param AutoConfigEnabled

Automatically configures the component by applying the recommended configurations.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

UpdateWorkload (updated)

Link ¶
Changes (both)

{'WorkloadConfiguration': {'Tier': {'SAP_ASE_HIGH_AVAILABILITY',
                                    'SAP_ASE_SINGLE_NODE'}}}

Adds a workload to a component. Each component can have at most five workloads.

See also: AWS API Documentation

Request Syntax

client.update_workload(
    ResourceGroupName='string',
    ComponentName='string',
    WorkloadId='string',
    WorkloadConfiguration={
        'WorkloadName': 'string',
        'Tier': 'CUSTOM'|'DEFAULT'|'DOT_NET_CORE'|'DOT_NET_WORKER'|'DOT_NET_WEB_TIER'|'DOT_NET_WEB'|'SQL_SERVER'|'SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP'|'MYSQL'|'POSTGRESQL'|'JAVA_JMX'|'ORACLE'|'SAP_HANA_MULTI_NODE'|'SAP_HANA_SINGLE_NODE'|'SAP_HANA_HIGH_AVAILABILITY'|'SAP_ASE_SINGLE_NODE'|'SAP_ASE_HIGH_AVAILABILITY'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'|'SHAREPOINT'|'ACTIVE_DIRECTORY'|'SAP_NETWEAVER_STANDARD'|'SAP_NETWEAVER_DISTRIBUTED'|'SAP_NETWEAVER_HIGH_AVAILABILITY',
        'Configuration': 'string'
    }
)

type ResourceGroupName

string

param ResourceGroupName

[REQUIRED]

The name of the resource group.

type ComponentName

string

param ComponentName

[REQUIRED]

The name of the component.

type WorkloadId

string

param WorkloadId

The ID of the workload.

type WorkloadConfiguration

dict

param WorkloadConfiguration

[REQUIRED]

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

WorkloadName (string) --

The name of the workload.
Tier (string) --

The configuration of the workload tier.
Configuration (string) --

The configuration settings of the workload.

rtype

dict

returns

Response Syntax

{
    'WorkloadId': 'string',
    'WorkloadConfiguration': {
        'WorkloadName': 'string',
        'Tier': 'CUSTOM'|'DEFAULT'|'DOT_NET_CORE'|'DOT_NET_WORKER'|'DOT_NET_WEB_TIER'|'DOT_NET_WEB'|'SQL_SERVER'|'SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP'|'MYSQL'|'POSTGRESQL'|'JAVA_JMX'|'ORACLE'|'SAP_HANA_MULTI_NODE'|'SAP_HANA_SINGLE_NODE'|'SAP_HANA_HIGH_AVAILABILITY'|'SAP_ASE_SINGLE_NODE'|'SAP_ASE_HIGH_AVAILABILITY'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'|'SHAREPOINT'|'ACTIVE_DIRECTORY'|'SAP_NETWEAVER_STANDARD'|'SAP_NETWEAVER_DISTRIBUTED'|'SAP_NETWEAVER_HIGH_AVAILABILITY',
        'Configuration': 'string'
    }
}

Response Structure

(dict) --
- WorkloadId (string) --
  
  The ID of the workload.
- WorkloadConfiguration (dict) --
  
  The configuration settings of the workload. The value is the escaped JSON of the configuration.
  - WorkloadName (string) --
    
    The name of the workload.
  - Tier (string) --
    
    The configuration of the workload tier.
  - Configuration (string) --
    
    The configuration settings of the workload.