{"note":"OpenAPI conversion -- returning structured metadata","name":"amazonaws-com-application-insights","description":"Amazon CloudWatch Application Insights","version":"2018-11-25","base_url":"","endpoints":33,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Amazon CloudWatch Application Insights\n@version 2018-11-25\n@auth AWS SigV4\n@endpoints 33\n@hint download_for_search\n@toc root(33)\n\n@endpoint POST /\n@desc Adds a workload to a component. Each component can have at most five workloads.\n@required {ResourceGroupName: str, ComponentName: str, WorkloadConfiguration: WorkloadConfiguration}\n@returns(200) {WorkloadId: str?, WorkloadConfiguration: WorkloadConfiguration?{WorkloadName: str?, Tier: str?, Configuration: str?}}\n\n@endpoint POST /\n@desc Adds an application that is created from a resource group.\n@optional {ResourceGroupName: str, OpsCenterEnabled: bool, CWEMonitorEnabled: bool, OpsItemSNSTopicArn: str, Tags: [Tag], AutoConfigEnabled: bool, AutoCreate: bool, GroupingType: str, AttachMissingPermission: bool}\n@returns(200) {ApplicationInfo: ApplicationInfo?{AccountId: str?, ResourceGroupName: str?, LifeCycle: str?, OpsItemSNSTopicArn: str?, OpsCenterEnabled: bool?, CWEMonitorEnabled: bool?, Remarks: str?, AutoConfigEnabled: bool?, DiscoveryType: str?, AttachMissingPermission: bool?}}\n\n@endpoint POST /\n@desc Creates a custom component by grouping similar standalone instances to monitor.\n@required {ResourceGroupName: str, ComponentName: str, ResourceList: [str]}\n\n@endpoint POST /\n@desc Adds an log pattern to a LogPatternSet.\n@required {ResourceGroupName: str, PatternSetName: str, PatternName: str, Pattern: str, Rank: int}\n@returns(200) {LogPattern: LogPattern?{PatternSetName: str?, PatternName: str?, Pattern: str?, Rank: int?}, ResourceGroupName: str?}\n\n@endpoint POST /\n@desc Removes the specified application from monitoring. Does not delete the application.\n@required {ResourceGroupName: str}\n\n@endpoint POST /\n@desc 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.\n@required {ResourceGroupName: str, ComponentName: str}\n\n@endpoint POST /\n@desc Removes the specified log pattern from a LogPatternSet.\n@required {ResourceGroupName: str, PatternSetName: str, PatternName: str}\n\n@endpoint POST /\n@desc Describes the application.\n@required {ResourceGroupName: str}\n@optional {AccountId: str}\n@returns(200) {ApplicationInfo: ApplicationInfo?{AccountId: str?, ResourceGroupName: str?, LifeCycle: str?, OpsItemSNSTopicArn: str?, OpsCenterEnabled: bool?, CWEMonitorEnabled: bool?, Remarks: str?, AutoConfigEnabled: bool?, DiscoveryType: str?, AttachMissingPermission: bool?}}\n\n@endpoint POST /\n@desc Describes a component and lists the resources that are grouped together in a component.\n@required {ResourceGroupName: str, ComponentName: str}\n@optional {AccountId: str}\n@returns(200) {ApplicationComponent: ApplicationComponent?{ComponentName: str?, ComponentRemarks: str?, ResourceType: str?, OsType: str?, Tier: str?, Monitor: bool?, DetectedWorkload: map<str,map<str,str>>?}, ResourceList: [str]?}\n\n@endpoint POST /\n@desc Describes the monitoring configuration of the component.\n@required {ResourceGroupName: str, ComponentName: str}\n@optional {AccountId: str}\n@returns(200) {Monitor: bool?, Tier: str?, ComponentConfiguration: str?}\n\n@endpoint POST /\n@desc Describes the recommended monitoring configuration of the component.\n@required {ResourceGroupName: str, ComponentName: str, Tier: str}\n@optional {WorkloadName: str, RecommendationType: str}\n@returns(200) {ComponentConfiguration: str?}\n\n@endpoint POST /\n@desc Describe a specific log pattern from a LogPatternSet.\n@required {ResourceGroupName: str, PatternSetName: str, PatternName: str}\n@optional {AccountId: str}\n@returns(200) {ResourceGroupName: str?, AccountId: str?, LogPattern: LogPattern?{PatternSetName: str?, PatternName: str?, Pattern: str?, Rank: int?}}\n\n@endpoint POST /\n@desc Describes an anomaly or error with the application.\n@required {ObservationId: str}\n@optional {AccountId: str}\n@returns(200) {Observation: Observation?{Id: str?, StartTime: str(timestamp)?, EndTime: str(timestamp)?, SourceType: str?, SourceARN: str?, LogGroup: str?, LineTime: str(timestamp)?, LogText: str?, LogFilter: str?, MetricNamespace: str?, MetricName: str?, Unit: str?, Value: num(f64)?, CloudWatchEventId: str?, CloudWatchEventSource: str?, CloudWatchEventDetailType: str?, HealthEventArn: str?, HealthService: str?, HealthEventTypeCode: str?, HealthEventTypeCategory: str?, HealthEventDescription: str?, CodeDeployDeploymentId: str?, CodeDeployDeploymentGroup: str?, CodeDeployState: str?, CodeDeployApplication: str?, CodeDeployInstanceGroupId: str?, Ec2State: str?, RdsEventCategories: str?, RdsEventMessage: str?, S3EventName: str?, StatesExecutionArn: str?, StatesArn: str?, StatesStatus: str?, StatesInput: str?, EbsEvent: str?, EbsResult: str?, EbsCause: str?, EbsRequestId: str?, XRayFaultPercent: int?, XRayThrottlePercent: int?, XRayErrorPercent: int?, XRayRequestCount: int?, XRayRequestAverageLatency: int(i64)?, XRayNodeName: str?, XRayNodeType: str?}}\n\n@endpoint POST /\n@desc Describes an application problem.\n@required {ProblemId: str}\n@optional {AccountId: str}\n@returns(200) {Problem: Problem?{Id: str?, Title: str?, Insights: str?, Status: str?, AffectedResource: str?, StartTime: str(timestamp)?, EndTime: str(timestamp)?, SeverityLevel: str?, AccountId: str?, ResourceGroupName: str?, Feedback: map<str,str>?, RecurringCount: int(i64)?, LastRecurrenceTime: str(timestamp)?, Visibility: str?, ResolutionMethod: str?}}\n\n@endpoint POST /\n@desc Describes the anomalies or errors associated with the problem.\n@required {ProblemId: str}\n@optional {AccountId: str}\n@returns(200) {RelatedObservations: RelatedObservations?{ObservationList: [Observation]?}}\n\n@endpoint POST /\n@desc Describes a workload and its configuration.\n@required {ResourceGroupName: str, ComponentName: str, WorkloadId: str}\n@optional {AccountId: str}\n@returns(200) {WorkloadId: str?, WorkloadRemarks: str?, WorkloadConfiguration: WorkloadConfiguration?{WorkloadName: str?, Tier: str?, Configuration: str?}}\n\n@endpoint POST /\n@desc Lists the IDs of the applications that you are monitoring.\n@optional {MaxResults: int, NextToken: str, AccountId: str}\n@returns(200) {ApplicationInfoList: [ApplicationInfo]?, NextToken: str?}\n\n@endpoint POST /\n@desc Lists the auto-grouped, standalone, and custom components of the application.\n@required {ResourceGroupName: str}\n@optional {MaxResults: int, NextToken: str, AccountId: str}\n@returns(200) {ApplicationComponentList: [ApplicationComponent]?, NextToken: str?}\n\n@endpoint POST /\n@desc 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.\n@optional {ResourceGroupName: str, StartTime: str(timestamp), EndTime: str(timestamp), EventStatus: str, MaxResults: int, NextToken: str, AccountId: str}\n@returns(200) {EventList: [ConfigurationEvent]?, NextToken: str?}\n\n@endpoint POST /\n@desc Lists the log pattern sets in the specific application.\n@required {ResourceGroupName: str}\n@optional {MaxResults: int, NextToken: str, AccountId: str}\n@returns(200) {ResourceGroupName: str?, AccountId: str?, LogPatternSets: [str]?, NextToken: str?}\n\n@endpoint POST /\n@desc Lists the log patterns in the specific log LogPatternSet.\n@required {ResourceGroupName: str}\n@optional {PatternSetName: str, MaxResults: int, NextToken: str, AccountId: str}\n@returns(200) {ResourceGroupName: str?, AccountId: str?, LogPatterns: [LogPattern]?, NextToken: str?}\n\n@endpoint POST /\n@desc Lists the problems with your application.\n@optional {AccountId: str, ResourceGroupName: str, StartTime: str(timestamp), EndTime: str(timestamp), MaxResults: int, NextToken: str, ComponentName: str, Visibility: str}\n@returns(200) {ProblemList: [Problem]?, NextToken: str?, ResourceGroupName: str?, AccountId: str?}\n\n@endpoint POST /\n@desc 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.\n@required {ResourceARN: str}\n@returns(200) {Tags: [Tag]?}\n\n@endpoint POST /\n@desc Lists the workloads that are configured on a given component.\n@required {ResourceGroupName: str, ComponentName: str}\n@optional {MaxResults: int, NextToken: str, AccountId: str}\n@returns(200) {WorkloadList: [Workload]?, NextToken: str?}\n\n@endpoint POST /\n@desc Remove workload from a component.\n@required {ResourceGroupName: str, ComponentName: str, WorkloadId: str}\n\n@endpoint POST /\n@desc 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.\n@required {ResourceARN: str, Tags: [Tag]}\n\n@endpoint POST /\n@desc Remove one or more tags (keys and values) from a specified application.\n@required {ResourceARN: str, TagKeys: [str]}\n\n@endpoint POST /\n@desc Updates the application.\n@required {ResourceGroupName: str}\n@optional {OpsCenterEnabled: bool, CWEMonitorEnabled: bool, OpsItemSNSTopicArn: str, RemoveSNSTopic: bool, AutoConfigEnabled: bool, AttachMissingPermission: bool}\n@returns(200) {ApplicationInfo: ApplicationInfo?{AccountId: str?, ResourceGroupName: str?, LifeCycle: str?, OpsItemSNSTopicArn: str?, OpsCenterEnabled: bool?, CWEMonitorEnabled: bool?, Remarks: str?, AutoConfigEnabled: bool?, DiscoveryType: str?, AttachMissingPermission: bool?}}\n\n@endpoint POST /\n@desc Updates the custom component name and/or the list of resources that make up the component.\n@required {ResourceGroupName: str, ComponentName: str}\n@optional {NewComponentName: str, ResourceList: [str]}\n\n@endpoint POST /\n@desc 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.\n@required {ResourceGroupName: str, ComponentName: str}\n@optional {Monitor: bool, Tier: str, ComponentConfiguration: str, AutoConfigEnabled: bool}\n\n@endpoint POST /\n@desc Adds a log pattern to a LogPatternSet.\n@required {ResourceGroupName: str, PatternSetName: str, PatternName: str}\n@optional {Pattern: str, Rank: int}\n@returns(200) {ResourceGroupName: str?, LogPattern: LogPattern?{PatternSetName: str?, PatternName: str?, Pattern: str?, Rank: int?}}\n\n@endpoint POST /\n@desc Updates the visibility of the problem or specifies the problem as RESOLVED.\n@required {ProblemId: str}\n@optional {UpdateStatus: str, Visibility: str}\n\n@endpoint POST /\n@desc Adds a workload to a component. Each component can have at most five workloads.\n@required {ResourceGroupName: str, ComponentName: str, WorkloadConfiguration: WorkloadConfiguration}\n@optional {WorkloadId: str}\n@returns(200) {WorkloadId: str?, WorkloadConfiguration: WorkloadConfiguration?{WorkloadName: str?, Tier: str?, Configuration: str?}}\n\n@end\n"}