{ "version": "2.0", "metadata": { "apiVersion": "2018-11-25", "endpointPrefix": "applicationinsights", "jsonVersion": "1.1", "protocol": "json", "serviceAbbreviation": "Application Insights", "serviceFullName": "Amazon CloudWatch Application Insights", "serviceId": "Application Insights", "signatureVersion": "v4", "signingName": "applicationinsights", "targetPrefix": "EC2WindowsBarleyService", "uid": "application-insights-2018-11-25" }, "operations": { "AddWorkload": { "name": "AddWorkload", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AddWorkloadRequest" }, "output": { "shape": "AddWorkloadResponse" }, "errors": [ { "shape": "ResourceInUseException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ValidationException" }, { "shape": "InternalServerException" } ], "documentation": "

Adds a workload to a component. Each component can have at most five workloads.

" }, "CreateApplication": { "name": "CreateApplication", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateApplicationRequest" }, "output": { "shape": "CreateApplicationResponse" }, "errors": [ { "shape": "ResourceInUseException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ValidationException" }, { "shape": "InternalServerException" }, { "shape": "TagsAlreadyExistException" }, { "shape": "AccessDeniedException" } ], "documentation": "

Adds an application that is created from a resource group.

" }, "CreateComponent": { "name": "CreateComponent", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateComponentRequest" }, "output": { "shape": "CreateComponentResponse" }, "errors": [ { "shape": "ResourceInUseException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ValidationException" }, { "shape": "InternalServerException" } ], "documentation": "

Creates a custom component by grouping similar standalone instances to monitor.

" }, "CreateLogPattern": { "name": "CreateLogPattern", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateLogPatternRequest" }, "output": { "shape": "CreateLogPatternResponse" }, "errors": [ { "shape": "ResourceInUseException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ValidationException" }, { "shape": "InternalServerException" } ], "documentation": "

Adds an log pattern to a LogPatternSet.

" }, "DeleteApplication": { "name": "DeleteApplication", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteApplicationRequest" }, "output": { "shape": "DeleteApplicationResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "ValidationException" }, { "shape": "BadRequestException" }, { "shape": "InternalServerException" } ], "documentation": "

Removes the specified application from monitoring. Does not delete the application.

" }, "DeleteComponent": { "name": "DeleteComponent", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteComponentRequest" }, "output": { "shape": "DeleteComponentResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "ValidationException" }, { "shape": "InternalServerException" } ], "documentation": "

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": { "name": "DeleteLogPattern", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteLogPatternRequest" }, "output": { "shape": "DeleteLogPatternResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "ValidationException" }, { "shape": "BadRequestException" }, { "shape": "InternalServerException" } ], "documentation": "

Removes the specified log pattern from a LogPatternSet.

" }, "DescribeApplication": { "name": "DescribeApplication", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeApplicationRequest" }, "output": { "shape": "DescribeApplicationResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "ValidationException" }, { "shape": "InternalServerException" } ], "documentation": "

Describes the application.

" }, "DescribeComponent": { "name": "DescribeComponent", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeComponentRequest" }, "output": { "shape": "DescribeComponentResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "ValidationException" }, { "shape": "InternalServerException" } ], "documentation": "

Describes a component and lists the resources that are grouped together in a component.

" }, "DescribeComponentConfiguration": { "name": "DescribeComponentConfiguration", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeComponentConfigurationRequest" }, "output": { "shape": "DescribeComponentConfigurationResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "ValidationException" }, { "shape": "InternalServerException" } ], "documentation": "

Describes the monitoring configuration of the component.

" }, "DescribeComponentConfigurationRecommendation": { "name": "DescribeComponentConfigurationRecommendation", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeComponentConfigurationRecommendationRequest" }, "output": { "shape": "DescribeComponentConfigurationRecommendationResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "ValidationException" }, { "shape": "InternalServerException" } ], "documentation": "

Describes the recommended monitoring configuration of the component.

" }, "DescribeLogPattern": { "name": "DescribeLogPattern", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeLogPatternRequest" }, "output": { "shape": "DescribeLogPatternResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "ValidationException" }, { "shape": "InternalServerException" } ], "documentation": "

Describe a specific log pattern from a LogPatternSet.

" }, "DescribeObservation": { "name": "DescribeObservation", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeObservationRequest" }, "output": { "shape": "DescribeObservationResponse" }, "errors": [ { "shape": "InternalServerException" }, { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "

Describes an anomaly or error with the application.

" }, "DescribeProblem": { "name": "DescribeProblem", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeProblemRequest" }, "output": { "shape": "DescribeProblemResponse" }, "errors": [ { "shape": "InternalServerException" }, { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "

Describes an application problem.

" }, "DescribeProblemObservations": { "name": "DescribeProblemObservations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeProblemObservationsRequest" }, "output": { "shape": "DescribeProblemObservationsResponse" }, "errors": [ { "shape": "InternalServerException" }, { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "

Describes the anomalies or errors associated with the problem.

" }, "DescribeWorkload": { "name": "DescribeWorkload", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeWorkloadRequest" }, "output": { "shape": "DescribeWorkloadResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "ValidationException" }, { "shape": "InternalServerException" } ], "documentation": "

Describes a workload and its configuration.

" }, "ListApplications": { "name": "ListApplications", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListApplicationsRequest" }, "output": { "shape": "ListApplicationsResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "InternalServerException" } ], "documentation": "

Lists the IDs of the applications that you are monitoring.

" }, "ListComponents": { "name": "ListComponents", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListComponentsRequest" }, "output": { "shape": "ListComponentsResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "ValidationException" }, { "shape": "InternalServerException" } ], "documentation": "

Lists the auto-grouped, standalone, and custom components of the application.

" }, "ListConfigurationHistory": { "name": "ListConfigurationHistory", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListConfigurationHistoryRequest" }, "output": { "shape": "ListConfigurationHistoryResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" }, { "shape": "InternalServerException" } ], "documentation": "

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

" }, "ListLogPatternSets": { "name": "ListLogPatternSets", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListLogPatternSetsRequest" }, "output": { "shape": "ListLogPatternSetsResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "ValidationException" }, { "shape": "InternalServerException" } ], "documentation": "

Lists the log pattern sets in the specific application.

" }, "ListLogPatterns": { "name": "ListLogPatterns", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListLogPatternsRequest" }, "output": { "shape": "ListLogPatternsResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "ValidationException" }, { "shape": "InternalServerException" } ], "documentation": "

Lists the log patterns in the specific log LogPatternSet.

" }, "ListProblems": { "name": "ListProblems", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListProblemsRequest" }, "output": { "shape": "ListProblemsResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" }, { "shape": "InternalServerException" } ], "documentation": "

Lists the problems with your application.

" }, "ListTagsForResource": { "name": "ListTagsForResource", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListTagsForResourceRequest" }, "output": { "shape": "ListTagsForResourceResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "ValidationException" } ], "documentation": "

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": { "name": "ListWorkloads", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListWorkloadsRequest" }, "output": { "shape": "ListWorkloadsResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "ValidationException" }, { "shape": "InternalServerException" } ], "documentation": "

Lists the workloads that are configured on a given component.

" }, "RemoveWorkload": { "name": "RemoveWorkload", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RemoveWorkloadRequest" }, "output": { "shape": "RemoveWorkloadResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "ValidationException" }, { "shape": "InternalServerException" } ], "documentation": "

Remove workload from a component.

" }, "TagResource": { "name": "TagResource", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "TagResourceRequest" }, "output": { "shape": "TagResourceResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "TooManyTagsException" }, { "shape": "ValidationException" } ], "documentation": "

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": { "name": "UntagResource", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UntagResourceRequest" }, "output": { "shape": "UntagResourceResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "ValidationException" } ], "documentation": "

Remove one or more tags (keys and values) from a specified application.

" }, "UpdateApplication": { "name": "UpdateApplication", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateApplicationRequest" }, "output": { "shape": "UpdateApplicationResponse" }, "errors": [ { "shape": "InternalServerException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ValidationException" } ], "documentation": "

Updates the application.

" }, "UpdateComponent": { "name": "UpdateComponent", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateComponentRequest" }, "output": { "shape": "UpdateComponentResponse" }, "errors": [ { "shape": "ResourceInUseException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ValidationException" }, { "shape": "InternalServerException" } ], "documentation": "

Updates the custom component name and/or the list of resources that make up the component.

" }, "UpdateComponentConfiguration": { "name": "UpdateComponentConfiguration", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateComponentConfigurationRequest" }, "output": { "shape": "UpdateComponentConfigurationResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "ValidationException" }, { "shape": "InternalServerException" }, { "shape": "ResourceInUseException" } ], "documentation": "

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.

" }, "UpdateLogPattern": { "name": "UpdateLogPattern", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateLogPatternRequest" }, "output": { "shape": "UpdateLogPatternResponse" }, "errors": [ { "shape": "ResourceInUseException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ValidationException" }, { "shape": "InternalServerException" } ], "documentation": "

Adds a log pattern to a LogPatternSet.

" }, "UpdateProblem": { "name": "UpdateProblem", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateProblemRequest" }, "output": { "shape": "UpdateProblemResponse" }, "errors": [ { "shape": "InternalServerException" }, { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "

Updates the visibility of the problem or specifies the problem as RESOLVED.

" }, "UpdateWorkload": { "name": "UpdateWorkload", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateWorkloadRequest" }, "output": { "shape": "UpdateWorkloadResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "ValidationException" }, { "shape": "InternalServerException" } ], "documentation": "

Adds a workload to a component. Each component can have at most five workloads.

" } }, "shapes": { "AccountId": { "type": "string", "max": 12, "min": 12, "pattern": "^\\d{12}$" }, "AddWorkloadRequest": { "type": "structure", "required": [ "ResourceGroupName", "ComponentName", "WorkloadConfiguration" ], "members": { "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group.

" }, "ComponentName": { "shape": "ComponentName", "documentation": "

The name of the component.

" }, "WorkloadConfiguration": { "shape": "WorkloadConfiguration", "documentation": "

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

" } } }, "AddWorkloadResponse": { "type": "structure", "members": { "WorkloadId": { "shape": "WorkloadId", "documentation": "

The ID of the workload.

" }, "WorkloadConfiguration": { "shape": "WorkloadConfiguration", "documentation": "

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

" } } }, "AffectedResource": { "type": "string" }, "AmazonResourceName": { "type": "string", "max": 1011, "min": 1, "pattern": "^arn:aws(-\\w+)*:[\\w\\d-]+:([\\w\\d-]*)?:[\\w\\d_-]*([:/].+)*$" }, "ApplicationComponent": { "type": "structure", "members": { "ComponentName": { "shape": "ComponentName", "documentation": "

The name of the component.

" }, "ComponentRemarks": { "shape": "Remarks", "documentation": "

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

" }, "ResourceType": { "shape": "ResourceType", "documentation": "

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

" }, "OsType": { "shape": "OsType", "documentation": "

The operating system of the component.

" }, "Tier": { "shape": "Tier", "documentation": "

The stack tier of the application component.

" }, "Monitor": { "shape": "Monitor", "documentation": "

Indicates whether the application component is monitored.

" }, "DetectedWorkload": { "shape": "DetectedWorkload", "documentation": "

Workloads detected in the application component.

" } }, "documentation": "

Describes a standalone resource or similarly grouped resources that the application is made up of.

" }, "ApplicationComponentList": { "type": "list", "member": { "shape": "ApplicationComponent" } }, "ApplicationInfo": { "type": "structure", "members": { "AccountId": { "shape": "AccountId", "documentation": "

The AWS account ID for the owner of the application.

" }, "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group used for the application.

" }, "LifeCycle": { "shape": "LifeCycle", "documentation": "

The lifecycle of the application.

" }, "OpsItemSNSTopicArn": { "shape": "OpsItemSNSTopicArn", "documentation": "

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

" }, "OpsCenterEnabled": { "shape": "OpsCenterEnabled", "documentation": "

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

" }, "CWEMonitorEnabled": { "shape": "CWEMonitorEnabled", "documentation": "

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

" }, "Remarks": { "shape": "Remarks", "documentation": "

The issues on the user side that block Application Insights from successfully monitoring an application. Example remarks include:

" }, "AutoConfigEnabled": { "shape": "AutoConfigEnabled", "documentation": "

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

" }, "DiscoveryType": { "shape": "DiscoveryType", "documentation": "

The method used by Application Insights to onboard your resources.

" }, "AttachMissingPermission": { "shape": "AttachMissingPermission", "documentation": "

If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing.

" } }, "documentation": "

Describes the status of the application.

" }, "ApplicationInfoList": { "type": "list", "member": { "shape": "ApplicationInfo" } }, "AttachMissingPermission": { "type": "boolean" }, "AutoConfigEnabled": { "type": "boolean" }, "AutoCreate": { "type": "boolean" }, "CWEMonitorEnabled": { "type": "boolean" }, "CloudWatchEventDetailType": { "type": "string" }, "CloudWatchEventId": { "type": "string" }, "CloudWatchEventSource": { "type": "string", "enum": [ "EC2", "CODE_DEPLOY", "HEALTH", "RDS" ] }, "CodeDeployApplication": { "type": "string" }, "CodeDeployDeploymentGroup": { "type": "string" }, "CodeDeployDeploymentId": { "type": "string" }, "CodeDeployInstanceGroupId": { "type": "string" }, "CodeDeployState": { "type": "string" }, "ComponentConfiguration": { "type": "string", "max": 10000, "min": 1, "pattern": "[\\S\\s]+" }, "ComponentName": { "type": "string", "max": 1011, "min": 1, "pattern": "(?:^[\\d\\w\\-_\\.+]*$)|(?:^arn:aws(-\\w+)*:[\\w\\d-]+:([\\w\\d-]*)?:[\\w\\d_-]*([:/].+)*$)" }, "ConfigurationEvent": { "type": "structure", "members": { "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group of the application to which the configuration event belongs.

" }, "AccountId": { "shape": "AccountId", "documentation": "

The AWS account ID for the owner of the application to which the configuration event belongs.

" }, "MonitoredResourceARN": { "shape": "ConfigurationEventMonitoredResourceARN", "documentation": "

The resource monitored by Application Insights.

" }, "EventStatus": { "shape": "ConfigurationEventStatus", "documentation": "

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

" }, "EventResourceType": { "shape": "ConfigurationEventResourceType", "documentation": "

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

" }, "EventTime": { "shape": "ConfigurationEventTime", "documentation": "

The timestamp of the event.

" }, "EventDetail": { "shape": "ConfigurationEventDetail", "documentation": "

The details of the event in plain text.

" }, "EventResourceName": { "shape": "ConfigurationEventResourceName", "documentation": "

The name of the resource Application Insights attempted to configure.

" } }, "documentation": "

The event information.

" }, "ConfigurationEventDetail": { "type": "string" }, "ConfigurationEventList": { "type": "list", "member": { "shape": "ConfigurationEvent" } }, "ConfigurationEventMonitoredResourceARN": { "type": "string" }, "ConfigurationEventResourceName": { "type": "string" }, "ConfigurationEventResourceType": { "type": "string", "enum": [ "CLOUDWATCH_ALARM", "CLOUDWATCH_LOG", "CLOUDFORMATION", "SSM_ASSOCIATION" ] }, "ConfigurationEventStatus": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ] }, "ConfigurationEventTime": { "type": "timestamp" }, "CreateApplicationRequest": { "type": "structure", "members": { "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group.

" }, "OpsCenterEnabled": { "shape": "OpsCenterEnabled", "documentation": "

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

" }, "CWEMonitorEnabled": { "shape": "CWEMonitorEnabled", "documentation": "

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

" }, "OpsItemSNSTopicArn": { "shape": "OpsItemSNSTopicArn", "documentation": "

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

" }, "Tags": { "shape": "TagList", "documentation": "

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.

" }, "AutoConfigEnabled": { "shape": "AutoConfigEnabled", "documentation": "

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

" }, "AutoCreate": { "shape": "AutoCreate", "documentation": "

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

" }, "GroupingType": { "shape": "GroupingType", "documentation": "

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.

" }, "AttachMissingPermission": { "shape": "AttachMissingPermission", "documentation": "

If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing.

" } } }, "CreateApplicationResponse": { "type": "structure", "members": { "ApplicationInfo": { "shape": "ApplicationInfo", "documentation": "

Information about the application.

" } } }, "CreateComponentRequest": { "type": "structure", "required": [ "ResourceGroupName", "ComponentName", "ResourceList" ], "members": { "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group.

" }, "ComponentName": { "shape": "CustomComponentName", "documentation": "

The name of the component.

" }, "ResourceList": { "shape": "ResourceList", "documentation": "

The list of resource ARNs that belong to the component.

" } } }, "CreateComponentResponse": { "type": "structure", "members": {} }, "CreateLogPatternRequest": { "type": "structure", "required": [ "ResourceGroupName", "PatternSetName", "PatternName", "Pattern", "Rank" ], "members": { "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group.

" }, "PatternSetName": { "shape": "LogPatternSetName", "documentation": "

The name of the log pattern set.

" }, "PatternName": { "shape": "LogPatternName", "documentation": "

The name of the log pattern.

" }, "Pattern": { "shape": "LogPatternRegex", "documentation": "

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

" }, "Rank": { "shape": "LogPatternRank", "documentation": "

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.

" } } }, "CreateLogPatternResponse": { "type": "structure", "members": { "LogPattern": { "shape": "LogPattern", "documentation": "

The successfully created log pattern.

" }, "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group.

" } } }, "CustomComponentName": { "type": "string", "max": 128, "min": 1, "pattern": "^[\\d\\w\\-_\\.+]*$" }, "DeleteApplicationRequest": { "type": "structure", "required": [ "ResourceGroupName" ], "members": { "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group.

" } } }, "DeleteApplicationResponse": { "type": "structure", "members": {} }, "DeleteComponentRequest": { "type": "structure", "required": [ "ResourceGroupName", "ComponentName" ], "members": { "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group.

" }, "ComponentName": { "shape": "CustomComponentName", "documentation": "

The name of the component.

" } } }, "DeleteComponentResponse": { "type": "structure", "members": {} }, "DeleteLogPatternRequest": { "type": "structure", "required": [ "ResourceGroupName", "PatternSetName", "PatternName" ], "members": { "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group.

" }, "PatternSetName": { "shape": "LogPatternSetName", "documentation": "

The name of the log pattern set.

" }, "PatternName": { "shape": "LogPatternName", "documentation": "

The name of the log pattern.

" } } }, "DeleteLogPatternResponse": { "type": "structure", "members": {} }, "DescribeApplicationRequest": { "type": "structure", "required": [ "ResourceGroupName" ], "members": { "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group.

" }, "AccountId": { "shape": "AccountId", "documentation": "

The AWS account ID for the resource group owner.

" } } }, "DescribeApplicationResponse": { "type": "structure", "members": { "ApplicationInfo": { "shape": "ApplicationInfo", "documentation": "

Information about the application.

" } } }, "DescribeComponentConfigurationRecommendationRequest": { "type": "structure", "required": [ "ResourceGroupName", "ComponentName", "Tier" ], "members": { "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group.

" }, "ComponentName": { "shape": "ComponentName", "documentation": "

The name of the component.

" }, "Tier": { "shape": "Tier", "documentation": "

The tier of the application component.

" }, "WorkloadName": { "shape": "WorkloadName", "documentation": "

The name of the workload.

" }, "RecommendationType": { "shape": "RecommendationType", "documentation": "

The recommended configuration type.

" } } }, "DescribeComponentConfigurationRecommendationResponse": { "type": "structure", "members": { "ComponentConfiguration": { "shape": "ComponentConfiguration", "documentation": "

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

" } } }, "DescribeComponentConfigurationRequest": { "type": "structure", "required": [ "ResourceGroupName", "ComponentName" ], "members": { "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group.

" }, "ComponentName": { "shape": "ComponentName", "documentation": "

The name of the component.

" }, "AccountId": { "shape": "AccountId", "documentation": "

The AWS account ID for the resource group owner.

" } } }, "DescribeComponentConfigurationResponse": { "type": "structure", "members": { "Monitor": { "shape": "Monitor", "documentation": "

Indicates whether the application component is monitored.

" }, "Tier": { "shape": "Tier", "documentation": "

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

" }, "ComponentConfiguration": { "shape": "ComponentConfiguration", "documentation": "

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

" } } }, "DescribeComponentRequest": { "type": "structure", "required": [ "ResourceGroupName", "ComponentName" ], "members": { "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group.

" }, "ComponentName": { "shape": "ComponentName", "documentation": "

The name of the component.

" }, "AccountId": { "shape": "AccountId", "documentation": "

The AWS account ID for the resource group owner.

" } } }, "DescribeComponentResponse": { "type": "structure", "members": { "ApplicationComponent": { "shape": "ApplicationComponent" }, "ResourceList": { "shape": "ResourceList", "documentation": "

The list of resource ARNs that belong to the component.

" } } }, "DescribeLogPatternRequest": { "type": "structure", "required": [ "ResourceGroupName", "PatternSetName", "PatternName" ], "members": { "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group.

" }, "PatternSetName": { "shape": "LogPatternSetName", "documentation": "

The name of the log pattern set.

" }, "PatternName": { "shape": "LogPatternName", "documentation": "

The name of the log pattern.

" }, "AccountId": { "shape": "AccountId", "documentation": "

The AWS account ID for the resource group owner.

" } } }, "DescribeLogPatternResponse": { "type": "structure", "members": { "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group.

" }, "AccountId": { "shape": "AccountId", "documentation": "

The AWS account ID for the resource group owner.

" }, "LogPattern": { "shape": "LogPattern", "documentation": "

The successfully created log pattern.

" } } }, "DescribeObservationRequest": { "type": "structure", "required": [ "ObservationId" ], "members": { "ObservationId": { "shape": "ObservationId", "documentation": "

The ID of the observation.

" }, "AccountId": { "shape": "AccountId", "documentation": "

The AWS account ID for the resource group owner.

" } } }, "DescribeObservationResponse": { "type": "structure", "members": { "Observation": { "shape": "Observation", "documentation": "

Information about the observation.

" } } }, "DescribeProblemObservationsRequest": { "type": "structure", "required": [ "ProblemId" ], "members": { "ProblemId": { "shape": "ProblemId", "documentation": "

The ID of the problem.

" }, "AccountId": { "shape": "AccountId", "documentation": "

The AWS account ID for the resource group owner.

" } } }, "DescribeProblemObservationsResponse": { "type": "structure", "members": { "RelatedObservations": { "shape": "RelatedObservations", "documentation": "

Observations related to the problem.

" } } }, "DescribeProblemRequest": { "type": "structure", "required": [ "ProblemId" ], "members": { "ProblemId": { "shape": "ProblemId", "documentation": "

The ID of the problem.

" }, "AccountId": { "shape": "AccountId", "documentation": "

The AWS account ID for the owner of the resource group affected by the problem.

" } } }, "DescribeProblemResponse": { "type": "structure", "members": { "Problem": { "shape": "Problem", "documentation": "

Information about the problem.

" } } }, "DescribeWorkloadRequest": { "type": "structure", "required": [ "ResourceGroupName", "ComponentName", "WorkloadId" ], "members": { "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group.

" }, "ComponentName": { "shape": "ComponentName", "documentation": "

The name of the component.

" }, "WorkloadId": { "shape": "WorkloadId", "documentation": "

The ID of the workload.

" }, "AccountId": { "shape": "AccountId", "documentation": "

The AWS account ID for the workload owner.

" } } }, "DescribeWorkloadResponse": { "type": "structure", "members": { "WorkloadId": { "shape": "WorkloadId", "documentation": "

The ID of the workload.

" }, "WorkloadRemarks": { "shape": "Remarks", "documentation": "

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

" }, "WorkloadConfiguration": { "shape": "WorkloadConfiguration", "documentation": "

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

" } } }, "DetectedWorkload": { "type": "map", "key": { "shape": "Tier" }, "value": { "shape": "WorkloadMetaData" } }, "DiscoveryType": { "type": "string", "enum": [ "RESOURCE_GROUP_BASED", "ACCOUNT_BASED" ] }, "EbsCause": { "type": "string" }, "EbsEvent": { "type": "string" }, "EbsRequestId": { "type": "string" }, "EbsResult": { "type": "string" }, "Ec2State": { "type": "string" }, "EndTime": { "type": "timestamp" }, "Feedback": { "type": "map", "key": { "shape": "FeedbackKey" }, "value": { "shape": "FeedbackValue" }, "max": 10 }, "FeedbackKey": { "type": "string", "enum": [ "INSIGHTS_FEEDBACK" ] }, "FeedbackValue": { "type": "string", "enum": [ "NOT_SPECIFIED", "USEFUL", "NOT_USEFUL" ] }, "GroupingType": { "type": "string", "enum": [ "ACCOUNT_BASED" ] }, "HealthEventArn": { "type": "string" }, "HealthEventDescription": { "type": "string" }, "HealthEventTypeCategory": { "type": "string" }, "HealthEventTypeCode": { "type": "string" }, "HealthService": { "type": "string" }, "Insights": { "type": "string" }, "LastRecurrenceTime": { "type": "timestamp" }, "LifeCycle": { "type": "string" }, "LineTime": { "type": "timestamp" }, "ListApplicationsRequest": { "type": "structure", "members": { "MaxResults": { "shape": "MaxEntities", "documentation": "

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

" }, "NextToken": { "shape": "PaginationToken", "documentation": "

The token to request the next page of results.

" }, "AccountId": { "shape": "AccountId", "documentation": "

The AWS account ID for the resource group owner.

" } } }, "ListApplicationsResponse": { "type": "structure", "members": { "ApplicationInfoList": { "shape": "ApplicationInfoList", "documentation": "

The list of applications.

" }, "NextToken": { "shape": "PaginationToken", "documentation": "

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

" } } }, "ListComponentsRequest": { "type": "structure", "required": [ "ResourceGroupName" ], "members": { "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group.

" }, "MaxResults": { "shape": "MaxEntities", "documentation": "

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

" }, "NextToken": { "shape": "PaginationToken", "documentation": "

The token to request the next page of results.

" }, "AccountId": { "shape": "AccountId", "documentation": "

The AWS account ID for the resource group owner.

" } } }, "ListComponentsResponse": { "type": "structure", "members": { "ApplicationComponentList": { "shape": "ApplicationComponentList", "documentation": "

The list of application components.

" }, "NextToken": { "shape": "PaginationToken", "documentation": "

The token to request the next page of results.

" } } }, "ListConfigurationHistoryRequest": { "type": "structure", "members": { "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

Resource group to which the application belongs.

" }, "StartTime": { "shape": "StartTime", "documentation": "

The start time of the event.

" }, "EndTime": { "shape": "EndTime", "documentation": "

The end time of the event.

" }, "EventStatus": { "shape": "ConfigurationEventStatus", "documentation": "

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

" }, "MaxResults": { "shape": "MaxEntities", "documentation": "

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.

" }, "NextToken": { "shape": "PaginationToken", "documentation": "

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.

" }, "AccountId": { "shape": "AccountId", "documentation": "

The AWS account ID for the resource group owner.

" } } }, "ListConfigurationHistoryResponse": { "type": "structure", "members": { "EventList": { "shape": "ConfigurationEventList", "documentation": "

The list of configuration events and their corresponding details.

" }, "NextToken": { "shape": "PaginationToken", "documentation": "

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.

" } } }, "ListLogPatternSetsRequest": { "type": "structure", "required": [ "ResourceGroupName" ], "members": { "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group.

" }, "MaxResults": { "shape": "MaxEntities", "documentation": "

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

" }, "NextToken": { "shape": "PaginationToken", "documentation": "

The token to request the next page of results.

" }, "AccountId": { "shape": "AccountId", "documentation": "

The AWS account ID for the resource group owner.

" } } }, "ListLogPatternSetsResponse": { "type": "structure", "members": { "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group.

" }, "AccountId": { "shape": "AccountId", "documentation": "

The AWS account ID for the resource group owner.

" }, "LogPatternSets": { "shape": "LogPatternSetList", "documentation": "

The list of log pattern sets.

" }, "NextToken": { "shape": "PaginationToken", "documentation": "

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

" } } }, "ListLogPatternsRequest": { "type": "structure", "required": [ "ResourceGroupName" ], "members": { "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group.

" }, "PatternSetName": { "shape": "LogPatternSetName", "documentation": "

The name of the log pattern set.

" }, "MaxResults": { "shape": "MaxEntities", "documentation": "

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

" }, "NextToken": { "shape": "PaginationToken", "documentation": "

The token to request the next page of results.

" }, "AccountId": { "shape": "AccountId", "documentation": "

The AWS account ID for the resource group owner.

" } } }, "ListLogPatternsResponse": { "type": "structure", "members": { "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group.

" }, "AccountId": { "shape": "AccountId", "documentation": "

The AWS account ID for the resource group owner.

" }, "LogPatterns": { "shape": "LogPatternList", "documentation": "

The list of log patterns.

" }, "NextToken": { "shape": "PaginationToken", "documentation": "

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

" } } }, "ListProblemsRequest": { "type": "structure", "members": { "AccountId": { "shape": "AccountId", "documentation": "

The AWS account ID for the resource group owner.

" }, "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group.

" }, "StartTime": { "shape": "StartTime", "documentation": "

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.

" }, "EndTime": { "shape": "EndTime", "documentation": "

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

" }, "MaxResults": { "shape": "MaxEntities", "documentation": "

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

" }, "NextToken": { "shape": "PaginationToken", "documentation": "

The token to request the next page of results.

" }, "ComponentName": { "shape": "ComponentName", "documentation": "

The name of the component.

" }, "Visibility": { "shape": "Visibility", "documentation": "

Specifies whether or not you can view the problem. If not specified, visible and ignored problems are returned.

" } } }, "ListProblemsResponse": { "type": "structure", "members": { "ProblemList": { "shape": "ProblemList", "documentation": "

The list of problems.

" }, "NextToken": { "shape": "PaginationToken", "documentation": "

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

" }, "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group.

" }, "AccountId": { "shape": "AccountId", "documentation": "

The AWS account ID for the resource group owner.

" } } }, "ListTagsForResourceRequest": { "type": "structure", "required": [ "ResourceARN" ], "members": { "ResourceARN": { "shape": "AmazonResourceName", "documentation": "

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

" } } }, "ListTagsForResourceResponse": { "type": "structure", "members": { "Tags": { "shape": "TagList", "documentation": "

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

" } } }, "ListWorkloadsRequest": { "type": "structure", "required": [ "ResourceGroupName", "ComponentName" ], "members": { "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group.

" }, "ComponentName": { "shape": "ComponentName", "documentation": "

The name of the component.

" }, "MaxResults": { "shape": "MaxEntities", "documentation": "

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

" }, "NextToken": { "shape": "PaginationToken", "documentation": "

The token to request the next page of results.

" }, "AccountId": { "shape": "AccountId", "documentation": "

The AWS account ID of the owner of the workload.

" } } }, "ListWorkloadsResponse": { "type": "structure", "members": { "WorkloadList": { "shape": "WorkloadList", "documentation": "

The list of workloads.

" }, "NextToken": { "shape": "PaginationToken", "documentation": "

The token to request the next page of results.

" } } }, "LogFilter": { "type": "string", "enum": [ "ERROR", "WARN", "INFO" ] }, "LogGroup": { "type": "string" }, "LogPattern": { "type": "structure", "members": { "PatternSetName": { "shape": "LogPatternSetName", "documentation": "

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.

" }, "PatternName": { "shape": "LogPatternName", "documentation": "

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.

" }, "Pattern": { "shape": "LogPatternRegex", "documentation": "

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.

" }, "Rank": { "shape": "LogPatternRank", "documentation": "

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.

" } }, "documentation": "

An object that defines the log patterns that belongs to a LogPatternSet.

" }, "LogPatternList": { "type": "list", "member": { "shape": "LogPattern" } }, "LogPatternName": { "type": "string", "max": 50, "min": 1, "pattern": "[a-zA-Z0-9\\.\\-_]*" }, "LogPatternRank": { "type": "integer" }, "LogPatternRegex": { "type": "string", "max": 50, "min": 1, "pattern": "[\\S\\s]+" }, "LogPatternSetList": { "type": "list", "member": { "shape": "LogPatternSetName" } }, "LogPatternSetName": { "type": "string", "max": 30, "min": 1, "pattern": "[a-zA-Z0-9\\.\\-_]*" }, "LogText": { "type": "string" }, "MaxEntities": { "type": "integer", "max": 40, "min": 1 }, "MetaDataKey": { "type": "string" }, "MetaDataValue": { "type": "string" }, "MetricName": { "type": "string" }, "MetricNamespace": { "type": "string" }, "Monitor": { "type": "boolean" }, "Observation": { "type": "structure", "members": { "Id": { "shape": "ObservationId", "documentation": "

The ID of the observation type.

" }, "StartTime": { "shape": "StartTime", "documentation": "

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

" }, "EndTime": { "shape": "EndTime", "documentation": "

The time when the observation ended, in epoch seconds.

" }, "SourceType": { "shape": "SourceType", "documentation": "

The source type of the observation.

" }, "SourceARN": { "shape": "SourceARN", "documentation": "

The source resource ARN of the observation.

" }, "LogGroup": { "shape": "LogGroup", "documentation": "

The log group name.

" }, "LineTime": { "shape": "LineTime", "documentation": "

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

" }, "LogText": { "shape": "LogText", "documentation": "

The log text of the observation.

" }, "LogFilter": { "shape": "LogFilter", "documentation": "

The log filter of the observation.

" }, "MetricNamespace": { "shape": "MetricNamespace", "documentation": "

The namespace of the observation metric.

" }, "MetricName": { "shape": "MetricName", "documentation": "

The name of the observation metric.

" }, "Unit": { "shape": "Unit", "documentation": "

The unit of the source observation metric.

" }, "Value": { "shape": "Value", "documentation": "

The value of the source observation metric.

" }, "CloudWatchEventId": { "shape": "CloudWatchEventId", "documentation": "

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

" }, "CloudWatchEventSource": { "shape": "CloudWatchEventSource", "documentation": "

The source of the CloudWatch Event.

" }, "CloudWatchEventDetailType": { "shape": "CloudWatchEventDetailType", "documentation": "

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

" }, "HealthEventArn": { "shape": "HealthEventArn", "documentation": "

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

" }, "HealthService": { "shape": "HealthService", "documentation": "

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

" }, "HealthEventTypeCode": { "shape": "HealthEventTypeCode", "documentation": "

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

" }, "HealthEventTypeCategory": { "shape": "HealthEventTypeCategory", "documentation": "

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

" }, "HealthEventDescription": { "shape": "HealthEventDescription", "documentation": "

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

" }, "CodeDeployDeploymentId": { "shape": "CodeDeployDeploymentId", "documentation": "

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

" }, "CodeDeployDeploymentGroup": { "shape": "CodeDeployDeploymentGroup", "documentation": "

The deployment group to which the CodeDeploy deployment belongs.

" }, "CodeDeployState": { "shape": "CodeDeployState", "documentation": "

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

" }, "CodeDeployApplication": { "shape": "CodeDeployApplication", "documentation": "

The CodeDeploy application to which the deployment belongs.

" }, "CodeDeployInstanceGroupId": { "shape": "CodeDeployInstanceGroupId", "documentation": "

The instance group to which the CodeDeploy instance belongs.

" }, "Ec2State": { "shape": "Ec2State", "documentation": "

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

" }, "RdsEventCategories": { "shape": "RdsEventCategories", "documentation": "

The category of an RDS event.

" }, "RdsEventMessage": { "shape": "RdsEventMessage", "documentation": "

The message of an RDS event.

" }, "S3EventName": { "shape": "S3EventName", "documentation": "

The name of the S3 CloudWatch Event-based observation.

" }, "StatesExecutionArn": { "shape": "StatesExecutionArn", "documentation": "

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

" }, "StatesArn": { "shape": "StatesArn", "documentation": "

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

" }, "StatesStatus": { "shape": "StatesStatus", "documentation": "

The status of the step function-related observation.

" }, "StatesInput": { "shape": "StatesInput", "documentation": "

The input to the step function-based observation.

" }, "EbsEvent": { "shape": "EbsEvent", "documentation": "

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

" }, "EbsResult": { "shape": "EbsResult", "documentation": "

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

" }, "EbsCause": { "shape": "EbsCause", "documentation": "

The cause of an EBS CloudWatch event.

" }, "EbsRequestId": { "shape": "EbsRequestId", "documentation": "

The request ID of an EBS CloudWatch event.

" }, "XRayFaultPercent": { "shape": "XRayFaultPercent", "documentation": "

The X-Ray request fault percentage for this node.

" }, "XRayThrottlePercent": { "shape": "XRayThrottlePercent", "documentation": "

The X-Ray request throttle percentage for this node.

" }, "XRayErrorPercent": { "shape": "XRayErrorPercent", "documentation": "

The X-Ray request error percentage for this node.

" }, "XRayRequestCount": { "shape": "XRayRequestCount", "documentation": "

The X-Ray request count for this node.

" }, "XRayRequestAverageLatency": { "shape": "XRayRequestAverageLatency", "documentation": "

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

" }, "XRayNodeName": { "shape": "XRayNodeName", "documentation": "

The name of the X-Ray node.

" }, "XRayNodeType": { "shape": "XRayNodeType", "documentation": "

The type of the X-Ray node.

" } }, "documentation": "

Describes an anomaly or error with the application.

" }, "ObservationId": { "type": "string", "max": 38, "min": 38, "pattern": "o-[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}" }, "ObservationList": { "type": "list", "member": { "shape": "Observation" } }, "OpsCenterEnabled": { "type": "boolean" }, "OpsItemSNSTopicArn": { "type": "string", "max": 300, "min": 20, "pattern": "^arn:aws(-\\w+)*:[\\w\\d-]+:([\\w\\d-]*)?:[\\w\\d_-]*([:/].+)*$" }, "OsType": { "type": "string", "enum": [ "WINDOWS", "LINUX" ] }, "PaginationToken": { "type": "string", "max": 1024, "min": 1, "pattern": ".+" }, "Problem": { "type": "structure", "members": { "Id": { "shape": "ProblemId", "documentation": "

The ID of the problem.

" }, "Title": { "shape": "Title", "documentation": "

The name of the problem.

" }, "Insights": { "shape": "Insights", "documentation": "

A detailed analysis of the problem using machine learning.

" }, "Status": { "shape": "Status", "documentation": "

The status of the problem.

" }, "AffectedResource": { "shape": "AffectedResource", "documentation": "

The resource affected by the problem.

" }, "StartTime": { "shape": "StartTime", "documentation": "

The time when the problem started, in epoch seconds.

" }, "EndTime": { "shape": "EndTime", "documentation": "

The time when the problem ended, in epoch seconds.

" }, "SeverityLevel": { "shape": "SeverityLevel", "documentation": "

A measure of the level of impact of the problem.

" }, "AccountId": { "shape": "AccountId", "documentation": "

The AWS account ID for the owner of the resource group affected by the problem.

" }, "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group affected by the problem.

" }, "Feedback": { "shape": "Feedback", "documentation": "

Feedback provided by the user about the problem.

" }, "RecurringCount": { "shape": "RecurringCount", "documentation": "

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

" }, "LastRecurrenceTime": { "shape": "LastRecurrenceTime", "documentation": "

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

" }, "Visibility": { "shape": "Visibility", "documentation": "

Specifies whether or not you can view the problem. Updates to ignored problems do not generate notifications.

" }, "ResolutionMethod": { "shape": "ResolutionMethod", "documentation": "

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.

" } }, "documentation": "

Describes a problem that is detected by correlating observations.

" }, "ProblemId": { "type": "string", "max": 38, "min": 38, "pattern": "p-[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}" }, "ProblemList": { "type": "list", "member": { "shape": "Problem" } }, "RdsEventCategories": { "type": "string" }, "RdsEventMessage": { "type": "string" }, "RecommendationType": { "type": "string", "enum": [ "INFRA_ONLY", "WORKLOAD_ONLY", "ALL" ] }, "RecurringCount": { "type": "long" }, "RelatedObservations": { "type": "structure", "members": { "ObservationList": { "shape": "ObservationList", "documentation": "

The list of observations related to the problem.

" } }, "documentation": "

Describes observations related to the problem.

" }, "Remarks": { "type": "string" }, "RemoveSNSTopic": { "type": "boolean" }, "RemoveWorkloadRequest": { "type": "structure", "required": [ "ResourceGroupName", "ComponentName", "WorkloadId" ], "members": { "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group.

" }, "ComponentName": { "shape": "ComponentName", "documentation": "

The name of the component.

" }, "WorkloadId": { "shape": "WorkloadId", "documentation": "

The ID of the workload.

" } } }, "RemoveWorkloadResponse": { "type": "structure", "members": {} }, "ResolutionMethod": { "type": "string", "enum": [ "MANUAL", "AUTOMATIC", "UNRESOLVED" ] }, "ResourceARN": { "type": "string", "max": 1011, "min": 1, "pattern": "^arn:aws(-\\w+)*:[\\w\\d-]+:([\\w\\d-]*)?:[\\w\\d_-]*([:/].+)*$" }, "ResourceGroupName": { "type": "string", "max": 256, "min": 1, "pattern": "[a-zA-Z0-9\\.\\-_]*" }, "ResourceList": { "type": "list", "member": { "shape": "ResourceARN" } }, "ResourceType": { "type": "string", "max": 50, "min": 1, "pattern": "[0-9a-zA-Z:_]*" }, "S3EventName": { "type": "string" }, "SeverityLevel": { "type": "string", "enum": [ "Informative", "Low", "Medium", "High" ] }, "SourceARN": { "type": "string" }, "SourceType": { "type": "string" }, "StartTime": { "type": "timestamp" }, "StatesArn": { "type": "string" }, "StatesExecutionArn": { "type": "string" }, "StatesInput": { "type": "string" }, "StatesStatus": { "type": "string" }, "Status": { "type": "string", "enum": [ "IGNORE", "RESOLVED", "PENDING", "RECURRING", "RECOVERING" ] }, "Tag": { "type": "structure", "required": [ "Key", "Value" ], "members": { "Key": { "shape": "TagKey", "documentation": "

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.

" }, "Value": { "shape": "TagValue", "documentation": "

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.

" } }, "documentation": "

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:

" }, "TagKey": { "type": "string", "max": 128, "min": 1, "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "TagKeyList": { "type": "list", "member": { "shape": "TagKey" }, "max": 200, "min": 0 }, "TagList": { "type": "list", "member": { "shape": "Tag" }, "max": 200, "min": 0 }, "TagResourceRequest": { "type": "structure", "required": [ "ResourceARN", "Tags" ], "members": { "ResourceARN": { "shape": "AmazonResourceName", "documentation": "

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

" }, "Tags": { "shape": "TagList", "documentation": "

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.

" } } }, "TagResourceResponse": { "type": "structure", "members": {} }, "TagValue": { "type": "string", "max": 256, "min": 0, "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "Tier": { "type": "string", "enum": [ "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", "SAP_HANA_MULTI_NODE", "SAP_HANA_SINGLE_NODE", "SAP_HANA_HIGH_AVAILABILITY", "SQL_SERVER_FAILOVER_CLUSTER_INSTANCE", "SHAREPOINT", "ACTIVE_DIRECTORY", "SAP_NETWEAVER_STANDARD", "SAP_NETWEAVER_DISTRIBUTED", "SAP_NETWEAVER_HIGH_AVAILABILITY" ], "max": 50, "min": 1 }, "Title": { "type": "string" }, "Unit": { "type": "string" }, "UntagResourceRequest": { "type": "structure", "required": [ "ResourceARN", "TagKeys" ], "members": { "ResourceARN": { "shape": "AmazonResourceName", "documentation": "

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

" }, "TagKeys": { "shape": "TagKeyList", "documentation": "

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.

" } } }, "UntagResourceResponse": { "type": "structure", "members": {} }, "UpdateApplicationRequest": { "type": "structure", "required": [ "ResourceGroupName" ], "members": { "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group.

" }, "OpsCenterEnabled": { "shape": "OpsCenterEnabled", "documentation": "

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

" }, "CWEMonitorEnabled": { "shape": "CWEMonitorEnabled", "documentation": "

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

" }, "OpsItemSNSTopicArn": { "shape": "OpsItemSNSTopicArn", "documentation": "

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

" }, "RemoveSNSTopic": { "shape": "RemoveSNSTopic", "documentation": "

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

" }, "AutoConfigEnabled": { "shape": "AutoConfigEnabled", "documentation": "

Turns auto-configuration on or off.

" }, "AttachMissingPermission": { "shape": "AttachMissingPermission", "documentation": "

If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing.

" } } }, "UpdateApplicationResponse": { "type": "structure", "members": { "ApplicationInfo": { "shape": "ApplicationInfo", "documentation": "

Information about the application.

" } } }, "UpdateComponentConfigurationRequest": { "type": "structure", "required": [ "ResourceGroupName", "ComponentName" ], "members": { "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group.

" }, "ComponentName": { "shape": "ComponentName", "documentation": "

The name of the component.

" }, "Monitor": { "shape": "Monitor", "documentation": "

Indicates whether the application component is monitored.

" }, "Tier": { "shape": "Tier", "documentation": "

The tier of the application component.

" }, "ComponentConfiguration": { "shape": "ComponentConfiguration", "documentation": "

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.

" }, "AutoConfigEnabled": { "shape": "AutoConfigEnabled", "documentation": "

Automatically configures the component by applying the recommended configurations.

" } } }, "UpdateComponentConfigurationResponse": { "type": "structure", "members": {} }, "UpdateComponentRequest": { "type": "structure", "required": [ "ResourceGroupName", "ComponentName" ], "members": { "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group.

" }, "ComponentName": { "shape": "CustomComponentName", "documentation": "

The name of the component.

" }, "NewComponentName": { "shape": "CustomComponentName", "documentation": "

The new name of the component.

" }, "ResourceList": { "shape": "ResourceList", "documentation": "

The list of resource ARNs that belong to the component.

" } } }, "UpdateComponentResponse": { "type": "structure", "members": {} }, "UpdateLogPatternRequest": { "type": "structure", "required": [ "ResourceGroupName", "PatternSetName", "PatternName" ], "members": { "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group.

" }, "PatternSetName": { "shape": "LogPatternSetName", "documentation": "

The name of the log pattern set.

" }, "PatternName": { "shape": "LogPatternName", "documentation": "

The name of the log pattern.

" }, "Pattern": { "shape": "LogPatternRegex", "documentation": "

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

" }, "Rank": { "shape": "LogPatternRank", "documentation": "

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.

" } } }, "UpdateLogPatternResponse": { "type": "structure", "members": { "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group.

" }, "LogPattern": { "shape": "LogPattern", "documentation": "

The successfully created log pattern.

" } } }, "UpdateProblemRequest": { "type": "structure", "required": [ "ProblemId" ], "members": { "ProblemId": { "shape": "ProblemId", "documentation": "

The ID of the problem.

" }, "UpdateStatus": { "shape": "UpdateStatus", "documentation": "

The status of the problem. Arguments can be passed for only problems that show a status of RECOVERING.

" }, "Visibility": { "shape": "Visibility", "documentation": "

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.

" } } }, "UpdateProblemResponse": { "type": "structure", "members": {} }, "UpdateStatus": { "type": "string", "enum": [ "RESOLVED" ] }, "UpdateWorkloadRequest": { "type": "structure", "required": [ "ResourceGroupName", "ComponentName", "WorkloadConfiguration" ], "members": { "ResourceGroupName": { "shape": "ResourceGroupName", "documentation": "

The name of the resource group.

" }, "ComponentName": { "shape": "ComponentName", "documentation": "

The name of the component.

" }, "WorkloadId": { "shape": "WorkloadId", "documentation": "

The ID of the workload.

" }, "WorkloadConfiguration": { "shape": "WorkloadConfiguration", "documentation": "

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

" } } }, "UpdateWorkloadResponse": { "type": "structure", "members": { "WorkloadId": { "shape": "WorkloadId", "documentation": "

The ID of the workload.

" }, "WorkloadConfiguration": { "shape": "WorkloadConfiguration", "documentation": "

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

" } } }, "Value": { "type": "double" }, "Visibility": { "type": "string", "enum": [ "IGNORED", "VISIBLE" ] }, "Workload": { "type": "structure", "members": { "WorkloadId": { "shape": "WorkloadId", "documentation": "

The ID of the workload.

" }, "ComponentName": { "shape": "ComponentName", "documentation": "

The name of the component.

" }, "WorkloadName": { "shape": "WorkloadName", "documentation": "

The name of the workload.

" }, "Tier": { "shape": "Tier", "documentation": "

The tier of the workload.

" }, "WorkloadRemarks": { "shape": "Remarks", "documentation": "

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

" } }, "documentation": "

Describes the workloads on a component.

" }, "WorkloadConfiguration": { "type": "structure", "members": { "WorkloadName": { "shape": "WorkloadName", "documentation": "

The name of the workload.

" }, "Tier": { "shape": "Tier", "documentation": "

The configuration of the workload tier.

" }, "Configuration": { "shape": "ComponentConfiguration", "documentation": "

The configuration settings of the workload.

" } }, "documentation": "

The configuration of the workload.

" }, "WorkloadId": { "type": "string", "max": 38, "min": 38, "pattern": "w-[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}" }, "WorkloadList": { "type": "list", "member": { "shape": "Workload" } }, "WorkloadMetaData": { "type": "map", "key": { "shape": "MetaDataKey" }, "value": { "shape": "MetaDataValue" } }, "WorkloadName": { "type": "string", "max": 8, "min": 1, "pattern": "[a-zA-Z0-9\\.\\-_]*" }, "XRayErrorPercent": { "type": "integer" }, "XRayFaultPercent": { "type": "integer" }, "XRayNodeName": { "type": "string" }, "XRayNodeType": { "type": "string" }, "XRayRequestAverageLatency": { "type": "long" }, "XRayRequestCount": { "type": "integer" }, "XRayThrottlePercent": { "type": "integer" } }, "documentation": "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.

" }