AWS API Changes

2020/11/23 - Amazon CloudWatch Application Insights - 8 updated api methods

Changes Add Detected Workload to ApplicationComponent which shows the workloads that installed in the component

DescribeComponent (updated)

Link ¶
Changes (response)

{'ApplicationComponent': {'ComponentRemarks': 'string',
                          'DetectedWorkload': {'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': {'string': 'string'}},
                          'OsType': 'WINDOWS | LINUX',
                          'Tier': {'CUSTOM',
                                   'DOT_NET_WEB_TIER',
                                   'JAVA_JMX',
                                   'MYSQL',
                                   'ORACLE',
                                   'POSTGRESQL',
                                   'SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP'}}}

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',
        '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': {'CUSTOM',
          'DOT_NET_WEB_TIER',
          'JAVA_JMX',
          'MYSQL',
          'ORACLE',
          'POSTGRESQL',
          'SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP'}}

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',
    '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': {'CUSTOM',
          'DOT_NET_WEB_TIER',
          'JAVA_JMX',
          'MYSQL',
          'ORACLE',
          'POSTGRESQL',
          'SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP'}}

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

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.

DescribeObservation (updated)

Link ¶
Changes (response)

{'Observation': {'CloudWatchEventSource': {'RDS'},
                 'EbsCause': 'string',
                 'EbsEvent': 'string',
                 'EbsRequestId': 'string',
                 'EbsResult': 'string',
                 'RdsEventCategories': 'string',
                 'RdsEventMessage': 'string',
                 'S3EventName': 'string',
                 'StatesArn': 'string',
                 'StatesExecutionArn': 'string',
                 'StatesInput': 'string',
                 'StatesStatus': 'string'}}

Describes an anomaly or error with the application.

See also: AWS API Documentation

Request Syntax

client.describe_observation(
    ObservationId='string'
)

type ObservationId

string

param ObservationId

[REQUIRED]

The ID of the observation.

rtype

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,
        'CloudWatchEventId': 'string',
        'CloudWatchEventSource': 'EC2'|'CODE_DEPLOY'|'HEALTH'|'RDS',
        'CloudWatchEventDetailType': 'string',
        'HealthEventArn': 'string',
        'HealthService': 'string',
        'HealthEventTypeCode': 'string',
        'HealthEventTypeCategory': 'string',
        'HealthEventDescription': 'string',
        'CodeDeployDeploymentId': 'string',
        'CodeDeployDeploymentGroup': 'string',
        'CodeDeployState': 'string',
        'CodeDeployApplication': 'string',
        'CodeDeployInstanceGroupId': 'string',
        'Ec2State': 'string',
        'RdsEventCategories': 'string',
        'RdsEventMessage': 'string',
        'S3EventName': 'string',
        'StatesExecutionArn': 'string',
        'StatesArn': 'string',
        'StatesStatus': 'string',
        'StatesInput': 'string',
        'EbsEvent': 'string',
        'EbsResult': 'string',
        'EbsCause': 'string',
        'EbsRequestId': 'string',
        'XRayFaultPercent': 123,
        'XRayThrottlePercent': 123,
        'XRayErrorPercent': 123,
        'XRayRequestCount': 123,
        'XRayRequestAverageLatency': 123,
        'XRayNodeName': 'string',
        'XRayNodeType': 'string'
    }
}

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.
  - CloudWatchEventId (string) --
    
    The ID of the CloudWatch Event-based observation related to the detected problem.
  - CloudWatchEventSource (string) --
    
    The source of the CloudWatch Event.
  - CloudWatchEventDetailType (string) --
    
    The detail type of the CloudWatch Event-based observation, for example, EC2 Instance State-change Notification .
  - HealthEventArn (string) --
    
    The Amazon Resource Name (ARN) of the AWS Health Event-based observation.
  - HealthService (string) --
    
    The service to which the AWS Health Event belongs, such as EC2.
  - HealthEventTypeCode (string) --
    
    The type of the AWS Health event, for example, AWS_EC2_POWER_CONNECTIVITY_ISSUE .
  - HealthEventTypeCategory (string) --
    
    The category of the AWS Health event, such as issue .
  - HealthEventDescription (string) --
    
    The description of the AWS Health event provided by the service, such as Amazon EC2.
  - CodeDeployDeploymentId (string) --
    
    The deployment ID of the CodeDeploy-based observation related to the detected problem.
  - CodeDeployDeploymentGroup (string) --
    
    The deployment group to which the CodeDeploy deployment belongs.
  - CodeDeployState (string) --
    
    The status of the CodeDeploy deployment, for example SUCCESS or FAILURE .
  - CodeDeployApplication (string) --
    
    The CodeDeploy application to which the deployment belongs.
  - CodeDeployInstanceGroupId (string) --
    
    The instance group to which the CodeDeploy instance belongs.
  - Ec2State (string) --
    
    The state of the instance, such as STOPPING or TERMINATING .
  - RdsEventCategories (string) --
    
    The category of an RDS event.
  - RdsEventMessage (string) --
    
    The message of an RDS event.
  - S3EventName (string) --
    
    The name of the S3 CloudWatch Event-based observation.
  - StatesExecutionArn (string) --
    
    The Amazon Resource Name (ARN) of the step function execution-based observation.
  - StatesArn (string) --
    
    The Amazon Resource Name (ARN) of the step function-based observation.
  - StatesStatus (string) --
    
    The status of the step function-related observation.
  - StatesInput (string) --
    
    The input to the step function-based observation.
  - EbsEvent (string) --
    
    The type of EBS CloudWatch event, such as createVolume , deleteVolume or attachVolume .
  - EbsResult (string) --
    
    The result of an EBS CloudWatch event, such as failed or succeeded .
  - EbsCause (string) --
    
    The cause of an EBS CloudWatch event.
  - EbsRequestId (string) --
    
    The request ID of an EBS CloudWatch event.
  - XRayFaultPercent (integer) --
    
    The X-Ray request fault percentage for this node.
  - XRayThrottlePercent (integer) --
    
    The X-Ray request throttle percentage for this node.
  - XRayErrorPercent (integer) --
    
    The X-Ray request error percentage for this node.
  - XRayRequestCount (integer) --
    
    The X-Ray request count for this node.
  - XRayRequestAverageLatency (integer) --
    
    The X-Ray node request average latency for this node.
  - XRayNodeName (string) --
    
    The name of the X-Ray node.
  - XRayNodeType (string) --
    
    The type of the X-Ray node.

DescribeProblemObservations (updated)

Link ¶
Changes (response)

{'RelatedObservations': {'ObservationList': {'CloudWatchEventSource': {'RDS'},
                                             'EbsCause': 'string',
                                             'EbsEvent': 'string',
                                             'EbsRequestId': 'string',
                                             'EbsResult': 'string',
                                             'RdsEventCategories': 'string',
                                             'RdsEventMessage': 'string',
                                             'S3EventName': 'string',
                                             'StatesArn': 'string',
                                             'StatesExecutionArn': 'string',
                                             'StatesInput': 'string',
                                             'StatesStatus': 'string'}}}

Describes the anomalies or errors associated with the problem.

See also: AWS API Documentation

Request Syntax

client.describe_problem_observations(
    ProblemId='string'
)

type ProblemId

string

param ProblemId

[REQUIRED]

The ID of the problem.

rtype

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,
                'CloudWatchEventId': 'string',
                'CloudWatchEventSource': 'EC2'|'CODE_DEPLOY'|'HEALTH'|'RDS',
                'CloudWatchEventDetailType': 'string',
                'HealthEventArn': 'string',
                'HealthService': 'string',
                'HealthEventTypeCode': 'string',
                'HealthEventTypeCategory': 'string',
                'HealthEventDescription': 'string',
                'CodeDeployDeploymentId': 'string',
                'CodeDeployDeploymentGroup': 'string',
                'CodeDeployState': 'string',
                'CodeDeployApplication': 'string',
                'CodeDeployInstanceGroupId': 'string',
                'Ec2State': 'string',
                'RdsEventCategories': 'string',
                'RdsEventMessage': 'string',
                'S3EventName': 'string',
                'StatesExecutionArn': 'string',
                'StatesArn': 'string',
                'StatesStatus': 'string',
                'StatesInput': 'string',
                'EbsEvent': 'string',
                'EbsResult': 'string',
                'EbsCause': 'string',
                'EbsRequestId': 'string',
                'XRayFaultPercent': 123,
                'XRayThrottlePercent': 123,
                'XRayErrorPercent': 123,
                'XRayRequestCount': 123,
                'XRayRequestAverageLatency': 123,
                'XRayNodeName': 'string',
                'XRayNodeType': 'string'
            },
        ]
    }
}

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.
      - CloudWatchEventId (string) --
        
        The ID of the CloudWatch Event-based observation related to the detected problem.
      - CloudWatchEventSource (string) --
        
        The source of the CloudWatch Event.
      - CloudWatchEventDetailType (string) --
        
        The detail type of the CloudWatch Event-based observation, for example, EC2 Instance State-change Notification .
      - HealthEventArn (string) --
        
        The Amazon Resource Name (ARN) of the AWS Health Event-based observation.
      - HealthService (string) --
        
        The service to which the AWS Health Event belongs, such as EC2.
      - HealthEventTypeCode (string) --
        
        The type of the AWS Health event, for example, AWS_EC2_POWER_CONNECTIVITY_ISSUE .
      - HealthEventTypeCategory (string) --
        
        The category of the AWS Health event, such as issue .
      - HealthEventDescription (string) --
        
        The description of the AWS Health event provided by the service, such as Amazon EC2.
      - CodeDeployDeploymentId (string) --
        
        The deployment ID of the CodeDeploy-based observation related to the detected problem.
      - CodeDeployDeploymentGroup (string) --
        
        The deployment group to which the CodeDeploy deployment belongs.
      - CodeDeployState (string) --
        
        The status of the CodeDeploy deployment, for example SUCCESS or FAILURE .
      - CodeDeployApplication (string) --
        
        The CodeDeploy application to which the deployment belongs.
      - CodeDeployInstanceGroupId (string) --
        
        The instance group to which the CodeDeploy instance belongs.
      - Ec2State (string) --
        
        The state of the instance, such as STOPPING or TERMINATING .
      - RdsEventCategories (string) --
        
        The category of an RDS event.
      - RdsEventMessage (string) --
        
        The message of an RDS event.
      - S3EventName (string) --
        
        The name of the S3 CloudWatch Event-based observation.
      - StatesExecutionArn (string) --
        
        The Amazon Resource Name (ARN) of the step function execution-based observation.
      - StatesArn (string) --
        
        The Amazon Resource Name (ARN) of the step function-based observation.
      - StatesStatus (string) --
        
        The status of the step function-related observation.
      - StatesInput (string) --
        
        The input to the step function-based observation.
      - EbsEvent (string) --
        
        The type of EBS CloudWatch event, such as createVolume , deleteVolume or attachVolume .
      - EbsResult (string) --
        
        The result of an EBS CloudWatch event, such as failed or succeeded .
      - EbsCause (string) --
        
        The cause of an EBS CloudWatch event.
      - EbsRequestId (string) --
        
        The request ID of an EBS CloudWatch event.
      - XRayFaultPercent (integer) --
        
        The X-Ray request fault percentage for this node.
      - XRayThrottlePercent (integer) --
        
        The X-Ray request throttle percentage for this node.
      - XRayErrorPercent (integer) --
        
        The X-Ray request error percentage for this node.
      - XRayRequestCount (integer) --
        
        The X-Ray request count for this node.
      - XRayRequestAverageLatency (integer) --
        
        The X-Ray node request average latency for this node.
      - XRayNodeName (string) --
        
        The name of the X-Ray node.
      - XRayNodeType (string) --
        
        The type of the X-Ray node.

ListComponents (updated)

Link ¶
Changes (response)

{'ApplicationComponentList': {'ComponentRemarks': 'string',
                              'DetectedWorkload': {'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': {'string': 'string'}},
                              'OsType': 'WINDOWS | LINUX',
                              'Tier': {'CUSTOM',
                                       'DOT_NET_WEB_TIER',
                                       'JAVA_JMX',
                                       'MYSQL',
                                       'ORACLE',
                                       'POSTGRESQL',
                                       'SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP'}}}

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',
            '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.

ListConfigurationHistory (updated)

Link ¶
Changes (response)

{'EventList': {'EventResourceType': {'CLOUDWATCH_LOG'}}}

Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by Application Insights. Examples of events represented are:

INFO: creating a new alarm or updating an alarm threshold.
WARN: alarm not created due to insufficient data points used to predict thresholds.
ERROR: alarm not created due to permission errors or exceeding quotas.

See also: AWS API Documentation

Request Syntax

client.list_configuration_history(
    ResourceGroupName='string',
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    EventStatus='INFO'|'WARN'|'ERROR',
    MaxResults=123,
    NextToken='string'
)

type ResourceGroupName

string

param ResourceGroupName

Resource group to which the application belongs.

type StartTime

datetime

param StartTime

The start time of the event.

type EndTime

datetime

param EndTime

The end time of the event.

type EventStatus

string

param EventStatus

The status of the configuration update event. Possible values include INFO, WARN, and ERROR.

type MaxResults

integer

param MaxResults

The maximum number of results returned by ListConfigurationHistory in paginated output. When this parameter is used, ListConfigurationHistory returns only MaxResults in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another ListConfigurationHistory request with the returned NextToken value. If this parameter is not used, then ListConfigurationHistory returns all results.

type NextToken

string

param NextToken

The NextToken value returned from a previous paginated ListConfigurationHistory request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

rtype

dict

returns

Response Syntax

{
    'EventList': [
        {
            'MonitoredResourceARN': 'string',
            'EventStatus': 'INFO'|'WARN'|'ERROR',
            'EventResourceType': 'CLOUDWATCH_ALARM'|'CLOUDWATCH_LOG'|'CLOUDFORMATION'|'SSM_ASSOCIATION',
            'EventTime': datetime(2015, 1, 1),
            'EventDetail': 'string',
            'EventResourceName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- EventList (list) --
  
  The list of configuration events and their corresponding details.
  - (dict) --
    
    The event information.
    - MonitoredResourceARN (string) --
      
      The resource monitored by Application Insights.
    - EventStatus (string) --
      
      The status of the configuration update event. Possible values include INFO, WARN, and ERROR.
    - EventResourceType (string) --
      
      The resource type that Application Insights attempted to configure, for example, CLOUDWATCH_ALARM.
    - EventTime (datetime) --
      
      The timestamp of the event.
    - EventDetail (string) --
      
      The details of the event in plain text.
    - EventResourceName (string) --
      
      The name of the resource Application Insights attempted to configure.
- NextToken (string) --
  
  The NextToken value to include in a future ListConfigurationHistory request. When the results of a ListConfigurationHistory request exceed MaxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

UpdateComponentConfiguration (updated)

Link ¶
Changes (request)

{'Tier': {'CUSTOM',
          'DOT_NET_WEB_TIER',
          'JAVA_JMX',
          'MYSQL',
          'ORACLE',
          'POSTGRESQL',
          'SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP'}}

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',
    ComponentConfiguration='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 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 .

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --