'2.0', 'service' => '
Amazon CloudWatch Application Insights is a service that helps you detect common problems with your applications. It enables you to pinpoint the source of issues in your applications (built with technologies such as Microsoft IIS, .NET, and Microsoft SQL Server), by providing key insights into detected problems.
After you onboard your application, CloudWatch Application Insights identifies, recommends, and sets up metrics and logs. It continuously analyzes and correlates your metrics and logs for unusual behavior to surface actionable problems with your application. For example, if your application is slow and unresponsive and leading to HTTP 500 errors in your Application Load Balancer (ALB), Application Insights informs you that a memory pressure problem with your SQL Server database is occurring. It bases this analysis on impactful metrics and log errors.
', 'operations' => [ 'AddWorkload' => 'Adds a workload to a component. Each component can have at most five workloads.
', 'CreateApplication' => 'Adds an application that is created from a resource group.
', 'CreateComponent' => 'Creates a custom component by grouping similar standalone instances to monitor.
', 'CreateLogPattern' => 'Adds an log pattern to a LogPatternSet
.
Removes the specified application from monitoring. Does not delete the application.
', 'DeleteComponent' => 'Ungroups a custom component. When you ungroup custom components, all applicable monitors that are set up for the component are removed and the instances revert to their standalone status.
', 'DeleteLogPattern' => 'Removes the specified log pattern from a LogPatternSet
.
Describes the application.
', 'DescribeComponent' => 'Describes a component and lists the resources that are grouped together in a component.
', 'DescribeComponentConfiguration' => 'Describes the monitoring configuration of the component.
', 'DescribeComponentConfigurationRecommendation' => 'Describes the recommended monitoring configuration of the component.
', 'DescribeLogPattern' => 'Describe a specific log pattern from a LogPatternSet
.
Describes an anomaly or error with the application.
', 'DescribeProblem' => 'Describes an application problem.
', 'DescribeProblemObservations' => 'Describes the anomalies or errors associated with the problem.
', 'DescribeWorkload' => 'Describes a workload and its configuration.
', 'ListApplications' => 'Lists the IDs of the applications that you are monitoring.
', 'ListComponents' => 'Lists the auto-grouped, standalone, and custom components of the application.
', 'ListConfigurationHistory' => '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.
Lists the log pattern sets in the specific application.
', 'ListLogPatterns' => 'Lists the log patterns in the specific log LogPatternSet
.
Lists the problems with your application.
', 'ListTagsForResource' => 'Retrieve a list of the tags (keys and values) that are associated with a specified application. A tag is a label that you optionally define and associate with an application. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.
', 'ListWorkloads' => 'Lists the workloads that are configured on a given component.
', 'RemoveWorkload' => 'Remove workload from a component.
', 'TagResource' => 'Add one or more tags (keys and values) to a specified application. A tag is a label that you optionally define and associate with an application. Tags can help you categorize and manage application 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 more specific tag values. A tag value acts as a descriptor within a tag key.
', 'UntagResource' => 'Remove one or more tags (keys and values) from a specified application.
', 'UpdateApplication' => 'Updates the application.
', 'UpdateComponent' => 'Updates the custom component name and/or the list of resources that make up the component.
', 'UpdateComponentConfiguration' => '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
.
Adds a log pattern to a LogPatternSet
.
Updates the visibility of the problem or specifies the problem as RESOLVED
.
Adds a workload to a component. Each component can have at most five workloads.
', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => 'User does not have permissions to perform this action.
', 'refs' => [], ], 'AccountId' => [ 'base' => NULL, 'refs' => [ 'ApplicationInfo$AccountId' => 'The AWS account ID for the owner of the application.
', 'ConfigurationEvent$AccountId' => 'The AWS account ID for the owner of the application to which the configuration event belongs.
', 'DescribeApplicationRequest$AccountId' => 'The AWS account ID for the resource group owner.
', 'DescribeComponentConfigurationRequest$AccountId' => 'The AWS account ID for the resource group owner.
', 'DescribeComponentRequest$AccountId' => 'The AWS account ID for the resource group owner.
', 'DescribeLogPatternRequest$AccountId' => 'The AWS account ID for the resource group owner.
', 'DescribeLogPatternResponse$AccountId' => 'The AWS account ID for the resource group owner.
', 'DescribeObservationRequest$AccountId' => 'The AWS account ID for the resource group owner.
', 'DescribeProblemObservationsRequest$AccountId' => 'The AWS account ID for the resource group owner.
', 'DescribeProblemRequest$AccountId' => 'The AWS account ID for the owner of the resource group affected by the problem.
', 'DescribeWorkloadRequest$AccountId' => 'The AWS account ID for the workload owner.
', 'ListApplicationsRequest$AccountId' => 'The AWS account ID for the resource group owner.
', 'ListComponentsRequest$AccountId' => 'The AWS account ID for the resource group owner.
', 'ListConfigurationHistoryRequest$AccountId' => 'The AWS account ID for the resource group owner.
', 'ListLogPatternSetsRequest$AccountId' => 'The AWS account ID for the resource group owner.
', 'ListLogPatternSetsResponse$AccountId' => 'The AWS account ID for the resource group owner.
', 'ListLogPatternsRequest$AccountId' => 'The AWS account ID for the resource group owner.
', 'ListLogPatternsResponse$AccountId' => 'The AWS account ID for the resource group owner.
', 'ListProblemsRequest$AccountId' => 'The AWS account ID for the resource group owner.
', 'ListProblemsResponse$AccountId' => 'The AWS account ID for the resource group owner.
', 'ListWorkloadsRequest$AccountId' => 'The AWS account ID of the owner of the workload.
', 'Problem$AccountId' => 'The AWS account ID for the owner of the resource group affected by the problem.
', ], ], 'AddWorkloadRequest' => [ 'base' => NULL, 'refs' => [], ], 'AddWorkloadResponse' => [ 'base' => NULL, 'refs' => [], ], 'AffectedResource' => [ 'base' => NULL, 'refs' => [ 'Problem$AffectedResource' => 'The resource affected by the problem.
', ], ], 'AmazonResourceName' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceRequest$ResourceARN' => 'The Amazon Resource Name (ARN) of the application that you want to retrieve tag information for.
', 'TagResourceRequest$ResourceARN' => 'The Amazon Resource Name (ARN) of the application that you want to add one or more tags to.
', 'TooManyTagsException$ResourceName' => 'The name of the resource with too many tags.
', 'UntagResourceRequest$ResourceARN' => 'The Amazon Resource Name (ARN) of the application that you want to remove one or more tags from.
', ], ], 'ApplicationComponent' => [ 'base' => 'Describes a standalone resource or similarly grouped resources that the application is made up of.
', 'refs' => [ 'ApplicationComponentList$member' => NULL, 'DescribeComponentResponse$ApplicationComponent' => NULL, ], ], 'ApplicationComponentList' => [ 'base' => NULL, 'refs' => [ 'ListComponentsResponse$ApplicationComponentList' => 'The list of application components.
', ], ], 'ApplicationInfo' => [ 'base' => 'Describes the status of the application.
', 'refs' => [ 'ApplicationInfoList$member' => NULL, 'CreateApplicationResponse$ApplicationInfo' => 'Information about the application.
', 'DescribeApplicationResponse$ApplicationInfo' => 'Information about the application.
', 'UpdateApplicationResponse$ApplicationInfo' => 'Information about the application.
', ], ], 'ApplicationInfoList' => [ 'base' => NULL, 'refs' => [ 'ListApplicationsResponse$ApplicationInfoList' => 'The list of applications.
', ], ], 'AutoConfigEnabled' => [ 'base' => NULL, 'refs' => [ 'ApplicationInfo$AutoConfigEnabled' => 'Indicates whether auto-configuration is turned on for this application.
', 'CreateApplicationRequest$AutoConfigEnabled' => 'Indicates whether Application Insights automatically configures unmonitored resources in the resource group.
', 'UpdateApplicationRequest$AutoConfigEnabled' => 'Turns auto-configuration on or off.
', 'UpdateComponentConfigurationRequest$AutoConfigEnabled' => 'Automatically configures the component by applying the recommended configurations.
', ], ], 'AutoCreate' => [ 'base' => NULL, 'refs' => [ 'CreateApplicationRequest$AutoCreate' => 'Configures all of the resources in the resource group by applying the recommended configurations.
', ], ], 'BadRequestException' => [ 'base' => 'The request is not understood by the server.
', 'refs' => [], ], 'CWEMonitorEnabled' => [ 'base' => NULL, 'refs' => [ 'ApplicationInfo$CWEMonitorEnabled' => ' Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated
, failed deployment
, and others.
Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated
, failed deployment
, and others.
Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated
, failed deployment
, and others.
The detail type of the CloudWatch Event-based observation, for example, EC2 Instance State-change Notification
.
The ID of the CloudWatch Event-based observation related to the detected problem.
', ], ], 'CloudWatchEventSource' => [ 'base' => NULL, 'refs' => [ 'Observation$CloudWatchEventSource' => 'The source of the CloudWatch Event.
', ], ], 'CodeDeployApplication' => [ 'base' => NULL, 'refs' => [ 'Observation$CodeDeployApplication' => 'The CodeDeploy application to which the deployment belongs.
', ], ], 'CodeDeployDeploymentGroup' => [ 'base' => NULL, 'refs' => [ 'Observation$CodeDeployDeploymentGroup' => 'The deployment group to which the CodeDeploy deployment belongs.
', ], ], 'CodeDeployDeploymentId' => [ 'base' => NULL, 'refs' => [ 'Observation$CodeDeployDeploymentId' => 'The deployment ID of the CodeDeploy-based observation related to the detected problem.
', ], ], 'CodeDeployInstanceGroupId' => [ 'base' => NULL, 'refs' => [ 'Observation$CodeDeployInstanceGroupId' => 'The instance group to which the CodeDeploy instance belongs.
', ], ], 'CodeDeployState' => [ 'base' => NULL, 'refs' => [ 'Observation$CodeDeployState' => ' The status of the CodeDeploy deployment, for example SUCCESS
or FAILURE
.
The recommended configuration settings of the component. The value is the escaped JSON of the configuration.
', 'DescribeComponentConfigurationResponse$ComponentConfiguration' => 'The configuration settings of the component. The value is the escaped JSON of the configuration.
', 'UpdateComponentConfigurationRequest$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.
The configuration settings of the workload.
', ], ], 'ComponentName' => [ 'base' => NULL, 'refs' => [ 'AddWorkloadRequest$ComponentName' => 'The name of the component.
', 'ApplicationComponent$ComponentName' => 'The name of the component.
', 'DescribeComponentConfigurationRecommendationRequest$ComponentName' => 'The name of the component.
', 'DescribeComponentConfigurationRequest$ComponentName' => 'The name of the component.
', 'DescribeComponentRequest$ComponentName' => 'The name of the component.
', 'DescribeWorkloadRequest$ComponentName' => 'The name of the component.
', 'ListProblemsRequest$ComponentName' => 'The name of the component.
', 'ListWorkloadsRequest$ComponentName' => 'The name of the component.
', 'RemoveWorkloadRequest$ComponentName' => 'The name of the component.
', 'UpdateComponentConfigurationRequest$ComponentName' => 'The name of the component.
', 'UpdateWorkloadRequest$ComponentName' => 'The name of the component.
', 'Workload$ComponentName' => 'The name of the component.
', ], ], 'ConfigurationEvent' => [ 'base' => 'The event information.
', 'refs' => [ 'ConfigurationEventList$member' => NULL, ], ], 'ConfigurationEventDetail' => [ 'base' => NULL, 'refs' => [ 'ConfigurationEvent$EventDetail' => 'The details of the event in plain text.
', ], ], 'ConfigurationEventList' => [ 'base' => NULL, 'refs' => [ 'ListConfigurationHistoryResponse$EventList' => 'The list of configuration events and their corresponding details.
', ], ], 'ConfigurationEventMonitoredResourceARN' => [ 'base' => NULL, 'refs' => [ 'ConfigurationEvent$MonitoredResourceARN' => 'The resource monitored by Application Insights.
', ], ], 'ConfigurationEventResourceName' => [ 'base' => NULL, 'refs' => [ 'ConfigurationEvent$EventResourceName' => 'The name of the resource Application Insights attempted to configure.
', ], ], 'ConfigurationEventResourceType' => [ 'base' => NULL, 'refs' => [ 'ConfigurationEvent$EventResourceType' => 'The resource type that Application Insights attempted to configure, for example, CLOUDWATCH_ALARM.
', ], ], 'ConfigurationEventStatus' => [ 'base' => NULL, 'refs' => [ 'ConfigurationEvent$EventStatus' => 'The status of the configuration update event. Possible values include INFO, WARN, and ERROR.
', 'ListConfigurationHistoryRequest$EventStatus' => 'The status of the configuration update event. Possible values include INFO, WARN, and ERROR.
', ], ], 'ConfigurationEventTime' => [ 'base' => NULL, 'refs' => [ 'ConfigurationEvent$EventTime' => 'The timestamp of the event.
', ], ], 'CreateApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateApplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateLogPatternRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateLogPatternResponse' => [ 'base' => NULL, 'refs' => [], ], 'CustomComponentName' => [ 'base' => NULL, 'refs' => [ 'CreateComponentRequest$ComponentName' => 'The name of the component.
', 'DeleteComponentRequest$ComponentName' => 'The name of the component.
', 'UpdateComponentRequest$ComponentName' => 'The name of the component.
', 'UpdateComponentRequest$NewComponentName' => 'The new name of the component.
', ], ], 'DeleteApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteApplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLogPatternRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLogPatternResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeApplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeComponentConfigurationRecommendationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeComponentConfigurationRecommendationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeComponentConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeComponentConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLogPatternRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLogPatternResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeObservationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeObservationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProblemObservationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProblemObservationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProblemRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProblemResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkloadRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkloadResponse' => [ 'base' => NULL, 'refs' => [], ], 'DetectedWorkload' => [ 'base' => NULL, 'refs' => [ 'ApplicationComponent$DetectedWorkload' => 'Workloads detected in the application component.
', ], ], 'DiscoveryType' => [ 'base' => NULL, 'refs' => [ 'ApplicationInfo$DiscoveryType' => 'The method used by Application Insights to onboard your resources.
', ], ], 'EbsCause' => [ 'base' => NULL, 'refs' => [ 'Observation$EbsCause' => 'The cause of an EBS CloudWatch event.
', ], ], 'EbsEvent' => [ 'base' => NULL, 'refs' => [ 'Observation$EbsEvent' => ' The type of EBS CloudWatch event, such as createVolume
, deleteVolume
or attachVolume
.
The request ID of an EBS CloudWatch event.
', ], ], 'EbsResult' => [ 'base' => NULL, 'refs' => [ 'Observation$EbsResult' => ' The result of an EBS CloudWatch event, such as failed
or succeeded
.
The state of the instance, such as STOPPING
or TERMINATING
.
The end time of the event.
', 'ListProblemsRequest$EndTime' => 'The time when the problem ended, in epoch seconds. If not specified, problems within the past seven days are returned.
', 'Observation$EndTime' => 'The time when the observation ended, in epoch seconds.
', 'Problem$EndTime' => 'The time when the problem ended, in epoch seconds.
', ], ], 'ErrorMsg' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$Message' => NULL, 'BadRequestException$Message' => NULL, 'InternalServerException$Message' => NULL, 'ResourceInUseException$Message' => NULL, 'ResourceNotFoundException$Message' => NULL, 'ValidationException$Message' => NULL, ], ], 'ExceptionMessage' => [ 'base' => NULL, 'refs' => [ 'TagsAlreadyExistException$Message' => NULL, 'TooManyTagsException$Message' => NULL, ], ], 'Feedback' => [ 'base' => NULL, 'refs' => [ 'Problem$Feedback' => 'Feedback provided by the user about the problem.
', ], ], 'FeedbackKey' => [ 'base' => NULL, 'refs' => [ 'Feedback$key' => NULL, ], ], 'FeedbackValue' => [ 'base' => NULL, 'refs' => [ 'Feedback$value' => NULL, ], ], 'GroupingType' => [ 'base' => NULL, 'refs' => [ 'CreateApplicationRequest$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
.
The Amazon Resource Name (ARN) of the AWS Health Event-based observation.
', ], ], 'HealthEventDescription' => [ 'base' => NULL, 'refs' => [ 'Observation$HealthEventDescription' => 'The description of the AWS Health event provided by the service, such as Amazon EC2.
', ], ], 'HealthEventTypeCategory' => [ 'base' => NULL, 'refs' => [ 'Observation$HealthEventTypeCategory' => ' The category of the AWS Health event, such as issue
.
The type of the AWS Health event, for example, AWS_EC2_POWER_CONNECTIVITY_ISSUE
.
The service to which the AWS Health Event belongs, such as EC2.
', ], ], 'Insights' => [ 'base' => NULL, 'refs' => [ 'Problem$Insights' => 'A detailed analysis of the problem using machine learning.
', ], ], 'InternalServerException' => [ 'base' => 'The server encountered an internal error and is unable to complete the request.
', 'refs' => [], ], 'LastRecurrenceTime' => [ 'base' => NULL, 'refs' => [ 'Problem$LastRecurrenceTime' => 'The last time that the problem reoccurred after its last resolution.
', ], ], 'LifeCycle' => [ 'base' => NULL, 'refs' => [ 'ApplicationInfo$LifeCycle' => 'The lifecycle of the application.
', ], ], 'LineTime' => [ 'base' => NULL, 'refs' => [ 'Observation$LineTime' => 'The timestamp in the CloudWatch Logs that specifies when the matched line occurred.
', ], ], 'ListApplicationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListApplicationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListComponentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListComponentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListConfigurationHistoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListConfigurationHistoryResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListLogPatternSetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListLogPatternSetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListLogPatternsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListLogPatternsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListProblemsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListProblemsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkloadsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkloadsResponse' => [ 'base' => NULL, 'refs' => [], ], 'LogFilter' => [ 'base' => NULL, 'refs' => [ 'Observation$LogFilter' => 'The log filter of the observation.
', ], ], 'LogGroup' => [ 'base' => NULL, 'refs' => [ 'Observation$LogGroup' => 'The log group name.
', ], ], 'LogPattern' => [ 'base' => 'An object that defines the log patterns that belongs to a LogPatternSet
.
The successfully created log pattern.
', 'DescribeLogPatternResponse$LogPattern' => 'The successfully created log pattern.
', 'LogPatternList$member' => NULL, 'UpdateLogPatternResponse$LogPattern' => 'The successfully created log pattern.
', ], ], 'LogPatternList' => [ 'base' => NULL, 'refs' => [ 'ListLogPatternsResponse$LogPatterns' => 'The list of log patterns.
', ], ], 'LogPatternName' => [ 'base' => NULL, 'refs' => [ 'CreateLogPatternRequest$PatternName' => 'The name of the log pattern.
', 'DeleteLogPatternRequest$PatternName' => 'The name of the log pattern.
', 'DescribeLogPatternRequest$PatternName' => 'The name of the log pattern.
', 'LogPattern$PatternName' => 'The name of the log pattern. A log pattern name can contain as many as 50 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.
', 'UpdateLogPatternRequest$PatternName' => 'The name of the log pattern.
', ], ], 'LogPatternRank' => [ 'base' => NULL, 'refs' => [ 'CreateLogPatternRequest$Rank' => 'Rank of the log pattern. Must be a value between 1
and 1,000,000
. The patterns are sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of rank 1
will be the first to get matched to a log line. A pattern of rank 1,000,000
will be last to get matched. When you configure custom log patterns from the console, a Low
severity pattern translates to a 750,000
rank. A Medium
severity pattern translates to a 500,000
rank. And a High
severity pattern translates to a 250,000
rank. Rank values less than 1
or greater than 1,000,000
are reserved for AWS-provided patterns.
Rank of the log pattern. Must be a value between 1
and 1,000,000
. The patterns are sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of rank 1
will be the first to get matched to a log line. A pattern of rank 1,000,000
will be last to get matched. When you configure custom log patterns from the console, a Low
severity pattern translates to a 750,000
rank. A Medium
severity pattern translates to a 500,000
rank. And a High
severity pattern translates to a 250,000
rank. Rank values less than 1
or greater than 1,000,000
are reserved for AWS-provided patterns.
Rank of the log pattern. Must be a value between 1
and 1,000,000
. The patterns are sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of rank 1
will be the first to get matched to a log line. A pattern of rank 1,000,000
will be last to get matched. When you configure custom log patterns from the console, a Low
severity pattern translates to a 750,000
rank. A Medium
severity pattern translates to a 500,000
rank. And a High
severity pattern translates to a 250,000
rank. Rank values less than 1
or greater than 1,000,000
are reserved for AWS-provided patterns.
The log pattern. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.
', 'LogPattern$Pattern' => 'A regular expression that defines the log pattern. A log pattern can contain as many as 50 characters, and it cannot be empty. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.
', 'UpdateLogPatternRequest$Pattern' => 'The log pattern. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.
', ], ], 'LogPatternSetList' => [ 'base' => NULL, 'refs' => [ 'ListLogPatternSetsResponse$LogPatternSets' => 'The list of log pattern sets.
', ], ], 'LogPatternSetName' => [ 'base' => NULL, 'refs' => [ 'CreateLogPatternRequest$PatternSetName' => 'The name of the log pattern set.
', 'DeleteLogPatternRequest$PatternSetName' => 'The name of the log pattern set.
', 'DescribeLogPatternRequest$PatternSetName' => 'The name of the log pattern set.
', 'ListLogPatternsRequest$PatternSetName' => 'The name of the log pattern set.
', 'LogPattern$PatternSetName' => 'The name of the log pattern. A log pattern name can contain as many as 30 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.
', 'LogPatternSetList$member' => NULL, 'UpdateLogPatternRequest$PatternSetName' => 'The name of the log pattern set.
', ], ], 'LogText' => [ 'base' => NULL, 'refs' => [ 'Observation$LogText' => 'The log text of the observation.
', ], ], 'MaxEntities' => [ 'base' => NULL, 'refs' => [ 'ListApplicationsRequest$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.
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken
value.
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.
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken
value.
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken
value.
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken
value.
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken
value.
The name of the observation metric.
', ], ], 'MetricNamespace' => [ 'base' => NULL, 'refs' => [ 'Observation$MetricNamespace' => 'The namespace of the observation metric.
', ], ], 'Monitor' => [ 'base' => NULL, 'refs' => [ 'ApplicationComponent$Monitor' => 'Indicates whether the application component is monitored.
', 'DescribeComponentConfigurationResponse$Monitor' => 'Indicates whether the application component is monitored.
', 'UpdateComponentConfigurationRequest$Monitor' => 'Indicates whether the application component is monitored.
', ], ], 'Observation' => [ 'base' => 'Describes an anomaly or error with the application.
', 'refs' => [ 'DescribeObservationResponse$Observation' => 'Information about the observation.
', 'ObservationList$member' => NULL, ], ], 'ObservationId' => [ 'base' => NULL, 'refs' => [ 'DescribeObservationRequest$ObservationId' => 'The ID of the observation.
', 'Observation$Id' => 'The ID of the observation type.
', ], ], 'ObservationList' => [ 'base' => NULL, 'refs' => [ 'RelatedObservations$ObservationList' => 'The list of observations related to the problem.
', ], ], 'OpsCenterEnabled' => [ 'base' => NULL, 'refs' => [ 'ApplicationInfo$OpsCenterEnabled' => 'Indicates whether Application Insights will create opsItems for any problem detected by Application Insights for an application.
', 'CreateApplicationRequest$OpsCenterEnabled' => ' When set to true
, creates opsItems for any problems detected on an application.
When set to true
, creates opsItems for any problems detected on an application.
The SNS topic provided to Application Insights that is associated to the created opsItems to receive SNS notifications for opsItem updates.
', 'CreateApplicationRequest$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.
', 'UpdateApplicationRequest$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.
', ], ], 'OsType' => [ 'base' => NULL, 'refs' => [ 'ApplicationComponent$OsType' => 'The operating system of the component.
', ], ], 'PaginationToken' => [ 'base' => NULL, 'refs' => [ 'ListApplicationsRequest$NextToken' => 'The token to request the next page of results.
', 'ListApplicationsResponse$NextToken' => 'The token used to retrieve the next page of results. This value is null
when there are no more results to return.
The token to request the next page of results.
', 'ListComponentsResponse$NextToken' => 'The token to request the next page of results.
', 'ListConfigurationHistoryRequest$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.
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.
The token to request the next page of results.
', 'ListLogPatternSetsResponse$NextToken' => 'The token used to retrieve the next page of results. This value is null
when there are no more results to return.
The token to request the next page of results.
', 'ListLogPatternsResponse$NextToken' => 'The token used to retrieve the next page of results. This value is null
when there are no more results to return.
The token to request the next page of results.
', 'ListProblemsResponse$NextToken' => 'The token used to retrieve the next page of results. This value is null
when there are no more results to return.
The token to request the next page of results.
', 'ListWorkloadsResponse$NextToken' => 'The token to request the next page of results.
', ], ], 'Problem' => [ 'base' => 'Describes a problem that is detected by correlating observations.
', 'refs' => [ 'DescribeProblemResponse$Problem' => 'Information about the problem.
', 'ProblemList$member' => NULL, ], ], 'ProblemId' => [ 'base' => NULL, 'refs' => [ 'DescribeProblemObservationsRequest$ProblemId' => 'The ID of the problem.
', 'DescribeProblemRequest$ProblemId' => 'The ID of the problem.
', 'Problem$Id' => 'The ID of the problem.
', 'UpdateProblemRequest$ProblemId' => 'The ID of the problem.
', ], ], 'ProblemList' => [ 'base' => NULL, 'refs' => [ 'ListProblemsResponse$ProblemList' => 'The list of problems.
', ], ], 'RdsEventCategories' => [ 'base' => NULL, 'refs' => [ 'Observation$RdsEventCategories' => 'The category of an RDS event.
', ], ], 'RdsEventMessage' => [ 'base' => NULL, 'refs' => [ 'Observation$RdsEventMessage' => 'The message of an RDS event.
', ], ], 'RecommendationType' => [ 'base' => NULL, 'refs' => [ 'DescribeComponentConfigurationRecommendationRequest$RecommendationType' => 'The recommended configuration type.
', ], ], 'RecurringCount' => [ 'base' => NULL, 'refs' => [ 'Problem$RecurringCount' => 'The number of times that the same problem reoccurred after the first time it was resolved.
', ], ], 'RelatedObservations' => [ 'base' => 'Describes observations related to the problem.
', 'refs' => [ 'DescribeProblemObservationsResponse$RelatedObservations' => 'Observations related to the problem.
', ], ], 'Remarks' => [ 'base' => NULL, 'refs' => [ 'ApplicationComponent$ComponentRemarks' => 'If logging is supported for the resource type, indicates whether the component has configured logs to be monitored.
', 'ApplicationInfo$Remarks' => '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”
If logging is supported for the resource type, shows whether the component has configured logs to be monitored.
', 'Workload$WorkloadRemarks' => 'If logging is supported for the resource type, shows whether the component has configured logs to be monitored.
', ], ], 'RemoveSNSTopic' => [ 'base' => NULL, 'refs' => [ 'UpdateApplicationRequest$RemoveSNSTopic' => 'Disassociates the SNS topic from the opsItem created for detected problems.
', ], ], 'RemoveWorkloadRequest' => [ 'base' => NULL, 'refs' => [], ], 'RemoveWorkloadResponse' => [ 'base' => NULL, 'refs' => [], ], 'ResolutionMethod' => [ 'base' => NULL, 'refs' => [ 'Problem$ResolutionMethod' => '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.
The name of the resource group.
', 'ApplicationInfo$ResourceGroupName' => 'The name of the resource group used for the application.
', 'ConfigurationEvent$ResourceGroupName' => 'The name of the resource group of the application to which the configuration event belongs.
', 'CreateApplicationRequest$ResourceGroupName' => 'The name of the resource group.
', 'CreateComponentRequest$ResourceGroupName' => 'The name of the resource group.
', 'CreateLogPatternRequest$ResourceGroupName' => 'The name of the resource group.
', 'CreateLogPatternResponse$ResourceGroupName' => 'The name of the resource group.
', 'DeleteApplicationRequest$ResourceGroupName' => 'The name of the resource group.
', 'DeleteComponentRequest$ResourceGroupName' => 'The name of the resource group.
', 'DeleteLogPatternRequest$ResourceGroupName' => 'The name of the resource group.
', 'DescribeApplicationRequest$ResourceGroupName' => 'The name of the resource group.
', 'DescribeComponentConfigurationRecommendationRequest$ResourceGroupName' => 'The name of the resource group.
', 'DescribeComponentConfigurationRequest$ResourceGroupName' => 'The name of the resource group.
', 'DescribeComponentRequest$ResourceGroupName' => 'The name of the resource group.
', 'DescribeLogPatternRequest$ResourceGroupName' => 'The name of the resource group.
', 'DescribeLogPatternResponse$ResourceGroupName' => 'The name of the resource group.
', 'DescribeWorkloadRequest$ResourceGroupName' => 'The name of the resource group.
', 'ListComponentsRequest$ResourceGroupName' => 'The name of the resource group.
', 'ListConfigurationHistoryRequest$ResourceGroupName' => 'Resource group to which the application belongs.
', 'ListLogPatternSetsRequest$ResourceGroupName' => 'The name of the resource group.
', 'ListLogPatternSetsResponse$ResourceGroupName' => 'The name of the resource group.
', 'ListLogPatternsRequest$ResourceGroupName' => 'The name of the resource group.
', 'ListLogPatternsResponse$ResourceGroupName' => 'The name of the resource group.
', 'ListProblemsRequest$ResourceGroupName' => 'The name of the resource group.
', 'ListProblemsResponse$ResourceGroupName' => 'The name of the resource group.
', 'ListWorkloadsRequest$ResourceGroupName' => 'The name of the resource group.
', 'Problem$ResourceGroupName' => 'The name of the resource group affected by the problem.
', 'RemoveWorkloadRequest$ResourceGroupName' => 'The name of the resource group.
', 'UpdateApplicationRequest$ResourceGroupName' => 'The name of the resource group.
', 'UpdateComponentConfigurationRequest$ResourceGroupName' => 'The name of the resource group.
', 'UpdateComponentRequest$ResourceGroupName' => 'The name of the resource group.
', 'UpdateLogPatternRequest$ResourceGroupName' => 'The name of the resource group.
', 'UpdateLogPatternResponse$ResourceGroupName' => 'The name of the resource group.
', 'UpdateWorkloadRequest$ResourceGroupName' => 'The name of the resource group.
', ], ], 'ResourceInUseException' => [ 'base' => 'The resource is already created or in use.
', 'refs' => [], ], 'ResourceList' => [ 'base' => NULL, 'refs' => [ 'CreateComponentRequest$ResourceList' => 'The list of resource ARNs that belong to the component.
', 'DescribeComponentResponse$ResourceList' => 'The list of resource ARNs that belong to the component.
', 'UpdateComponentRequest$ResourceList' => 'The list of resource ARNs that belong to the component.
', ], ], 'ResourceNotFoundException' => [ 'base' => 'The resource does not exist in the customer account.
', 'refs' => [], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'ApplicationComponent$ResourceType' => 'The resource type. Supported resource types include EC2 instances, Auto Scaling group, Classic ELB, Application ELB, and SQS Queue.
', ], ], 'S3EventName' => [ 'base' => NULL, 'refs' => [ 'Observation$S3EventName' => 'The name of the S3 CloudWatch Event-based observation.
', ], ], 'SeverityLevel' => [ 'base' => NULL, 'refs' => [ 'Problem$SeverityLevel' => 'A measure of the level of impact of the problem.
', ], ], 'SourceARN' => [ 'base' => NULL, 'refs' => [ 'Observation$SourceARN' => 'The source resource ARN of the observation.
', ], ], 'SourceType' => [ 'base' => NULL, 'refs' => [ 'Observation$SourceType' => 'The source type of the observation.
', ], ], 'StartTime' => [ 'base' => NULL, 'refs' => [ 'ListConfigurationHistoryRequest$StartTime' => 'The start time of the event.
', 'ListProblemsRequest$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.
', 'Observation$StartTime' => 'The time when the observation was first detected, in epoch seconds.
', 'Problem$StartTime' => 'The time when the problem started, in epoch seconds.
', ], ], 'StatesArn' => [ 'base' => NULL, 'refs' => [ 'Observation$StatesArn' => 'The Amazon Resource Name (ARN) of the step function-based observation.
', ], ], 'StatesExecutionArn' => [ 'base' => NULL, 'refs' => [ 'Observation$StatesExecutionArn' => 'The Amazon Resource Name (ARN) of the step function execution-based observation.
', ], ], 'StatesInput' => [ 'base' => NULL, 'refs' => [ 'Observation$StatesInput' => 'The input to the step function-based observation.
', ], ], 'StatesStatus' => [ 'base' => NULL, 'refs' => [ 'Observation$StatesStatus' => 'The status of the step function-related observation.
', ], ], 'Status' => [ 'base' => NULL, 'refs' => [ 'Problem$Status' => 'The status of the problem.
', ], ], 'Tag' => [ 'base' => '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 AWS; 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.
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.
', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => 'The tags (tag keys) that you want to remove from the resource. When you specify a tag key, the action removes both that key and its associated tag value.
To remove more than one tag from the application, append the TagKeys
parameter and argument for each additional tag to remove, separated by an ampersand.
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.
An array that lists all the tags that are associated with the application. Each tag consists of a required tag key (Key
) and an associated tag value (Value
).
A list of tags that to add to the application. A tag consists of a required 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.
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.
', ], ], 'TagsAlreadyExistException' => [ 'base' => 'Tags are already registered for the specified application ARN.
', 'refs' => [], ], 'Tier' => [ 'base' => NULL, 'refs' => [ 'ApplicationComponent$Tier' => 'The stack tier of the application component.
', 'DescribeComponentConfigurationRecommendationRequest$Tier' => 'The tier of the application component.
', 'DescribeComponentConfigurationResponse$Tier' => 'The tier of the application component. Supported tiers include DOT_NET_CORE
, DOT_NET_WORKER
, DOT_NET_WEB
, SQL_SERVER
, and DEFAULT
The tier of the application component.
', 'Workload$Tier' => 'The tier of the workload.
', 'WorkloadConfiguration$Tier' => 'The configuration of the workload tier.
', ], ], 'Title' => [ 'base' => NULL, 'refs' => [ 'Problem$Title' => 'The name of the problem.
', ], ], 'TooManyTagsException' => [ 'base' => 'The number of the provided tags is beyond the limit, or the number of total tags you are trying to attach to the specified resource exceeds the limit.
', 'refs' => [], ], 'Unit' => [ 'base' => NULL, 'refs' => [ 'Observation$Unit' => 'The unit of the source observation metric.
', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateApplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateComponentConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateComponentConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateLogPatternRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateLogPatternResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProblemRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProblemResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateStatus' => [ 'base' => NULL, 'refs' => [ 'UpdateProblemRequest$UpdateStatus' => 'The status of the problem. Arguments can be passed for only problems that show a status of RECOVERING
.
The parameter is not valid.
', 'refs' => [], ], 'Value' => [ 'base' => NULL, 'refs' => [ 'Observation$Value' => 'The value of the source observation metric.
', ], ], 'Visibility' => [ 'base' => NULL, 'refs' => [ 'ListProblemsRequest$Visibility' => 'Specifies whether or not you can view the problem. If not specified, visible and ignored problems are returned.
', 'Problem$Visibility' => 'Specifies whether or not you can view the problem. Updates to ignored problems do not generate notifications.
', 'UpdateProblemRequest$Visibility' => 'The visibility of a problem. When you pass a value of IGNORED
, the problem is removed from the default view, and all notifications for the problem are suspended. When VISIBLE
is passed, the IGNORED
action is reversed.
Describes the workloads on a component.
', 'refs' => [ 'WorkloadList$member' => NULL, ], ], 'WorkloadConfiguration' => [ 'base' => 'The configuration of the workload.
', 'refs' => [ 'AddWorkloadRequest$WorkloadConfiguration' => 'The configuration settings of the workload. The value is the escaped JSON of the configuration.
', 'AddWorkloadResponse$WorkloadConfiguration' => 'The configuration settings of the workload. The value is the escaped JSON of the configuration.
', 'DescribeWorkloadResponse$WorkloadConfiguration' => 'The configuration settings of the workload. The value is the escaped JSON of the configuration.
', 'UpdateWorkloadRequest$WorkloadConfiguration' => 'The configuration settings of the workload. The value is the escaped JSON of the configuration.
', 'UpdateWorkloadResponse$WorkloadConfiguration' => 'The configuration settings of the workload. The value is the escaped JSON of the configuration.
', ], ], 'WorkloadId' => [ 'base' => NULL, 'refs' => [ 'AddWorkloadResponse$WorkloadId' => 'The ID of the workload.
', 'DescribeWorkloadRequest$WorkloadId' => 'The ID of the workload.
', 'DescribeWorkloadResponse$WorkloadId' => 'The ID of the workload.
', 'RemoveWorkloadRequest$WorkloadId' => 'The ID of the workload.
', 'UpdateWorkloadRequest$WorkloadId' => 'The ID of the workload.
', 'UpdateWorkloadResponse$WorkloadId' => 'The ID of the workload.
', 'Workload$WorkloadId' => 'The ID of the workload.
', ], ], 'WorkloadList' => [ 'base' => NULL, 'refs' => [ 'ListWorkloadsResponse$WorkloadList' => 'The list of workloads.
', ], ], 'WorkloadMetaData' => [ 'base' => NULL, 'refs' => [ 'DetectedWorkload$value' => NULL, ], ], 'WorkloadName' => [ 'base' => NULL, 'refs' => [ 'Workload$WorkloadName' => 'The name of the workload.
', 'WorkloadConfiguration$WorkloadName' => 'The name of the workload.
', ], ], 'XRayErrorPercent' => [ 'base' => NULL, 'refs' => [ 'Observation$XRayErrorPercent' => 'The X-Ray request error percentage for this node.
', ], ], 'XRayFaultPercent' => [ 'base' => NULL, 'refs' => [ 'Observation$XRayFaultPercent' => 'The X-Ray request fault percentage for this node.
', ], ], 'XRayNodeName' => [ 'base' => NULL, 'refs' => [ 'Observation$XRayNodeName' => 'The name of the X-Ray node.
', ], ], 'XRayNodeType' => [ 'base' => NULL, 'refs' => [ 'Observation$XRayNodeType' => 'The type of the X-Ray node.
', ], ], 'XRayRequestAverageLatency' => [ 'base' => NULL, 'refs' => [ 'Observation$XRayRequestAverageLatency' => 'The X-Ray node request average latency for this node.
', ], ], 'XRayRequestCount' => [ 'base' => NULL, 'refs' => [ 'Observation$XRayRequestCount' => 'The X-Ray request count for this node.
', ], ], 'XRayThrottlePercent' => [ 'base' => NULL, 'refs' => [ 'Observation$XRayThrottlePercent' => 'The X-Ray request throttle percentage for this node.
', ], ], ],];