AWS API Changes

2022/01/14 - Amazon CloudWatch Application Insights - 5 updated api methods

DescribeComponent (updated)

Link ¶
Changes (response)

{'ApplicationComponent': {'Tier': {'ACTIVE_DIRECTORY', 'SHAREPOINT'}}}

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

type ResourceGroupName

string

param ResourceGroupName

[REQUIRED]

The name of the resource group.

type ComponentName

string

param ComponentName

[REQUIRED]

The name of the component.

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'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'|'SHAREPOINT'|'ACTIVE_DIRECTORY',
        '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': {'ACTIVE_DIRECTORY', 'SHAREPOINT'}}

Describes the monitoring configuration of the component.

See also: AWS API Documentation

Request Syntax

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

type ResourceGroupName

string

param ResourceGroupName

[REQUIRED]

The name of the resource group.

type ComponentName

string

param ComponentName

[REQUIRED]

The name of the component.

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'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'|'SHAREPOINT'|'ACTIVE_DIRECTORY',
    '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': {'ACTIVE_DIRECTORY', 'SHAREPOINT'}}

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'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'|'SHAREPOINT'|'ACTIVE_DIRECTORY'
)

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. Supported tiers include DOT_NET_CORE , DOT_NET_WORKER , DOT_NET_WEB , SQL_SERVER , and DEFAULT .

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.

ListComponents (updated)

Link ¶
Changes (response)

{'ApplicationComponentList': {'Tier': {'ACTIVE_DIRECTORY', 'SHAREPOINT'}}}

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

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.

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'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'|'SHAREPOINT'|'ACTIVE_DIRECTORY',
            '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.

UpdateComponentConfiguration (updated)

Link ¶
Changes (request)

{'Tier': {'ACTIVE_DIRECTORY', 'SHAREPOINT'}}

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'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'|'SHAREPOINT'|'ACTIVE_DIRECTORY',
    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. Supported tiers include DOT_NET_WORKER , DOT_NET_WEB , DOT_NET_CORE , SQL_SERVER , and DEFAULT .

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

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --