Amazon CloudWatch Application Insights 2018-11-25
- Client: Aws\ApplicationInsights\ApplicationInsightsClient
- Service ID: application-insights
- Version: 2018-11-25
This page describes the parameters and results for the operations of the Amazon CloudWatch Application Insights (2018-11-25), and shows how to use the Aws\ApplicationInsights\ApplicationInsightsClient object to call the described operations. This documentation is specific to the 2018-11-25 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- CreateApplication ( array $params = [] )
Adds an application that is created from a resource group.
- CreateComponent ( array $params = [] )
Creates a custom component by grouping similar standalone instances to monitor.
- CreateLogPattern ( array $params = [] )
Adds an log pattern to a LogPatternSet.
- DeleteApplication ( array $params = [] )
Removes the specified application from monitoring.
- DeleteComponent ( array $params = [] )
Ungroups a custom component.
- DeleteLogPattern ( array $params = [] )
Removes the specified log pattern from a LogPatternSet.
- DescribeApplication ( array $params = [] )
Describes the application.
- DescribeComponent ( array $params = [] )
Describes a component and lists the resources that are grouped together in a component.
- DescribeComponentConfiguration ( array $params = [] )
Describes the monitoring configuration of the component.
- DescribeComponentConfigurationRecommendation ( array $params = [] )
Describes the recommended monitoring configuration of the component.
- DescribeLogPattern ( array $params = [] )
Describe a specific log pattern from a LogPatternSet.
- DescribeObservation ( array $params = [] )
Describes an anomaly or error with the application.
- DescribeProblem ( array $params = [] )
Describes an application problem.
- DescribeProblemObservations ( array $params = [] )
Describes the anomalies or errors associated with the problem.
- ListApplications ( array $params = [] )
Lists the IDs of the applications that you are monitoring.
- ListComponents ( array $params = [] )
Lists the auto-grouped, standalone, and custom components of the application.
- ListConfigurationHistory ( array $params = [] )
Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by Application Insights.
- ListLogPatternSets ( array $params = [] )
Lists the log pattern sets in the specific application.
- ListLogPatterns ( array $params = [] )
Lists the log patterns in the specific log LogPatternSet.
- ListProblems ( array $params = [] )
Lists the problems with your application.
- ListTagsForResource ( array $params = [] )
Retrieve a list of the tags (keys and values) that are associated with a specified application.
- TagResource ( array $params = [] )
Add one or more tags (keys and values) to a specified application.
- UntagResource ( array $params = [] )
Remove one or more tags (keys and values) from a specified application.
- UpdateApplication ( array $params = [] )
Updates the application.
- UpdateComponent ( array $params = [] )
Updates the custom component name and/or the list of resources that make up the component.
- UpdateComponentConfiguration ( array $params = [] )
Updates the monitoring configurations for the component.
- UpdateLogPattern ( array $params = [] )
Adds a log pattern to a LogPatternSet.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
CreateApplication
$result = $client->createApplication([/* ... */]); $promise = $client->createApplicationAsync([/* ... */]);
Adds an application that is created from a resource group.
Parameter Syntax
$result = $client->createApplication([
'AutoConfigEnabled' => true || false,
'AutoCreate' => true || false,
'CWEMonitorEnabled' => true || false,
'GroupingType' => 'ACCOUNT_BASED',
'OpsCenterEnabled' => true || false,
'OpsItemSNSTopicArn' => '<string>',
'ResourceGroupName' => '<string>',
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- AutoConfigEnabled
-
- Type: boolean
Indicates whether Application Insights automatically configures unmonitored resources in the resource group.
- AutoCreate
-
- Type: boolean
Configures all of the resources in the resource group by applying the recommended configurations.
- CWEMonitorEnabled
-
- Type: boolean
Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as
instance terminated,failed deployment, and others. - GroupingType
-
- Type: string
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. - OpsCenterEnabled
-
- Type: boolean
When set to
true, creates opsItems for any problems detected on an application. - OpsItemSNSTopicArn
-
- Type: string
The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to receive notifications for updates to the opsItem.
- ResourceGroupName
-
- Type: string
The name of the resource group.
- Tags
-
- Type: Array of Tag structures
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.
Result Syntax
[
'ApplicationInfo' => [
'AutoConfigEnabled' => true || false,
'CWEMonitorEnabled' => true || false,
'DiscoveryType' => 'RESOURCE_GROUP_BASED|ACCOUNT_BASED',
'LifeCycle' => '<string>',
'OpsCenterEnabled' => true || false,
'OpsItemSNSTopicArn' => '<string>',
'Remarks' => '<string>',
'ResourceGroupName' => '<string>',
],
]
Result Details
Members
- ApplicationInfo
-
- Type: ApplicationInfo structure
Information about the application.
Errors
-
The resource is already created or in use.
-
The resource does not exist in the customer account.
-
The parameter is not valid.
-
The server encountered an internal error and is unable to complete the request.
-
Tags are already registered for the specified application ARN.
-
User does not have permissions to perform this action.
CreateComponent
$result = $client->createComponent([/* ... */]); $promise = $client->createComponentAsync([/* ... */]);
Creates a custom component by grouping similar standalone instances to monitor.
Parameter Syntax
$result = $client->createComponent([
'ComponentName' => '<string>', // REQUIRED
'ResourceGroupName' => '<string>', // REQUIRED
'ResourceList' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The resource is already created or in use.
-
The resource does not exist in the customer account.
-
The parameter is not valid.
-
The server encountered an internal error and is unable to complete the request.
CreateLogPattern
$result = $client->createLogPattern([/* ... */]); $promise = $client->createLogPatternAsync([/* ... */]);
Adds an log pattern to a LogPatternSet.
Parameter Syntax
$result = $client->createLogPattern([
'Pattern' => '<string>', // REQUIRED
'PatternName' => '<string>', // REQUIRED
'PatternSetName' => '<string>', // REQUIRED
'Rank' => <integer>, // REQUIRED
'ResourceGroupName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Pattern
-
- Required: Yes
- Type: string
The log pattern. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.
- PatternName
-
- Required: Yes
- Type: string
The name of the log pattern.
- PatternSetName
-
- Required: Yes
- Type: string
The name of the log pattern set.
- Rank
-
- Required: Yes
- Type: int
Rank of the log pattern. Must be a value between
1and1,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 rank1will be the first to get matched to a log line. A pattern of rank1,000,000will be last to get matched. When you configure custom log patterns from the console, aLowseverity pattern translates to a750,000rank. AMediumseverity pattern translates to a500,000rank. And aHighseverity pattern translates to a250,000rank. Rank values less than1or greater than1,000,000are reserved for AWS-provided patterns. - ResourceGroupName
-
- Required: Yes
- Type: string
The name of the resource group.
Result Syntax
[
'LogPattern' => [
'Pattern' => '<string>',
'PatternName' => '<string>',
'PatternSetName' => '<string>',
'Rank' => <integer>,
],
'ResourceGroupName' => '<string>',
]
Result Details
Members
- LogPattern
-
- Type: LogPattern structure
The successfully created log pattern.
- ResourceGroupName
-
- Type: string
The name of the resource group.
Errors
-
The resource is already created or in use.
-
The resource does not exist in the customer account.
-
The parameter is not valid.
-
The server encountered an internal error and is unable to complete the request.
DeleteApplication
$result = $client->deleteApplication([/* ... */]); $promise = $client->deleteApplicationAsync([/* ... */]);
Removes the specified application from monitoring. Does not delete the application.
Parameter Syntax
$result = $client->deleteApplication([
'ResourceGroupName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource does not exist in the customer account.
-
The parameter is not valid.
-
The request is not understood by the server.
-
The server encountered an internal error and is unable to complete the request.
DeleteComponent
$result = $client->deleteComponent([/* ... */]); $promise = $client->deleteComponentAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteComponent([
'ComponentName' => '<string>', // REQUIRED
'ResourceGroupName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The resource does not exist in the customer account.
-
The parameter is not valid.
-
The server encountered an internal error and is unable to complete the request.
DeleteLogPattern
$result = $client->deleteLogPattern([/* ... */]); $promise = $client->deleteLogPatternAsync([/* ... */]);
Removes the specified log pattern from a LogPatternSet.
Parameter Syntax
$result = $client->deleteLogPattern([
'PatternName' => '<string>', // REQUIRED
'PatternSetName' => '<string>', // REQUIRED
'ResourceGroupName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The resource does not exist in the customer account.
-
The parameter is not valid.
-
The request is not understood by the server.
-
The server encountered an internal error and is unable to complete the request.
DescribeApplication
$result = $client->describeApplication([/* ... */]); $promise = $client->describeApplicationAsync([/* ... */]);
Describes the application.
Parameter Syntax
$result = $client->describeApplication([
'ResourceGroupName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'ApplicationInfo' => [
'AutoConfigEnabled' => true || false,
'CWEMonitorEnabled' => true || false,
'DiscoveryType' => 'RESOURCE_GROUP_BASED|ACCOUNT_BASED',
'LifeCycle' => '<string>',
'OpsCenterEnabled' => true || false,
'OpsItemSNSTopicArn' => '<string>',
'Remarks' => '<string>',
'ResourceGroupName' => '<string>',
],
]
Result Details
Members
- ApplicationInfo
-
- Type: ApplicationInfo structure
Information about the application.
Errors
-
The resource does not exist in the customer account.
-
The parameter is not valid.
-
The server encountered an internal error and is unable to complete the request.
DescribeComponent
$result = $client->describeComponent([/* ... */]); $promise = $client->describeComponentAsync([/* ... */]);
Describes a component and lists the resources that are grouped together in a component.
Parameter Syntax
$result = $client->describeComponent([
'ComponentName' => '<string>', // REQUIRED
'ResourceGroupName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ApplicationComponent' => [
'ComponentName' => '<string>',
'ComponentRemarks' => '<string>',
'DetectedWorkload' => [
'<Tier>' => ['<string>', ...],
// ...
],
'Monitor' => true || false,
'OsType' => 'WINDOWS|LINUX',
'ResourceType' => '<string>',
'Tier' => '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',
],
'ResourceList' => ['<string>', ...],
]
Result Details
Members
- ApplicationComponent
-
- Type: ApplicationComponent structure
Describes a standalone resource or similarly grouped resources that the application is made up of.
- ResourceList
-
- Type: Array of strings
The list of resource ARNs that belong to the component.
Errors
-
The resource does not exist in the customer account.
-
The parameter is not valid.
-
The server encountered an internal error and is unable to complete the request.
DescribeComponentConfiguration
$result = $client->describeComponentConfiguration([/* ... */]); $promise = $client->describeComponentConfigurationAsync([/* ... */]);
Describes the monitoring configuration of the component.
Parameter Syntax
$result = $client->describeComponentConfiguration([
'ComponentName' => '<string>', // REQUIRED
'ResourceGroupName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ComponentConfiguration' => '<string>',
'Monitor' => true || false,
'Tier' => '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',
]
Result Details
Members
- ComponentConfiguration
-
- Type: string
The configuration settings of the component. The value is the escaped JSON of the configuration.
- Monitor
-
- Type: boolean
Indicates whether the application component is monitored.
- Tier
-
- Type: string
The tier of the application component. Supported tiers include
DOT_NET_CORE,DOT_NET_WORKER,DOT_NET_WEB,SQL_SERVER, andDEFAULT
Errors
-
The resource does not exist in the customer account.
-
The parameter is not valid.
-
The server encountered an internal error and is unable to complete the request.
DescribeComponentConfigurationRecommendation
$result = $client->describeComponentConfigurationRecommendation([/* ... */]); $promise = $client->describeComponentConfigurationRecommendationAsync([/* ... */]);
Describes the recommended monitoring configuration of the component.
Parameter Syntax
$result = $client->describeComponentConfigurationRecommendation([
'ComponentName' => '<string>', // REQUIRED
'ResourceGroupName' => '<string>', // REQUIRED
'Tier' => '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', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ComponentConfiguration' => '<string>',
]
Result Details
Members
Errors
-
The resource does not exist in the customer account.
-
The parameter is not valid.
-
The server encountered an internal error and is unable to complete the request.
DescribeLogPattern
$result = $client->describeLogPattern([/* ... */]); $promise = $client->describeLogPatternAsync([/* ... */]);
Describe a specific log pattern from a LogPatternSet.
Parameter Syntax
$result = $client->describeLogPattern([
'PatternName' => '<string>', // REQUIRED
'PatternSetName' => '<string>', // REQUIRED
'ResourceGroupName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'LogPattern' => [
'Pattern' => '<string>',
'PatternName' => '<string>',
'PatternSetName' => '<string>',
'Rank' => <integer>,
],
'ResourceGroupName' => '<string>',
]
Result Details
Members
- LogPattern
-
- Type: LogPattern structure
The successfully created log pattern.
- ResourceGroupName
-
- Type: string
The name of the resource group.
Errors
-
The resource does not exist in the customer account.
-
The parameter is not valid.
-
The server encountered an internal error and is unable to complete the request.
DescribeObservation
$result = $client->describeObservation([/* ... */]); $promise = $client->describeObservationAsync([/* ... */]);
Describes an anomaly or error with the application.
Parameter Syntax
$result = $client->describeObservation([
'ObservationId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Observation' => [
'CloudWatchEventDetailType' => '<string>',
'CloudWatchEventId' => '<string>',
'CloudWatchEventSource' => 'EC2|CODE_DEPLOY|HEALTH|RDS',
'CodeDeployApplication' => '<string>',
'CodeDeployDeploymentGroup' => '<string>',
'CodeDeployDeploymentId' => '<string>',
'CodeDeployInstanceGroupId' => '<string>',
'CodeDeployState' => '<string>',
'EbsCause' => '<string>',
'EbsEvent' => '<string>',
'EbsRequestId' => '<string>',
'EbsResult' => '<string>',
'Ec2State' => '<string>',
'EndTime' => <DateTime>,
'HealthEventArn' => '<string>',
'HealthEventDescription' => '<string>',
'HealthEventTypeCategory' => '<string>',
'HealthEventTypeCode' => '<string>',
'HealthService' => '<string>',
'Id' => '<string>',
'LineTime' => <DateTime>,
'LogFilter' => 'ERROR|WARN|INFO',
'LogGroup' => '<string>',
'LogText' => '<string>',
'MetricName' => '<string>',
'MetricNamespace' => '<string>',
'RdsEventCategories' => '<string>',
'RdsEventMessage' => '<string>',
'S3EventName' => '<string>',
'SourceARN' => '<string>',
'SourceType' => '<string>',
'StartTime' => <DateTime>,
'StatesArn' => '<string>',
'StatesExecutionArn' => '<string>',
'StatesInput' => '<string>',
'StatesStatus' => '<string>',
'Unit' => '<string>',
'Value' => <float>,
'XRayErrorPercent' => <integer>,
'XRayFaultPercent' => <integer>,
'XRayNodeName' => '<string>',
'XRayNodeType' => '<string>',
'XRayRequestAverageLatency' => <integer>,
'XRayRequestCount' => <integer>,
'XRayThrottlePercent' => <integer>,
],
]
Result Details
Members
- Observation
-
- Type: Observation structure
Information about the observation.
Errors
-
The server encountered an internal error and is unable to complete the request.
-
The parameter is not valid.
-
The resource does not exist in the customer account.
DescribeProblem
$result = $client->describeProblem([/* ... */]); $promise = $client->describeProblemAsync([/* ... */]);
Describes an application problem.
Parameter Syntax
$result = $client->describeProblem([
'ProblemId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Problem' => [
'AffectedResource' => '<string>',
'EndTime' => <DateTime>,
'Feedback' => ['<string>', ...],
'Id' => '<string>',
'Insights' => '<string>',
'LastRecurrenceTime' => <DateTime>,
'RecurringCount' => <integer>,
'ResourceGroupName' => '<string>',
'SeverityLevel' => 'Informative|Low|Medium|High',
'StartTime' => <DateTime>,
'Status' => 'IGNORE|RESOLVED|PENDING|RECURRING',
'Title' => '<string>',
],
]
Result Details
Members
- Problem
-
- Type: Problem structure
Information about the problem.
Errors
-
The server encountered an internal error and is unable to complete the request.
-
The parameter is not valid.
-
The resource does not exist in the customer account.
DescribeProblemObservations
$result = $client->describeProblemObservations([/* ... */]); $promise = $client->describeProblemObservationsAsync([/* ... */]);
Describes the anomalies or errors associated with the problem.
Parameter Syntax
$result = $client->describeProblemObservations([
'ProblemId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'RelatedObservations' => [
'ObservationList' => [
[
'CloudWatchEventDetailType' => '<string>',
'CloudWatchEventId' => '<string>',
'CloudWatchEventSource' => 'EC2|CODE_DEPLOY|HEALTH|RDS',
'CodeDeployApplication' => '<string>',
'CodeDeployDeploymentGroup' => '<string>',
'CodeDeployDeploymentId' => '<string>',
'CodeDeployInstanceGroupId' => '<string>',
'CodeDeployState' => '<string>',
'EbsCause' => '<string>',
'EbsEvent' => '<string>',
'EbsRequestId' => '<string>',
'EbsResult' => '<string>',
'Ec2State' => '<string>',
'EndTime' => <DateTime>,
'HealthEventArn' => '<string>',
'HealthEventDescription' => '<string>',
'HealthEventTypeCategory' => '<string>',
'HealthEventTypeCode' => '<string>',
'HealthService' => '<string>',
'Id' => '<string>',
'LineTime' => <DateTime>,
'LogFilter' => 'ERROR|WARN|INFO',
'LogGroup' => '<string>',
'LogText' => '<string>',
'MetricName' => '<string>',
'MetricNamespace' => '<string>',
'RdsEventCategories' => '<string>',
'RdsEventMessage' => '<string>',
'S3EventName' => '<string>',
'SourceARN' => '<string>',
'SourceType' => '<string>',
'StartTime' => <DateTime>,
'StatesArn' => '<string>',
'StatesExecutionArn' => '<string>',
'StatesInput' => '<string>',
'StatesStatus' => '<string>',
'Unit' => '<string>',
'Value' => <float>,
'XRayErrorPercent' => <integer>,
'XRayFaultPercent' => <integer>,
'XRayNodeName' => '<string>',
'XRayNodeType' => '<string>',
'XRayRequestAverageLatency' => <integer>,
'XRayRequestCount' => <integer>,
'XRayThrottlePercent' => <integer>,
],
// ...
],
],
]
Result Details
Members
- RelatedObservations
-
- Type: RelatedObservations structure
Observations related to the problem.
Errors
-
The server encountered an internal error and is unable to complete the request.
-
The parameter is not valid.
-
The resource does not exist in the customer account.
ListApplications
$result = $client->listApplications([/* ... */]); $promise = $client->listApplicationsAsync([/* ... */]);
Lists the IDs of the applications that you are monitoring.
Parameter Syntax
$result = $client->listApplications([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'ApplicationInfoList' => [
[
'AutoConfigEnabled' => true || false,
'CWEMonitorEnabled' => true || false,
'DiscoveryType' => 'RESOURCE_GROUP_BASED|ACCOUNT_BASED',
'LifeCycle' => '<string>',
'OpsCenterEnabled' => true || false,
'OpsItemSNSTopicArn' => '<string>',
'Remarks' => '<string>',
'ResourceGroupName' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- ApplicationInfoList
-
- Type: Array of ApplicationInfo structures
The list of applications.
- NextToken
-
- Type: string
The token used to retrieve the next page of results. This value is
nullwhen there are no more results to return.
Errors
-
The parameter is not valid.
-
The server encountered an internal error and is unable to complete the request.
ListComponents
$result = $client->listComponents([/* ... */]); $promise = $client->listComponentsAsync([/* ... */]);
Lists the auto-grouped, standalone, and custom components of the application.
Parameter Syntax
$result = $client->listComponents([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'ResourceGroupName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned
NextTokenvalue. - NextToken
-
- Type: string
The token to request the next page of results.
- ResourceGroupName
-
- Required: Yes
- Type: string
The name of the resource group.
Result Syntax
[
'ApplicationComponentList' => [
[
'ComponentName' => '<string>',
'ComponentRemarks' => '<string>',
'DetectedWorkload' => [
'<Tier>' => ['<string>', ...],
// ...
],
'Monitor' => true || false,
'OsType' => 'WINDOWS|LINUX',
'ResourceType' => '<string>',
'Tier' => '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',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- ApplicationComponentList
-
- Type: Array of ApplicationComponent structures
The list of application components.
- NextToken
-
- Type: string
The token to request the next page of results.
Errors
-
The resource does not exist in the customer account.
-
The parameter is not valid.
-
The server encountered an internal error and is unable to complete the request.
ListConfigurationHistory
$result = $client->listConfigurationHistory([/* ... */]); $promise = $client->listConfigurationHistoryAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listConfigurationHistory([
'EndTime' => <integer || string || DateTime>,
'EventStatus' => 'INFO|WARN|ERROR',
'MaxResults' => <integer>,
'NextToken' => '<string>',
'ResourceGroupName' => '<string>',
'StartTime' => <integer || string || DateTime>,
]);
Parameter Details
Members
- EndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end time of the event.
- EventStatus
-
- Type: string
The status of the configuration update event. Possible values include INFO, WARN, and ERROR.
- MaxResults
-
- Type: int
The maximum number of results returned by
ListConfigurationHistoryin paginated output. When this parameter is used,ListConfigurationHistoryreturns onlyMaxResultsin a single page along with aNextTokenresponse element. The remaining results of the initial request can be seen by sending anotherListConfigurationHistoryrequest with the returnedNextTokenvalue. If this parameter is not used, thenListConfigurationHistoryreturns all results. - NextToken
-
- Type: string
The
NextTokenvalue returned from a previous paginatedListConfigurationHistoryrequest whereMaxResultswas used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned theNextTokenvalue. This value isnullwhen there are no more results to return. - ResourceGroupName
-
- Type: string
Resource group to which the application belongs.
- StartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start time of the event.
Result Syntax
[
'EventList' => [
[
'EventDetail' => '<string>',
'EventResourceName' => '<string>',
'EventResourceType' => 'CLOUDWATCH_ALARM|CLOUDWATCH_LOG|CLOUDFORMATION|SSM_ASSOCIATION',
'EventStatus' => 'INFO|WARN|ERROR',
'EventTime' => <DateTime>,
'MonitoredResourceARN' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- EventList
-
- Type: Array of ConfigurationEvent structures
The list of configuration events and their corresponding details.
- NextToken
-
- Type: string
The
NextTokenvalue to include in a futureListConfigurationHistoryrequest. When the results of aListConfigurationHistoryrequest exceedMaxResults, this value can be used to retrieve the next page of results. This value isnullwhen there are no more results to return.
Errors
-
The parameter is not valid.
-
The resource does not exist in the customer account.
-
The server encountered an internal error and is unable to complete the request.
ListLogPatternSets
$result = $client->listLogPatternSets([/* ... */]); $promise = $client->listLogPatternSetsAsync([/* ... */]);
Lists the log pattern sets in the specific application.
Parameter Syntax
$result = $client->listLogPatternSets([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'ResourceGroupName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned
NextTokenvalue. - NextToken
-
- Type: string
The token to request the next page of results.
- ResourceGroupName
-
- Required: Yes
- Type: string
The name of the resource group.
Result Syntax
[
'LogPatternSets' => ['<string>', ...],
'NextToken' => '<string>',
'ResourceGroupName' => '<string>',
]
Result Details
Members
Errors
-
The resource does not exist in the customer account.
-
The parameter is not valid.
-
The server encountered an internal error and is unable to complete the request.
ListLogPatterns
$result = $client->listLogPatterns([/* ... */]); $promise = $client->listLogPatternsAsync([/* ... */]);
Lists the log patterns in the specific log LogPatternSet.
Parameter Syntax
$result = $client->listLogPatterns([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'PatternSetName' => '<string>',
'ResourceGroupName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned
NextTokenvalue. - NextToken
-
- Type: string
The token to request the next page of results.
- PatternSetName
-
- Type: string
The name of the log pattern set.
- ResourceGroupName
-
- Required: Yes
- Type: string
The name of the resource group.
Result Syntax
[
'LogPatterns' => [
[
'Pattern' => '<string>',
'PatternName' => '<string>',
'PatternSetName' => '<string>',
'Rank' => <integer>,
],
// ...
],
'NextToken' => '<string>',
'ResourceGroupName' => '<string>',
]
Result Details
Members
- LogPatterns
-
- Type: Array of LogPattern structures
The list of log patterns.
- NextToken
-
- Type: string
The token used to retrieve the next page of results. This value is
nullwhen there are no more results to return. - ResourceGroupName
-
- Type: string
The name of the resource group.
Errors
-
The resource does not exist in the customer account.
-
The parameter is not valid.
-
The server encountered an internal error and is unable to complete the request.
ListProblems
$result = $client->listProblems([/* ... */]); $promise = $client->listProblemsAsync([/* ... */]);
Lists the problems with your application.
Parameter Syntax
$result = $client->listProblems([
'ComponentName' => '<string>',
'EndTime' => <integer || string || DateTime>,
'MaxResults' => <integer>,
'NextToken' => '<string>',
'ResourceGroupName' => '<string>',
'StartTime' => <integer || string || DateTime>,
]);
Parameter Details
Members
- ComponentName
-
- Type: string
The name of the component.
- EndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the problem ended, in epoch seconds. If not specified, problems within the past seven days are returned.
- MaxResults
-
- Type: int
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned
NextTokenvalue. - NextToken
-
- Type: string
The token to request the next page of results.
- ResourceGroupName
-
- Type: string
The name of the resource group.
- StartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
Result Syntax
[
'NextToken' => '<string>',
'ProblemList' => [
[
'AffectedResource' => '<string>',
'EndTime' => <DateTime>,
'Feedback' => ['<string>', ...],
'Id' => '<string>',
'Insights' => '<string>',
'LastRecurrenceTime' => <DateTime>,
'RecurringCount' => <integer>,
'ResourceGroupName' => '<string>',
'SeverityLevel' => 'Informative|Low|Medium|High',
'StartTime' => <DateTime>,
'Status' => 'IGNORE|RESOLVED|PENDING|RECURRING',
'Title' => '<string>',
],
// ...
],
'ResourceGroupName' => '<string>',
]
Result Details
Members
- NextToken
-
- Type: string
The token used to retrieve the next page of results. This value is
nullwhen there are no more results to return. - ProblemList
-
- Type: Array of Problem structures
The list of problems.
- ResourceGroupName
-
- Type: string
The name of the resource group.
Errors
-
The parameter is not valid.
-
The resource does not exist in the customer account.
-
The server encountered an internal error and is unable to complete the request.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listTagsForResource([
'ResourceARN' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]
Result Details
Members
- Tags
-
- Type: Array of Tag structures
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).
Errors
-
The resource does not exist in the customer account.
-
The parameter is not valid.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->tagResource([
'ResourceARN' => '<string>', // REQUIRED
'Tags' => [ // REQUIRED
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ResourceARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the application that you want to add one or more tags to.
- Tags
-
- Required: Yes
- Type: Array of Tag structures
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.
Result Syntax
[]
Result Details
Errors
-
The resource does not exist in the customer account.
-
The number of the provided tags is beyond the limit, or the number of total tags you are trying to attach to the specified resource exceeds the limit.
-
The parameter is not valid.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Remove one or more tags (keys and values) from a specified application.
Parameter Syntax
$result = $client->untagResource([
'ResourceARN' => '<string>', // REQUIRED
'TagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- ResourceARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the application that you want to remove one or more tags from.
- TagKeys
-
- Required: Yes
- Type: Array of strings
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
TagKeysparameter and argument for each additional tag to remove, separated by an ampersand.
Result Syntax
[]
Result Details
Errors
-
The resource does not exist in the customer account.
-
The parameter is not valid.
UpdateApplication
$result = $client->updateApplication([/* ... */]); $promise = $client->updateApplicationAsync([/* ... */]);
Updates the application.
Parameter Syntax
$result = $client->updateApplication([
'AutoConfigEnabled' => true || false,
'CWEMonitorEnabled' => true || false,
'OpsCenterEnabled' => true || false,
'OpsItemSNSTopicArn' => '<string>',
'RemoveSNSTopic' => true || false,
'ResourceGroupName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AutoConfigEnabled
-
- Type: boolean
Turns auto-configuration on or off.
- CWEMonitorEnabled
-
- Type: boolean
Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as
instance terminated,failed deployment, and others. - OpsCenterEnabled
-
- Type: boolean
When set to
true, creates opsItems for any problems detected on an application. - OpsItemSNSTopicArn
-
- Type: string
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
-
- Type: boolean
Disassociates the SNS topic from the opsItem created for detected problems.
- ResourceGroupName
-
- Required: Yes
- Type: string
The name of the resource group.
Result Syntax
[
'ApplicationInfo' => [
'AutoConfigEnabled' => true || false,
'CWEMonitorEnabled' => true || false,
'DiscoveryType' => 'RESOURCE_GROUP_BASED|ACCOUNT_BASED',
'LifeCycle' => '<string>',
'OpsCenterEnabled' => true || false,
'OpsItemSNSTopicArn' => '<string>',
'Remarks' => '<string>',
'ResourceGroupName' => '<string>',
],
]
Result Details
Members
- ApplicationInfo
-
- Type: ApplicationInfo structure
Information about the application.
Errors
-
The server encountered an internal error and is unable to complete the request.
-
The resource does not exist in the customer account.
-
The parameter is not valid.
UpdateComponent
$result = $client->updateComponent([/* ... */]); $promise = $client->updateComponentAsync([/* ... */]);
Updates the custom component name and/or the list of resources that make up the component.
Parameter Syntax
$result = $client->updateComponent([
'ComponentName' => '<string>', // REQUIRED
'NewComponentName' => '<string>',
'ResourceGroupName' => '<string>', // REQUIRED
'ResourceList' => ['<string>', ...],
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The resource is already created or in use.
-
The resource does not exist in the customer account.
-
The parameter is not valid.
-
The server encountered an internal error and is unable to complete the request.
UpdateComponentConfiguration
$result = $client->updateComponentConfiguration([/* ... */]); $promise = $client->updateComponentConfigurationAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->updateComponentConfiguration([
'AutoConfigEnabled' => true || false,
'ComponentConfiguration' => '<string>',
'ComponentName' => '<string>', // REQUIRED
'Monitor' => true || false,
'ResourceGroupName' => '<string>', // REQUIRED
'Tier' => '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',
]);
Parameter Details
Members
- AutoConfigEnabled
-
- Type: boolean
Automatically configures the component by applying the recommended configurations.
- ComponentConfiguration
-
- Type: string
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
DescribeComponentConfigurationRecommendationto see the recommended configuration for a component. For the complete format of the component configuration file, see Component Configuration. - ComponentName
-
- Required: Yes
- Type: string
The name of the component.
- Monitor
-
- Type: boolean
Indicates whether the application component is monitored.
- ResourceGroupName
-
- Required: Yes
- Type: string
The name of the resource group.
- Tier
-
- Type: string
The tier of the application component.
Result Syntax
[]
Result Details
Errors
-
The resource does not exist in the customer account.
-
The parameter is not valid.
-
The server encountered an internal error and is unable to complete the request.
UpdateLogPattern
$result = $client->updateLogPattern([/* ... */]); $promise = $client->updateLogPatternAsync([/* ... */]);
Adds a log pattern to a LogPatternSet.
Parameter Syntax
$result = $client->updateLogPattern([
'Pattern' => '<string>',
'PatternName' => '<string>', // REQUIRED
'PatternSetName' => '<string>', // REQUIRED
'Rank' => <integer>,
'ResourceGroupName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Pattern
-
- Type: string
The log pattern. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.
- PatternName
-
- Required: Yes
- Type: string
The name of the log pattern.
- PatternSetName
-
- Required: Yes
- Type: string
The name of the log pattern set.
- Rank
-
- Type: int
Rank of the log pattern. Must be a value between
1and1,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 rank1will be the first to get matched to a log line. A pattern of rank1,000,000will be last to get matched. When you configure custom log patterns from the console, aLowseverity pattern translates to a750,000rank. AMediumseverity pattern translates to a500,000rank. And aHighseverity pattern translates to a250,000rank. Rank values less than1or greater than1,000,000are reserved for AWS-provided patterns. - ResourceGroupName
-
- Required: Yes
- Type: string
The name of the resource group.
Result Syntax
[
'LogPattern' => [
'Pattern' => '<string>',
'PatternName' => '<string>',
'PatternSetName' => '<string>',
'Rank' => <integer>,
],
'ResourceGroupName' => '<string>',
]
Result Details
Members
- LogPattern
-
- Type: LogPattern structure
The successfully created log pattern.
- ResourceGroupName
-
- Type: string
The name of the resource group.
Errors
-
The resource is already created or in use.
-
The resource does not exist in the customer account.
-
The parameter is not valid.
-
The server encountered an internal error and is unable to complete the request.
Shapes
AccessDeniedException
ApplicationComponent
Description
Describes a standalone resource or similarly grouped resources that the application is made up of.
Members
- ComponentName
-
- Type: string
The name of the component.
- ComponentRemarks
-
- Type: string
If logging is supported for the resource type, indicates whether the component has configured logs to be monitored.
- DetectedWorkload
-
- Type: Associative array of custom strings keys (Tier) to stringss
Workloads detected in the application component.
- Monitor
-
- Type: boolean
Indicates whether the application component is monitored.
- OsType
-
- Type: string
The operating system of the component.
- ResourceType
-
- Type: string
The resource type. Supported resource types include EC2 instances, Auto Scaling group, Classic ELB, Application ELB, and SQS Queue.
- Tier
-
- Type: string
The stack tier of the application component.
ApplicationInfo
Description
Describes the status of the application.
Members
- AutoConfigEnabled
-
- Type: boolean
Indicates whether auto-configuration is turned on for this application.
- CWEMonitorEnabled
-
- Type: boolean
Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as
instance terminated,failed deployment, and others. - DiscoveryType
-
- Type: string
The method used by Application Insights to onboard your resources.
- LifeCycle
-
- Type: string
The lifecycle of the application.
- OpsCenterEnabled
-
- Type: boolean
Indicates whether Application Insights will create opsItems for any problem detected by Application Insights for an application.
- OpsItemSNSTopicArn
-
- Type: string
The SNS topic provided to Application Insights that is associated to the created opsItems to receive SNS notifications for opsItem updates.
- Remarks
-
- Type: string
The issues on the user side that block Application Insights from successfully monitoring an application. Example remarks include:
-
“Configuring application, detected 1 Errors, 3 Warnings”
-
“Configuring application, detected 1 Unconfigured Components”
- ResourceGroupName
-
- Type: string
The name of the resource group used for the application.
BadRequestException
ConfigurationEvent
Description
The event information.
Members
- EventDetail
-
- Type: string
The details of the event in plain text.
- EventResourceName
-
- Type: string
The name of the resource Application Insights attempted to configure.
- EventResourceType
-
- Type: string
The resource type that Application Insights attempted to configure, for example, CLOUDWATCH_ALARM.
- EventStatus
-
- Type: string
The status of the configuration update event. Possible values include INFO, WARN, and ERROR.
- EventTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the event.
- MonitoredResourceARN
-
- Type: string
The resource monitored by Application Insights.
InternalServerException
Description
The server encountered an internal error and is unable to complete the request.
Members
LogPattern
Description
An object that defines the log patterns that belongs to a LogPatternSet.
Members
- Pattern
-
- Type: string
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.
- PatternName
-
- Type: string
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.
- PatternSetName
-
- Type: string
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.
- Rank
-
- Type: int
Rank of the log pattern. Must be a value between
1and1,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 rank1will be the first to get matched to a log line. A pattern of rank1,000,000will be last to get matched. When you configure custom log patterns from the console, aLowseverity pattern translates to a750,000rank. AMediumseverity pattern translates to a500,000rank. And aHighseverity pattern translates to a250,000rank. Rank values less than1or greater than1,000,000are reserved for AWS-provided patterns.
Observation
Description
Describes an anomaly or error with the application.
Members
- CloudWatchEventDetailType
-
- Type: string
The detail type of the CloudWatch Event-based observation, for example,
EC2 Instance State-change Notification. - CloudWatchEventId
-
- Type: string
The ID of the CloudWatch Event-based observation related to the detected problem.
- CloudWatchEventSource
-
- Type: string
The source of the CloudWatch Event.
- CodeDeployApplication
-
- Type: string
The CodeDeploy application to which the deployment belongs.
- CodeDeployDeploymentGroup
-
- Type: string
The deployment group to which the CodeDeploy deployment belongs.
- CodeDeployDeploymentId
-
- Type: string
The deployment ID of the CodeDeploy-based observation related to the detected problem.
- CodeDeployInstanceGroupId
-
- Type: string
The instance group to which the CodeDeploy instance belongs.
- CodeDeployState
-
- Type: string
The status of the CodeDeploy deployment, for example
SUCCESSorFAILURE. - EbsCause
-
- Type: string
The cause of an EBS CloudWatch event.
- EbsEvent
-
- Type: string
The type of EBS CloudWatch event, such as
createVolume,deleteVolumeorattachVolume. - EbsRequestId
-
- Type: string
The request ID of an EBS CloudWatch event.
- EbsResult
-
- Type: string
The result of an EBS CloudWatch event, such as
failedorsucceeded. - Ec2State
-
- Type: string
The state of the instance, such as
STOPPINGorTERMINATING. - EndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the observation ended, in epoch seconds.
- HealthEventArn
-
- Type: string
The Amazon Resource Name (ARN) of the AWS Health Event-based observation.
- HealthEventDescription
-
- Type: string
The description of the AWS Health event provided by the service, such as Amazon EC2.
- HealthEventTypeCategory
-
- Type: string
The category of the AWS Health event, such as
issue. - HealthEventTypeCode
-
- Type: string
The type of the AWS Health event, for example,
AWS_EC2_POWER_CONNECTIVITY_ISSUE. - HealthService
-
- Type: string
The service to which the AWS Health Event belongs, such as EC2.
- Id
-
- Type: string
The ID of the observation type.
- LineTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp in the CloudWatch Logs that specifies when the matched line occurred.
- LogFilter
-
- Type: string
The log filter of the observation.
- LogGroup
-
- Type: string
The log group name.
- LogText
-
- Type: string
The log text of the observation.
- MetricName
-
- Type: string
The name of the observation metric.
- MetricNamespace
-
- Type: string
The namespace of the observation metric.
- RdsEventCategories
-
- Type: string
The category of an RDS event.
- RdsEventMessage
-
- Type: string
The message of an RDS event.
- S3EventName
-
- Type: string
The name of the S3 CloudWatch Event-based observation.
- SourceARN
-
- Type: string
The source resource ARN of the observation.
- SourceType
-
- Type: string
The source type of the observation.
- StartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the observation was first detected, in epoch seconds.
- StatesArn
-
- Type: string
The Amazon Resource Name (ARN) of the step function-based observation.
- StatesExecutionArn
-
- Type: string
The Amazon Resource Name (ARN) of the step function execution-based observation.
- StatesInput
-
- Type: string
The input to the step function-based observation.
- StatesStatus
-
- Type: string
The status of the step function-related observation.
- Unit
-
- Type: string
The unit of the source observation metric.
- Value
-
- Type: double
The value of the source observation metric.
- XRayErrorPercent
-
- Type: int
The X-Ray request error percentage for this node.
- XRayFaultPercent
-
- Type: int
The X-Ray request fault percentage for this node.
- XRayNodeName
-
- Type: string
The name of the X-Ray node.
- XRayNodeType
-
- Type: string
The type of the X-Ray node.
- XRayRequestAverageLatency
-
- Type: long (int|float)
The X-Ray node request average latency for this node.
- XRayRequestCount
-
- Type: int
The X-Ray request count for this node.
- XRayThrottlePercent
-
- Type: int
The X-Ray request throttle percentage for this node.
Problem
Description
Describes a problem that is detected by correlating observations.
Members
- AffectedResource
-
- Type: string
The resource affected by the problem.
- EndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the problem ended, in epoch seconds.
- Feedback
-
- Type: Associative array of custom strings keys (FeedbackKey) to strings
Feedback provided by the user about the problem.
- Id
-
- Type: string
The ID of the problem.
- Insights
-
- Type: string
A detailed analysis of the problem using machine learning.
- LastRecurrenceTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time that the problem reoccurred after its last resolution.
- RecurringCount
-
- Type: long (int|float)
The number of times that the same problem reoccurred after the first time it was resolved.
- ResourceGroupName
-
- Type: string
The name of the resource group affected by the problem.
- SeverityLevel
-
- Type: string
A measure of the level of impact of the problem.
- StartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the problem started, in epoch seconds.
- Status
-
- Type: string
The status of the problem.
- Title
-
- Type: string
The name of the problem.
RelatedObservations
Description
Describes observations related to the problem.
Members
- ObservationList
-
- Type: Array of Observation structures
The list of observations related to the problem.
ResourceInUseException
ResourceNotFoundException
Tag
Description
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.
Members
- Key
-
- Required: Yes
- Type: string
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
-
- Required: Yes
- Type: string
The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don't want an application to have a specific tag value, don't specify a value for this parameter.
TagsAlreadyExistException
Description
Tags are already registered for the specified application ARN.
Members
TooManyTagsException
Description
The number of the provided tags is beyond the limit, or the number of total tags you are trying to attach to the specified resource exceeds the limit.