amazonka-application-insights-2.0: Amazon CloudWatch Application Insights SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ApplicationInsights.Lens

Description

 
Synopsis

Operations

CreateApplication

createApplication_autoConfigEnabled :: Lens' CreateApplication (Maybe Bool) Source #

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

createApplication_autoCreate :: Lens' CreateApplication (Maybe Bool) Source #

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

createApplication_cWEMonitorEnabled :: Lens' CreateApplication (Maybe Bool) Source #

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

createApplication_groupingType :: Lens' CreateApplication (Maybe GroupingType) Source #

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.

createApplication_opsCenterEnabled :: Lens' CreateApplication (Maybe Bool) Source #

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

createApplication_opsItemSNSTopicArn :: Lens' CreateApplication (Maybe Text) Source #

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

createApplication_tags :: Lens' CreateApplication (Maybe [Tag]) Source #

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.

CreateComponent

createComponent_resourceList :: Lens' CreateComponent [Text] Source #

The list of resource ARNs that belong to the component.

CreateLogPattern

createLogPattern_pattern :: Lens' CreateLogPattern Text Source #

The log pattern. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.

createLogPattern_rank :: Lens' CreateLogPattern Int Source #

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.

DeleteApplication

DeleteComponent

DeleteLogPattern

DescribeApplication

DescribeComponent

describeComponentResponse_resourceList :: Lens' DescribeComponentResponse (Maybe [Text]) Source #

The list of resource ARNs that belong to the component.

DescribeComponentConfiguration

describeComponentConfigurationResponse_componentConfiguration :: Lens' DescribeComponentConfigurationResponse (Maybe Text) Source #

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

describeComponentConfigurationResponse_tier :: Lens' DescribeComponentConfigurationResponse (Maybe Tier) Source #

The tier of the application component. Supported tiers include DOT_NET_CORE, DOT_NET_WORKER, DOT_NET_WEB, SQL_SERVER, and DEFAULT

DescribeComponentConfigurationRecommendation

describeComponentConfigurationRecommendationResponse_componentConfiguration :: Lens' DescribeComponentConfigurationRecommendationResponse (Maybe Text) Source #

The recommended configuration settings of the component. The value is the escaped JSON of the configuration.

DescribeLogPattern

DescribeObservation

DescribeProblem

DescribeProblemObservations

ListApplications

listApplications_maxResults :: Lens' ListApplications (Maybe Natural) Source #

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

listApplications_nextToken :: Lens' ListApplications (Maybe Text) Source #

The token to request the next page of results.

listApplicationsResponse_nextToken :: Lens' ListApplicationsResponse (Maybe Text) Source #

The token used to retrieve the next page of results. This value is null when there are no more results to return.

ListComponents

listComponents_maxResults :: Lens' ListComponents (Maybe Natural) Source #

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

listComponents_nextToken :: Lens' ListComponents (Maybe Text) Source #

The token to request the next page of results.

listComponentsResponse_nextToken :: Lens' ListComponentsResponse (Maybe Text) Source #

The token to request the next page of results.

ListConfigurationHistory

listConfigurationHistory_eventStatus :: Lens' ListConfigurationHistory (Maybe ConfigurationEventStatus) Source #

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

listConfigurationHistory_maxResults :: Lens' ListConfigurationHistory (Maybe Natural) Source #

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.

listConfigurationHistory_nextToken :: Lens' ListConfigurationHistory (Maybe Text) Source #

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.

listConfigurationHistory_resourceGroupName :: Lens' ListConfigurationHistory (Maybe Text) Source #

Resource group to which the application belongs.

listConfigurationHistoryResponse_eventList :: Lens' ListConfigurationHistoryResponse (Maybe [ConfigurationEvent]) Source #

The list of configuration events and their corresponding details.

listConfigurationHistoryResponse_nextToken :: Lens' ListConfigurationHistoryResponse (Maybe Text) Source #

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.

ListLogPatternSets

listLogPatternSets_maxResults :: Lens' ListLogPatternSets (Maybe Natural) Source #

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

listLogPatternSets_nextToken :: Lens' ListLogPatternSets (Maybe Text) Source #

The token to request the next page of results.

listLogPatternSetsResponse_nextToken :: Lens' ListLogPatternSetsResponse (Maybe Text) Source #

The token used to retrieve the next page of results. This value is null when there are no more results to return.

ListLogPatterns

listLogPatterns_maxResults :: Lens' ListLogPatterns (Maybe Natural) Source #

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

listLogPatterns_nextToken :: Lens' ListLogPatterns (Maybe Text) Source #

The token to request the next page of results.

listLogPatternsResponse_nextToken :: Lens' ListLogPatternsResponse (Maybe Text) Source #

The token used to retrieve the next page of results. This value is null when there are no more results to return.

ListProblems

listProblems_endTime :: Lens' ListProblems (Maybe UTCTime) Source #

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

listProblems_maxResults :: Lens' ListProblems (Maybe Natural) Source #

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

listProblems_nextToken :: Lens' ListProblems (Maybe Text) Source #

The token to request the next page of results.

listProblems_resourceGroupName :: Lens' ListProblems (Maybe Text) Source #

The name of the resource group.

listProblems_startTime :: Lens' ListProblems (Maybe UTCTime) Source #

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.

listProblemsResponse_nextToken :: Lens' ListProblemsResponse (Maybe Text) Source #

The token used to retrieve the next page of results. This value is null when there are no more results to return.

ListTagsForResource

listTagsForResource_resourceARN :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the application that you want to retrieve tag information for.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag]) Source #

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

TagResource

tagResource_resourceARN :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the application that you want to add one or more tags to.

tagResource_tags :: Lens' TagResource [Tag] Source #

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.

UntagResource

untagResource_resourceARN :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the application that you want to remove one or more tags from.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

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.

UpdateApplication

updateApplication_cWEMonitorEnabled :: Lens' UpdateApplication (Maybe Bool) Source #

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

updateApplication_opsCenterEnabled :: Lens' UpdateApplication (Maybe Bool) Source #

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

updateApplication_opsItemSNSTopicArn :: Lens' UpdateApplication (Maybe Text) Source #

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

updateApplication_removeSNSTopic :: Lens' UpdateApplication (Maybe Bool) Source #

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

UpdateComponent

updateComponent_resourceList :: Lens' UpdateComponent (Maybe [Text]) Source #

The list of resource ARNs that belong to the component.

UpdateComponentConfiguration

updateComponentConfiguration_autoConfigEnabled :: Lens' UpdateComponentConfiguration (Maybe Bool) Source #

Automatically configures the component by applying the recommended configurations.

updateComponentConfiguration_componentConfiguration :: Lens' UpdateComponentConfiguration (Maybe Text) Source #

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.

updateComponentConfiguration_monitor :: Lens' UpdateComponentConfiguration (Maybe Bool) Source #

Indicates whether the application component is monitored.

UpdateLogPattern

updateLogPattern_pattern :: Lens' UpdateLogPattern (Maybe Text) Source #

The log pattern. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.

updateLogPattern_rank :: Lens' UpdateLogPattern (Maybe Int) Source #

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.

Types

ApplicationComponent

applicationComponent_componentRemarks :: Lens' ApplicationComponent (Maybe Text) Source #

If logging is supported for the resource type, indicates whether the component has configured logs to be monitored.

applicationComponent_detectedWorkload :: Lens' ApplicationComponent (Maybe (HashMap Tier (HashMap Text Text))) Source #

Workloads detected in the application component.

applicationComponent_monitor :: Lens' ApplicationComponent (Maybe Bool) Source #

Indicates whether the application component is monitored.

applicationComponent_osType :: Lens' ApplicationComponent (Maybe OsType) Source #

The operating system of the component.

applicationComponent_resourceType :: Lens' ApplicationComponent (Maybe Text) Source #

The resource type. Supported resource types include EC2 instances, Auto Scaling group, Classic ELB, Application ELB, and SQS Queue.

applicationComponent_tier :: Lens' ApplicationComponent (Maybe Tier) Source #

The stack tier of the application component.

ApplicationInfo

applicationInfo_autoConfigEnabled :: Lens' ApplicationInfo (Maybe Bool) Source #

Indicates whether auto-configuration is turned on for this application.

applicationInfo_cWEMonitorEnabled :: Lens' ApplicationInfo (Maybe Bool) Source #

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

applicationInfo_discoveryType :: Lens' ApplicationInfo (Maybe DiscoveryType) Source #

The method used by Application Insights to onboard your resources.

applicationInfo_lifeCycle :: Lens' ApplicationInfo (Maybe Text) Source #

The lifecycle of the application.

applicationInfo_opsCenterEnabled :: Lens' ApplicationInfo (Maybe Bool) Source #

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

applicationInfo_opsItemSNSTopicArn :: Lens' ApplicationInfo (Maybe Text) Source #

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

applicationInfo_remarks :: Lens' ApplicationInfo (Maybe Text) Source #

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”

applicationInfo_resourceGroupName :: Lens' ApplicationInfo (Maybe Text) Source #

The name of the resource group used for the application.

ConfigurationEvent

configurationEvent_eventDetail :: Lens' ConfigurationEvent (Maybe Text) Source #

The details of the event in plain text.

configurationEvent_eventResourceName :: Lens' ConfigurationEvent (Maybe Text) Source #

The name of the resource Application Insights attempted to configure.

configurationEvent_eventResourceType :: Lens' ConfigurationEvent (Maybe ConfigurationEventResourceType) Source #

The resource type that Application Insights attempted to configure, for example, CLOUDWATCH_ALARM.

configurationEvent_eventStatus :: Lens' ConfigurationEvent (Maybe ConfigurationEventStatus) Source #

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

configurationEvent_monitoredResourceARN :: Lens' ConfigurationEvent (Maybe Text) Source #

The resource monitored by Application Insights.

LogPattern

logPattern_pattern :: Lens' LogPattern (Maybe Text) Source #

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.

logPattern_patternName :: Lens' LogPattern (Maybe Text) Source #

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.

logPattern_patternSetName :: Lens' LogPattern (Maybe Text) Source #

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.

logPattern_rank :: Lens' LogPattern (Maybe Int) Source #

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.

Observation

observation_cloudWatchEventDetailType :: Lens' Observation (Maybe Text) Source #

The detail type of the CloudWatch Event-based observation, for example, EC2 Instance State-change Notification.

observation_cloudWatchEventId :: Lens' Observation (Maybe Text) Source #

The ID of the CloudWatch Event-based observation related to the detected problem.

observation_codeDeployApplication :: Lens' Observation (Maybe Text) Source #

The CodeDeploy application to which the deployment belongs.

observation_codeDeployDeploymentGroup :: Lens' Observation (Maybe Text) Source #

The deployment group to which the CodeDeploy deployment belongs.

observation_codeDeployDeploymentId :: Lens' Observation (Maybe Text) Source #

The deployment ID of the CodeDeploy-based observation related to the detected problem.

observation_codeDeployInstanceGroupId :: Lens' Observation (Maybe Text) Source #

The instance group to which the CodeDeploy instance belongs.

observation_codeDeployState :: Lens' Observation (Maybe Text) Source #

The status of the CodeDeploy deployment, for example SUCCESS or FAILURE.

observation_ebsCause :: Lens' Observation (Maybe Text) Source #

The cause of an EBS CloudWatch event.

observation_ebsEvent :: Lens' Observation (Maybe Text) Source #

The type of EBS CloudWatch event, such as createVolume, deleteVolume or attachVolume.

observation_ebsRequestId :: Lens' Observation (Maybe Text) Source #

The request ID of an EBS CloudWatch event.

observation_ebsResult :: Lens' Observation (Maybe Text) Source #

The result of an EBS CloudWatch event, such as failed or succeeded.

observation_ec2State :: Lens' Observation (Maybe Text) Source #

The state of the instance, such as STOPPING or TERMINATING.

observation_endTime :: Lens' Observation (Maybe UTCTime) Source #

The time when the observation ended, in epoch seconds.

observation_healthEventArn :: Lens' Observation (Maybe Text) Source #

The Amazon Resource Name (ARN) of the AWS Health Event-based observation.

observation_healthEventDescription :: Lens' Observation (Maybe Text) Source #

The description of the AWS Health event provided by the service, such as Amazon EC2.

observation_healthEventTypeCategory :: Lens' Observation (Maybe Text) Source #

The category of the AWS Health event, such as issue.

observation_healthEventTypeCode :: Lens' Observation (Maybe Text) Source #

The type of the AWS Health event, for example, AWS_EC2_POWER_CONNECTIVITY_ISSUE.

observation_healthService :: Lens' Observation (Maybe Text) Source #

The service to which the AWS Health Event belongs, such as EC2.

observation_id :: Lens' Observation (Maybe Text) Source #

The ID of the observation type.

observation_lineTime :: Lens' Observation (Maybe UTCTime) Source #

The timestamp in the CloudWatch Logs that specifies when the matched line occurred.

observation_logFilter :: Lens' Observation (Maybe LogFilter) Source #

The log filter of the observation.

observation_logText :: Lens' Observation (Maybe Text) Source #

The log text of the observation.

observation_metricName :: Lens' Observation (Maybe Text) Source #

The name of the observation metric.

observation_metricNamespace :: Lens' Observation (Maybe Text) Source #

The namespace of the observation metric.

observation_s3EventName :: Lens' Observation (Maybe Text) Source #

The name of the S3 CloudWatch Event-based observation.

observation_sourceARN :: Lens' Observation (Maybe Text) Source #

The source resource ARN of the observation.

observation_sourceType :: Lens' Observation (Maybe Text) Source #

The source type of the observation.

observation_startTime :: Lens' Observation (Maybe UTCTime) Source #

The time when the observation was first detected, in epoch seconds.

observation_statesArn :: Lens' Observation (Maybe Text) Source #

The Amazon Resource Name (ARN) of the step function-based observation.

observation_statesExecutionArn :: Lens' Observation (Maybe Text) Source #

The Amazon Resource Name (ARN) of the step function execution-based observation.

observation_statesInput :: Lens' Observation (Maybe Text) Source #

The input to the step function-based observation.

observation_statesStatus :: Lens' Observation (Maybe Text) Source #

The status of the step function-related observation.

observation_unit :: Lens' Observation (Maybe Text) Source #

The unit of the source observation metric.

observation_value :: Lens' Observation (Maybe Double) Source #

The value of the source observation metric.

observation_xRayErrorPercent :: Lens' Observation (Maybe Int) Source #

The X-Ray request error percentage for this node.

observation_xRayFaultPercent :: Lens' Observation (Maybe Int) Source #

The X-Ray request fault percentage for this node.

observation_xRayNodeName :: Lens' Observation (Maybe Text) Source #

The name of the X-Ray node.

observation_xRayNodeType :: Lens' Observation (Maybe Text) Source #

The type of the X-Ray node.

observation_xRayRequestAverageLatency :: Lens' Observation (Maybe Integer) Source #

The X-Ray node request average latency for this node.

observation_xRayRequestCount :: Lens' Observation (Maybe Int) Source #

The X-Ray request count for this node.

observation_xRayThrottlePercent :: Lens' Observation (Maybe Int) Source #

The X-Ray request throttle percentage for this node.

Problem

problem_affectedResource :: Lens' Problem (Maybe Text) Source #

The resource affected by the problem.

problem_endTime :: Lens' Problem (Maybe UTCTime) Source #

The time when the problem ended, in epoch seconds.

problem_feedback :: Lens' Problem (Maybe (HashMap FeedbackKey FeedbackValue)) Source #

Feedback provided by the user about the problem.

problem_id :: Lens' Problem (Maybe Text) Source #

The ID of the problem.

problem_insights :: Lens' Problem (Maybe Text) Source #

A detailed analysis of the problem using machine learning.

problem_lastRecurrenceTime :: Lens' Problem (Maybe UTCTime) Source #

The last time that the problem reoccurred after its last resolution.

problem_recurringCount :: Lens' Problem (Maybe Integer) Source #

The number of times that the same problem reoccurred after the first time it was resolved.

problem_resourceGroupName :: Lens' Problem (Maybe Text) Source #

The name of the resource group affected by the problem.

problem_severityLevel :: Lens' Problem (Maybe SeverityLevel) Source #

A measure of the level of impact of the problem.

problem_startTime :: Lens' Problem (Maybe UTCTime) Source #

The time when the problem started, in epoch seconds.

problem_status :: Lens' Problem (Maybe Status) Source #

The status of the problem.

problem_title :: Lens' Problem (Maybe Text) Source #

The name of the problem.

RelatedObservations

relatedObservations_observationList :: Lens' RelatedObservations (Maybe [Observation]) Source #

The list of observations related to the problem.

Tag

tag_key :: Lens' Tag Text Source #

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.

tag_value :: Lens' Tag Text Source #

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.