5.0.0 • Published 5 years ago

@datafire/amazonaws_application_insights v5.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/amazonaws_application_insights

Client library for Amazon CloudWatch Application Insights

Installation and Usage

npm install --save @datafire/amazonaws_application_insights
let amazonaws_application_insights = require('@datafire/amazonaws_application_insights').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

Amazon CloudWatch Application Insights 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.

Actions

CreateApplication

amazonaws_application_insights.CreateApplication({
  "ResourceGroupName": null
}, context)

Input

  • input object
    • CWEMonitorEnabled
    • OpsCenterEnabled
    • OpsItemSNSTopicArn
    • ResourceGroupName required
    • Tags

Output

CreateComponent

amazonaws_application_insights.CreateComponent({
  "ResourceGroupName": null,
  "ComponentName": null,
  "ResourceList": null
}, context)

Input

  • input object
    • ComponentName required
    • ResourceGroupName required
    • ResourceList required

Output

CreateLogPattern

amazonaws_application_insights.CreateLogPattern({
  "ResourceGroupName": null,
  "PatternSetName": null,
  "PatternName": null,
  "Pattern": null,
  "Rank": null
}, context)

Input

  • input object
    • Pattern required
    • PatternName required
    • PatternSetName required
    • Rank required
    • ResourceGroupName required

Output

DeleteApplication

amazonaws_application_insights.DeleteApplication({
  "ResourceGroupName": null
}, context)

Input

  • input object
    • ResourceGroupName required

Output

DeleteComponent

amazonaws_application_insights.DeleteComponent({
  "ResourceGroupName": null,
  "ComponentName": null
}, context)

Input

  • input object
    • ComponentName required
    • ResourceGroupName required

Output

DeleteLogPattern

amazonaws_application_insights.DeleteLogPattern({
  "ResourceGroupName": null,
  "PatternSetName": null,
  "PatternName": null
}, context)

Input

  • input object
    • PatternName required
    • PatternSetName required
    • ResourceGroupName required

Output

DescribeApplication

amazonaws_application_insights.DescribeApplication({
  "ResourceGroupName": null
}, context)

Input

  • input object
    • ResourceGroupName required

Output

DescribeComponent

amazonaws_application_insights.DescribeComponent({
  "ResourceGroupName": null,
  "ComponentName": null
}, context)

Input

  • input object
    • ComponentName required
    • ResourceGroupName required

Output

DescribeComponentConfiguration

amazonaws_application_insights.DescribeComponentConfiguration({
  "ResourceGroupName": null,
  "ComponentName": null
}, context)

Input

  • input object
    • ComponentName required
    • ResourceGroupName required

Output

DescribeComponentConfigurationRecommendation

amazonaws_application_insights.DescribeComponentConfigurationRecommendation({
  "ResourceGroupName": null,
  "ComponentName": null,
  "Tier": null
}, context)

Input

  • input object
    • ComponentName required
    • ResourceGroupName required
    • Tier required

Output

DescribeLogPattern

amazonaws_application_insights.DescribeLogPattern({
  "ResourceGroupName": null,
  "PatternSetName": null,
  "PatternName": null
}, context)

Input

  • input object
    • PatternName required
    • PatternSetName required
    • ResourceGroupName required

Output

DescribeObservation

amazonaws_application_insights.DescribeObservation({
  "ObservationId": null
}, context)

Input

  • input object
    • ObservationId required

Output

DescribeProblem

amazonaws_application_insights.DescribeProblem({
  "ProblemId": null
}, context)

Input

  • input object
    • ProblemId required

Output

DescribeProblemObservations

amazonaws_application_insights.DescribeProblemObservations({
  "ProblemId": null
}, context)

Input

  • input object
    • ProblemId required

Output

ListApplications

amazonaws_application_insights.ListApplications({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • MaxResults
    • NextToken

Output

ListComponents

amazonaws_application_insights.ListComponents({
  "ResourceGroupName": null
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • MaxResults
    • NextToken
    • ResourceGroupName required

Output

ListConfigurationHistory

amazonaws_application_insights.ListConfigurationHistory({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • EndTime
    • EventStatus
    • MaxResults
    • NextToken
    • ResourceGroupName
    • StartTime

Output

ListLogPatternSets

amazonaws_application_insights.ListLogPatternSets({
  "ResourceGroupName": null
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • MaxResults
    • NextToken
    • ResourceGroupName required

Output

ListLogPatterns

amazonaws_application_insights.ListLogPatterns({
  "ResourceGroupName": null
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • MaxResults
    • NextToken
    • PatternSetName
    • ResourceGroupName required

Output

ListProblems

amazonaws_application_insights.ListProblems({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • EndTime
    • MaxResults
    • NextToken
    • ResourceGroupName
    • StartTime

Output

ListTagsForResource

amazonaws_application_insights.ListTagsForResource({
  "ResourceARN": null
}, context)

Input

  • input object
    • ResourceARN required

Output

TagResource

amazonaws_application_insights.TagResource({
  "ResourceARN": null,
  "Tags": null
}, context)

Input

  • input object
    • ResourceARN required
    • Tags required

Output

UntagResource

amazonaws_application_insights.UntagResource({
  "ResourceARN": null,
  "TagKeys": null
}, context)

Input

  • input object
    • ResourceARN required
    • TagKeys required

Output

UpdateApplication

amazonaws_application_insights.UpdateApplication({
  "ResourceGroupName": null
}, context)

Input

  • input object
    • CWEMonitorEnabled
    • OpsCenterEnabled
    • OpsItemSNSTopicArn
    • RemoveSNSTopic
    • ResourceGroupName required

Output

UpdateComponent

amazonaws_application_insights.UpdateComponent({
  "ResourceGroupName": null,
  "ComponentName": null
}, context)

Input

  • input object
    • ComponentName required
    • NewComponentName
    • ResourceGroupName required
    • ResourceList

Output

UpdateComponentConfiguration

amazonaws_application_insights.UpdateComponentConfiguration({
  "ResourceGroupName": null,
  "ComponentName": null
}, context)

Input

  • input object
    • ComponentConfiguration
    • ComponentName required
    • Monitor
    • ResourceGroupName required
    • Tier

Output

UpdateLogPattern

amazonaws_application_insights.UpdateLogPattern({
  "ResourceGroupName": null,
  "PatternSetName": null,
  "PatternName": null
}, context)

Input

  • input object
    • Pattern
    • PatternName required
    • PatternSetName required
    • Rank
    • ResourceGroupName required

Output

Definitions

AccessDeniedException

AffectedResource

  • AffectedResource string

AmazonResourceName

  • AmazonResourceName string

ApplicationComponent

  • ApplicationComponent object: Describes a standalone resource or similarly grouped resources that the application is made up of.
    • ComponentName
    • ComponentRemarks
    • DetectedWorkload
    • Monitor
    • OsType
    • ResourceType
    • Tier

ApplicationComponentList

ApplicationInfo

  • ApplicationInfo object: Describes the status of the application.
    • CWEMonitorEnabled
    • LifeCycle
    • OpsCenterEnabled
    • OpsItemSNSTopicArn
    • Remarks
    • ResourceGroupName

ApplicationInfoList

BadRequestException

CWEMonitorEnabled

  • CWEMonitorEnabled boolean

CloudWatchEventDetailType

  • CloudWatchEventDetailType string

CloudWatchEventId

  • CloudWatchEventId string

CloudWatchEventSource

  • CloudWatchEventSource string (values: EC2, CODE_DEPLOY, HEALTH, RDS)

CodeDeployApplication

  • CodeDeployApplication string

CodeDeployDeploymentGroup

  • CodeDeployDeploymentGroup string

CodeDeployDeploymentId

  • CodeDeployDeploymentId string

CodeDeployInstanceGroupId

  • CodeDeployInstanceGroupId string

CodeDeployState

  • CodeDeployState string

ComponentConfiguration

  • ComponentConfiguration string

ComponentName

  • ComponentName string

ConfigurationEvent

  • ConfigurationEvent object: The event information.
    • EventDetail
    • EventResourceName
    • EventResourceType
    • EventStatus
    • EventTime
    • MonitoredResourceARN

ConfigurationEventDetail

  • ConfigurationEventDetail string

ConfigurationEventList

ConfigurationEventMonitoredResourceARN

  • ConfigurationEventMonitoredResourceARN string

ConfigurationEventResourceName

  • ConfigurationEventResourceName string

ConfigurationEventResourceType

  • ConfigurationEventResourceType string (values: CLOUDWATCH_ALARM, CLOUDWATCH_LOG, CLOUDFORMATION, SSM_ASSOCIATION)

ConfigurationEventStatus

  • ConfigurationEventStatus string (values: INFO, WARN, ERROR)

ConfigurationEventTime

  • ConfigurationEventTime string

CreateApplicationRequest

  • CreateApplicationRequest object
    • CWEMonitorEnabled
    • OpsCenterEnabled
    • OpsItemSNSTopicArn
    • ResourceGroupName required
    • Tags

CreateApplicationResponse

  • CreateApplicationResponse object
    • ApplicationInfo
      • CWEMonitorEnabled
      • LifeCycle
      • OpsCenterEnabled
      • OpsItemSNSTopicArn
      • Remarks
      • ResourceGroupName

CreateComponentRequest

  • CreateComponentRequest object
    • ComponentName required
    • ResourceGroupName required
    • ResourceList required

CreateComponentResponse

  • CreateComponentResponse object

CreateLogPatternRequest

  • CreateLogPatternRequest object
    • Pattern required
    • PatternName required
    • PatternSetName required
    • Rank required
    • ResourceGroupName required

CreateLogPatternResponse

  • CreateLogPatternResponse object
    • LogPattern
      • Pattern
      • PatternName
      • PatternSetName
      • Rank
    • ResourceGroupName

CustomComponentName

  • CustomComponentName string

DeleteApplicationRequest

  • DeleteApplicationRequest object
    • ResourceGroupName required

DeleteApplicationResponse

  • DeleteApplicationResponse object

DeleteComponentRequest

  • DeleteComponentRequest object
    • ComponentName required
    • ResourceGroupName required

DeleteComponentResponse

  • DeleteComponentResponse object

DeleteLogPatternRequest

  • DeleteLogPatternRequest object
    • PatternName required
    • PatternSetName required
    • ResourceGroupName required

DeleteLogPatternResponse

  • DeleteLogPatternResponse object

DescribeApplicationRequest

  • DescribeApplicationRequest object
    • ResourceGroupName required

DescribeApplicationResponse

  • DescribeApplicationResponse object
    • ApplicationInfo
      • CWEMonitorEnabled
      • LifeCycle
      • OpsCenterEnabled
      • OpsItemSNSTopicArn
      • Remarks
      • ResourceGroupName

DescribeComponentConfigurationRecommendationRequest

  • DescribeComponentConfigurationRecommendationRequest object
    • ComponentName required
    • ResourceGroupName required
    • Tier required

DescribeComponentConfigurationRecommendationResponse

  • DescribeComponentConfigurationRecommendationResponse object
    • ComponentConfiguration

DescribeComponentConfigurationRequest

  • DescribeComponentConfigurationRequest object
    • ComponentName required
    • ResourceGroupName required

DescribeComponentConfigurationResponse

  • DescribeComponentConfigurationResponse object
    • ComponentConfiguration
    • Monitor
    • Tier

DescribeComponentRequest

  • DescribeComponentRequest object
    • ComponentName required
    • ResourceGroupName required

DescribeComponentResponse

DescribeLogPatternRequest

  • DescribeLogPatternRequest object
    • PatternName required
    • PatternSetName required
    • ResourceGroupName required

DescribeLogPatternResponse

  • DescribeLogPatternResponse object
    • LogPattern
      • Pattern
      • PatternName
      • PatternSetName
      • Rank
    • ResourceGroupName

DescribeObservationRequest

  • DescribeObservationRequest object
    • ObservationId required

DescribeObservationResponse

  • DescribeObservationResponse object
    • Observation
      • CloudWatchEventDetailType
      • CloudWatchEventId
      • CloudWatchEventSource
      • CodeDeployApplication
      • CodeDeployDeploymentGroup
      • CodeDeployDeploymentId
      • CodeDeployInstanceGroupId
      • CodeDeployState
      • EbsCause
      • EbsEvent
      • EbsRequestId
      • EbsResult
      • Ec2State
      • EndTime
      • HealthEventArn
      • HealthEventDescription
      • HealthEventTypeCategory
      • HealthEventTypeCode
      • HealthService
      • Id
      • LineTime
      • LogFilter
      • LogGroup
      • LogText
      • MetricName
      • MetricNamespace
      • RdsEventCategories
      • RdsEventMessage
      • S3EventName
      • SourceARN
      • SourceType
      • StartTime
      • StatesArn
      • StatesExecutionArn
      • StatesInput
      • StatesStatus
      • Unit
      • Value
      • XRayErrorPercent
      • XRayFaultPercent
      • XRayNodeName
      • XRayNodeType
      • XRayRequestAverageLatency
      • XRayRequestCount
      • XRayThrottlePercent

DescribeProblemObservationsRequest

  • DescribeProblemObservationsRequest object
    • ProblemId required

DescribeProblemObservationsResponse

  • DescribeProblemObservationsResponse object

DescribeProblemRequest

  • DescribeProblemRequest object
    • ProblemId required

DescribeProblemResponse

  • DescribeProblemResponse object
    • Problem
      • AffectedResource
      • EndTime
      • Feedback
      • Id
      • Insights
      • ResourceGroupName
      • SeverityLevel
      • StartTime
      • Status
      • Title

DetectedWorkload

  • DetectedWorkload object

EbsCause

  • EbsCause string

EbsEvent

  • EbsEvent string

EbsRequestId

  • EbsRequestId string

EbsResult

  • EbsResult string

Ec2State

  • Ec2State string

EndTime

  • EndTime string

Feedback

  • Feedback object

FeedbackKey

  • FeedbackKey string (values: INSIGHTS_FEEDBACK)

FeedbackValue

  • FeedbackValue string (values: NOT_SPECIFIED, USEFUL, NOT_USEFUL)

HealthEventArn

  • HealthEventArn string

HealthEventDescription

  • HealthEventDescription string

HealthEventTypeCategory

  • HealthEventTypeCategory string

HealthEventTypeCode

  • HealthEventTypeCode string

HealthService

  • HealthService string

Insights

  • Insights string

InternalServerException

LifeCycle

  • LifeCycle string

LineTime

  • LineTime string

ListApplicationsRequest

  • ListApplicationsRequest object
    • MaxResults
    • NextToken

ListApplicationsResponse

  • ListApplicationsResponse object

ListComponentsRequest

  • ListComponentsRequest object
    • MaxResults
    • NextToken
    • ResourceGroupName required

ListComponentsResponse

ListConfigurationHistoryRequest

  • ListConfigurationHistoryRequest object
    • EndTime
    • EventStatus
    • MaxResults
    • NextToken
    • ResourceGroupName
    • StartTime

ListConfigurationHistoryResponse

ListLogPatternSetsRequest

  • ListLogPatternSetsRequest object
    • MaxResults
    • NextToken
    • ResourceGroupName required

ListLogPatternSetsResponse

  • ListLogPatternSetsResponse object

ListLogPatternsRequest

  • ListLogPatternsRequest object
    • MaxResults
    • NextToken
    • PatternSetName
    • ResourceGroupName required

ListLogPatternsResponse

  • ListLogPatternsResponse object
    • LogPatterns
    • NextToken
    • ResourceGroupName

ListProblemsRequest

  • ListProblemsRequest object
    • EndTime
    • MaxResults
    • NextToken
    • ResourceGroupName
    • StartTime

ListProblemsResponse

  • ListProblemsResponse object

ListTagsForResourceRequest

  • ListTagsForResourceRequest object
    • ResourceARN required

ListTagsForResourceResponse

  • ListTagsForResourceResponse object

LogFilter

  • LogFilter string (values: ERROR, WARN, INFO)

LogGroup

  • LogGroup string

LogPattern

  • LogPattern object: An object that defines the log patterns that belongs to a LogPatternSet.
    • Pattern
    • PatternName
    • PatternSetName
    • Rank

LogPatternList

LogPatternName

  • LogPatternName string

LogPatternRank

  • LogPatternRank integer

LogPatternRegex

  • LogPatternRegex string

LogPatternSetList

LogPatternSetName

  • LogPatternSetName string

LogText

  • LogText string

MaxEntities

  • MaxEntities integer

MetaDataKey

  • MetaDataKey string

MetaDataValue

  • MetaDataValue string

MetricName

  • MetricName string

MetricNamespace

  • MetricNamespace string

Monitor

  • Monitor boolean

Observation

  • Observation object: Describes an anomaly or error with the application.
    • CloudWatchEventDetailType
    • CloudWatchEventId
    • CloudWatchEventSource
    • CodeDeployApplication
    • CodeDeployDeploymentGroup
    • CodeDeployDeploymentId
    • CodeDeployInstanceGroupId
    • CodeDeployState
    • EbsCause
    • EbsEvent
    • EbsRequestId
    • EbsResult
    • Ec2State
    • EndTime
    • HealthEventArn
    • HealthEventDescription
    • HealthEventTypeCategory
    • HealthEventTypeCode
    • HealthService
    • Id
    • LineTime
    • LogFilter
    • LogGroup
    • LogText
    • MetricName
    • MetricNamespace
    • RdsEventCategories
    • RdsEventMessage
    • S3EventName
    • SourceARN
    • SourceType
    • StartTime
    • StatesArn
    • StatesExecutionArn
    • StatesInput
    • StatesStatus
    • Unit
    • Value
    • XRayErrorPercent
    • XRayFaultPercent
    • XRayNodeName
    • XRayNodeType
    • XRayRequestAverageLatency
    • XRayRequestCount
    • XRayThrottlePercent

ObservationId

  • ObservationId string

ObservationList

OpsCenterEnabled

  • OpsCenterEnabled boolean

OpsItemSNSTopicArn

  • OpsItemSNSTopicArn string

OsType

  • OsType string (values: WINDOWS, LINUX)

PaginationToken

  • PaginationToken string

Problem

  • Problem object: Describes a problem that is detected by correlating observations.
    • AffectedResource
    • EndTime
    • Feedback
    • Id
    • Insights
    • ResourceGroupName
    • SeverityLevel
    • StartTime
    • Status
    • Title

ProblemId

  • ProblemId string

ProblemList

RdsEventCategories

  • RdsEventCategories string

RdsEventMessage

  • RdsEventMessage string

RelatedObservations

  • RelatedObservations object: Describes observations related to the problem.

Remarks

  • Remarks string

RemoveSNSTopic

  • RemoveSNSTopic boolean

ResourceARN

  • ResourceARN string

ResourceGroupName

  • ResourceGroupName string

ResourceInUseException

ResourceList

ResourceNotFoundException

ResourceType

  • ResourceType string

S3EventName

  • S3EventName string

SeverityLevel

  • SeverityLevel string (values: Low, Medium, High)

SourceARN

  • SourceARN string

SourceType

  • SourceType string

StartTime

  • StartTime string

StatesArn

  • StatesArn string

StatesExecutionArn

  • StatesExecutionArn string

StatesInput

  • StatesInput string

StatesStatus

  • StatesStatus string

Status

  • Status string (values: IGNORE, RESOLVED, PENDING)

Tag

  • Tag object: 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.
    • Key required
    • Value required

TagKey

  • TagKey string

TagKeyList

TagList

  • TagList array

TagResourceRequest

  • TagResourceRequest object
    • ResourceARN required
    • Tags required

TagResourceResponse

  • TagResourceResponse object

TagValue

  • TagValue string

TagsAlreadyExistException

Tier

  • Tier string (values: 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)

Title

  • Title string

TooManyTagsException

Unit

  • Unit string

UntagResourceRequest

  • UntagResourceRequest object
    • ResourceARN required
    • TagKeys required

UntagResourceResponse

  • UntagResourceResponse object

UpdateApplicationRequest

  • UpdateApplicationRequest object
    • CWEMonitorEnabled
    • OpsCenterEnabled
    • OpsItemSNSTopicArn
    • RemoveSNSTopic
    • ResourceGroupName required

UpdateApplicationResponse

  • UpdateApplicationResponse object
    • ApplicationInfo
      • CWEMonitorEnabled
      • LifeCycle
      • OpsCenterEnabled
      • OpsItemSNSTopicArn
      • Remarks
      • ResourceGroupName

UpdateComponentConfigurationRequest

  • UpdateComponentConfigurationRequest object
    • ComponentConfiguration
    • ComponentName required
    • Monitor
    • ResourceGroupName required
    • Tier

UpdateComponentConfigurationResponse

  • UpdateComponentConfigurationResponse object

UpdateComponentRequest

  • UpdateComponentRequest object
    • ComponentName required
    • NewComponentName
    • ResourceGroupName required
    • ResourceList

UpdateComponentResponse

  • UpdateComponentResponse object

UpdateLogPatternRequest

  • UpdateLogPatternRequest object
    • Pattern
    • PatternName required
    • PatternSetName required
    • Rank
    • ResourceGroupName required

UpdateLogPatternResponse

  • UpdateLogPatternResponse object
    • LogPattern
      • Pattern
      • PatternName
      • PatternSetName
      • Rank
    • ResourceGroupName

ValidationException

Value

  • Value number

WorkloadMetaData

  • WorkloadMetaData object

XRayErrorPercent

  • XRayErrorPercent integer

XRayFaultPercent

  • XRayFaultPercent integer

XRayNodeName

  • XRayNodeName string

XRayNodeType

  • XRayNodeType string

XRayRequestAverageLatency

  • XRayRequestAverageLatency integer

XRayRequestCount

  • XRayRequestCount integer

XRayThrottlePercent

  • XRayThrottlePercent integer