Skip to content

Commit b70eff4

Browse files
author
awstools
committed
feat(client-application-insights): Provide Account Level onboarding support through CFN/CLI
1 parent e10c8ed commit b70eff4

13 files changed

+445
-375
lines changed

clients/client-application-insights/README.md

+10-11
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,17 @@ AWS SDK for JavaScript ApplicationInsights Client for Node.js, Browser and React
1111

1212
<fullname>Amazon CloudWatch Application Insights</fullname>
1313

14-
<p> Amazon CloudWatch Application Insights is a service that
15-
helps you detect common problems with your applications. It
16-
enables you to pinpoint the source of issues in your applications (built with technologies
17-
such as Microsoft IIS, .NET, and Microsoft SQL Server), by providing key insights into
18-
detected problems.</p>
14+
<p> Amazon CloudWatch Application Insights is a service that helps you detect common
15+
problems with your applications. It enables you to pinpoint the source of issues in your
16+
applications (built with technologies such as Microsoft IIS, .NET, and Microsoft SQL
17+
Server), by providing key insights into detected problems.</p>
1918
<p>After you onboard your application, CloudWatch Application Insights identifies,
20-
recommends, and sets up metrics and logs. It continuously analyzes and
21-
correlates your metrics and logs for unusual behavior to surface actionable problems with
22-
your application. For example, if your application is slow and unresponsive and leading to
23-
HTTP 500 errors in your Application Load Balancer (ALB), Application Insights informs you
24-
that a memory pressure problem with your SQL Server database is occurring. It bases this
25-
analysis on impactful metrics and log errors. </p>
19+
recommends, and sets up metrics and logs. It continuously analyzes and correlates your
20+
metrics and logs for unusual behavior to surface actionable problems with your application.
21+
For example, if your application is slow and unresponsive and leading to HTTP 500 errors in
22+
your Application Load Balancer (ALB), Application Insights informs you that a memory
23+
pressure problem with your SQL Server database is occurring. It bases this analysis on
24+
impactful metrics and log errors. </p>
2625

2726
## Installing
2827

clients/client-application-insights/src/ApplicationInsights.ts

+32-30
Original file line numberDiff line numberDiff line change
@@ -136,18 +136,17 @@ import {
136136

137137
/**
138138
* <fullname>Amazon CloudWatch Application Insights</fullname>
139-
* <p> Amazon CloudWatch Application Insights is a service that
140-
* helps you detect common problems with your applications. It
141-
* enables you to pinpoint the source of issues in your applications (built with technologies
142-
* such as Microsoft IIS, .NET, and Microsoft SQL Server), by providing key insights into
143-
* detected problems.</p>
139+
* <p> Amazon CloudWatch Application Insights is a service that helps you detect common
140+
* problems with your applications. It enables you to pinpoint the source of issues in your
141+
* applications (built with technologies such as Microsoft IIS, .NET, and Microsoft SQL
142+
* Server), by providing key insights into detected problems.</p>
144143
* <p>After you onboard your application, CloudWatch Application Insights identifies,
145-
* recommends, and sets up metrics and logs. It continuously analyzes and
146-
* correlates your metrics and logs for unusual behavior to surface actionable problems with
147-
* your application. For example, if your application is slow and unresponsive and leading to
148-
* HTTP 500 errors in your Application Load Balancer (ALB), Application Insights informs you
149-
* that a memory pressure problem with your SQL Server database is occurring. It bases this
150-
* analysis on impactful metrics and log errors. </p>
144+
* recommends, and sets up metrics and logs. It continuously analyzes and correlates your
145+
* metrics and logs for unusual behavior to surface actionable problems with your application.
146+
* For example, if your application is slow and unresponsive and leading to HTTP 500 errors in
147+
* your Application Load Balancer (ALB), Application Insights informs you that a memory
148+
* pressure problem with your SQL Server database is occurring. It bases this analysis on
149+
* impactful metrics and log errors. </p>
151150
*/
152151
export class ApplicationInsights extends ApplicationInsightsClient {
153152
/**
@@ -247,7 +246,8 @@ export class ApplicationInsights extends ApplicationInsightsClient {
247246
}
248247

249248
/**
250-
* <p>Removes the specified application from monitoring. Does not delete the application.</p>
249+
* <p>Removes the specified application from monitoring. Does not delete the
250+
* application.</p>
251251
*/
252252
public deleteApplication(
253253
args: DeleteApplicationCommandInput,
@@ -279,8 +279,9 @@ export class ApplicationInsights extends ApplicationInsightsClient {
279279
}
280280

281281
/**
282-
* <p>Ungroups a custom component. When you ungroup custom components, all applicable
283-
* monitors that are set up for the component are removed and the instances revert to their standalone status.</p>
282+
* <p>Ungroups a custom component. When you ungroup custom components, all applicable monitors
283+
* that are set up for the component are removed and the instances revert to their standalone
284+
* status.</p>
284285
*/
285286
public deleteComponent(
286287
args: DeleteComponentCommandInput,
@@ -376,7 +377,8 @@ export class ApplicationInsights extends ApplicationInsightsClient {
376377
}
377378

378379
/**
379-
* <p>Describes a component and lists the resources that are grouped together in a component.</p>
380+
* <p>Describes a component and lists the resources that are grouped together in a
381+
* component.</p>
380382
*/
381383
public describeComponent(
382384
args: DescribeComponentCommandInput,
@@ -666,15 +668,15 @@ export class ApplicationInsights extends ApplicationInsightsClient {
666668
}
667669

668670
/**
669-
* <p>
670-
* Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by Application Insights. Examples of events represented are:
671-
* </p>
671+
* <p> Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by
672+
* Application Insights. Examples of events represented are: </p>
672673
* <ul>
673674
* <li>
674675
* <p>INFO: creating a new alarm or updating an alarm threshold.</p>
675676
* </li>
676677
* <li>
677-
* <p>WARN: alarm not created due to insufficient data points used to predict thresholds.</p>
678+
* <p>WARN: alarm not created due to insufficient data points used to predict
679+
* thresholds.</p>
678680
* </li>
679681
* <li>
680682
* <p>ERROR: alarm not created due to permission errors or exceeding quotas. </p>
@@ -807,9 +809,9 @@ export class ApplicationInsights extends ApplicationInsightsClient {
807809
* <p>Retrieve a list of the tags (keys and values) that are associated with a specified
808810
* application. A <i>tag</i> is a label that you optionally define and associate
809811
* with an application. Each tag consists of a required <i>tag key</i> and an
810-
* optional associated <i>tag value</i>. A tag key is a general label that
811-
* acts as a category for more specific tag values. A tag value acts as a descriptor within
812-
* a tag key.</p>
812+
* optional associated <i>tag value</i>. A tag key is a general label that acts
813+
* as a category for more specific tag values. A tag value acts as a descriptor within a tag
814+
* key.</p>
813815
*/
814816
public listTagsForResource(
815817
args: ListTagsForResourceCommandInput,
@@ -842,13 +844,13 @@ export class ApplicationInsights extends ApplicationInsightsClient {
842844

843845
/**
844846
* <p>Add one or more tags (keys and values) to a specified application. A
845-
* <i>tag</i> is a label that you optionally define and associate with an
847+
* <i>tag</i> is a label that you optionally define and associate with an
846848
* application. Tags can help you categorize and manage application in different ways, such as
847849
* by purpose, owner, environment, or other criteria. </p>
848-
* <p>Each tag consists of a required <i>tag key</i> and an
849-
* associated <i>tag value</i>, both of which you define. A tag key is a
850-
* general label that acts as a category for more specific tag values. A tag value acts as
851-
* a descriptor within a tag key.</p>
850+
* <p>Each tag consists of a required <i>tag key</i> and an associated
851+
* <i>tag value</i>, both of which you define. A tag key is a general label
852+
* that acts as a category for more specific tag values. A tag value acts as a descriptor
853+
* within a tag key.</p>
852854
*/
853855
public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
854856
public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
@@ -971,9 +973,9 @@ export class ApplicationInsights extends ApplicationInsightsClient {
971973
}
972974

973975
/**
974-
* <p>Updates the monitoring configurations for the component. The configuration input parameter
975-
* is an escaped JSON of the configuration and should match the schema of what is returned
976-
* by <code>DescribeComponentConfigurationRecommendation</code>. </p>
976+
* <p>Updates the monitoring configurations for the component. The configuration input
977+
* parameter is an escaped JSON of the configuration and should match the schema of what is
978+
* returned by <code>DescribeComponentConfigurationRecommendation</code>. </p>
977979
*/
978980
public updateComponentConfiguration(
979981
args: UpdateComponentConfigurationCommandInput,

clients/client-application-insights/src/ApplicationInsightsClient.ts

+10-11
Original file line numberDiff line numberDiff line change
@@ -318,18 +318,17 @@ export interface ApplicationInsightsClientResolvedConfig extends ApplicationInsi
318318

319319
/**
320320
* <fullname>Amazon CloudWatch Application Insights</fullname>
321-
* <p> Amazon CloudWatch Application Insights is a service that
322-
* helps you detect common problems with your applications. It
323-
* enables you to pinpoint the source of issues in your applications (built with technologies
324-
* such as Microsoft IIS, .NET, and Microsoft SQL Server), by providing key insights into
325-
* detected problems.</p>
321+
* <p> Amazon CloudWatch Application Insights is a service that helps you detect common
322+
* problems with your applications. It enables you to pinpoint the source of issues in your
323+
* applications (built with technologies such as Microsoft IIS, .NET, and Microsoft SQL
324+
* Server), by providing key insights into detected problems.</p>
326325
* <p>After you onboard your application, CloudWatch Application Insights identifies,
327-
* recommends, and sets up metrics and logs. It continuously analyzes and
328-
* correlates your metrics and logs for unusual behavior to surface actionable problems with
329-
* your application. For example, if your application is slow and unresponsive and leading to
330-
* HTTP 500 errors in your Application Load Balancer (ALB), Application Insights informs you
331-
* that a memory pressure problem with your SQL Server database is occurring. It bases this
332-
* analysis on impactful metrics and log errors. </p>
326+
* recommends, and sets up metrics and logs. It continuously analyzes and correlates your
327+
* metrics and logs for unusual behavior to surface actionable problems with your application.
328+
* For example, if your application is slow and unresponsive and leading to HTTP 500 errors in
329+
* your Application Load Balancer (ALB), Application Insights informs you that a memory
330+
* pressure problem with your SQL Server database is occurring. It bases this analysis on
331+
* impactful metrics and log errors. </p>
333332
*/
334333
export class ApplicationInsightsClient extends __Client<
335334
__HttpHandlerOptions,

clients/client-application-insights/src/commands/DeleteApplicationCommand.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ export interface DeleteApplicationCommandInput extends DeleteApplicationRequest
2727
export interface DeleteApplicationCommandOutput extends DeleteApplicationResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>Removes the specified application from monitoring. Does not delete the application.</p>
30+
* <p>Removes the specified application from monitoring. Does not delete the
31+
* application.</p>
3132
* @example
3233
* Use a bare-bones client and the command you need to make an API call.
3334
* ```javascript

clients/client-application-insights/src/commands/DeleteComponentCommand.ts

+3-2
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,9 @@ export interface DeleteComponentCommandInput extends DeleteComponentRequest {}
2727
export interface DeleteComponentCommandOutput extends DeleteComponentResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>Ungroups a custom component. When you ungroup custom components, all applicable
31-
* monitors that are set up for the component are removed and the instances revert to their standalone status.</p>
30+
* <p>Ungroups a custom component. When you ungroup custom components, all applicable monitors
31+
* that are set up for the component are removed and the instances revert to their standalone
32+
* status.</p>
3233
* @example
3334
* Use a bare-bones client and the command you need to make an API call.
3435
* ```javascript

clients/client-application-insights/src/commands/DescribeComponentCommand.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ export interface DescribeComponentCommandInput extends DescribeComponentRequest
2727
export interface DescribeComponentCommandOutput extends DescribeComponentResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>Describes a component and lists the resources that are grouped together in a component.</p>
30+
* <p>Describes a component and lists the resources that are grouped together in a
31+
* component.</p>
3132
* @example
3233
* Use a bare-bones client and the command you need to make an API call.
3334
* ```javascript

clients/client-application-insights/src/commands/ListConfigurationHistoryCommand.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,15 @@ export interface ListConfigurationHistoryCommandInput extends ListConfigurationH
2727
export interface ListConfigurationHistoryCommandOutput extends ListConfigurationHistoryResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>
31-
* Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by Application Insights. Examples of events represented are:
32-
* </p>
30+
* <p> Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by
31+
* Application Insights. Examples of events represented are: </p>
3332
* <ul>
3433
* <li>
3534
* <p>INFO: creating a new alarm or updating an alarm threshold.</p>
3635
* </li>
3736
* <li>
38-
* <p>WARN: alarm not created due to insufficient data points used to predict thresholds.</p>
37+
* <p>WARN: alarm not created due to insufficient data points used to predict
38+
* thresholds.</p>
3939
* </li>
4040
* <li>
4141
* <p>ERROR: alarm not created due to permission errors or exceeding quotas. </p>

clients/client-application-insights/src/commands/ListTagsForResourceCommand.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
3030
* <p>Retrieve a list of the tags (keys and values) that are associated with a specified
3131
* application. A <i>tag</i> is a label that you optionally define and associate
3232
* with an application. Each tag consists of a required <i>tag key</i> and an
33-
* optional associated <i>tag value</i>. A tag key is a general label that
34-
* acts as a category for more specific tag values. A tag value acts as a descriptor within
35-
* a tag key.</p>
33+
* optional associated <i>tag value</i>. A tag key is a general label that acts
34+
* as a category for more specific tag values. A tag value acts as a descriptor within a tag
35+
* key.</p>
3636
* @example
3737
* Use a bare-bones client and the command you need to make an API call.
3838
* ```javascript

clients/client-application-insights/src/commands/TagResourceCommand.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
2828

2929
/**
3030
* <p>Add one or more tags (keys and values) to a specified application. A
31-
* <i>tag</i> is a label that you optionally define and associate with an
31+
* <i>tag</i> is a label that you optionally define and associate with an
3232
* application. Tags can help you categorize and manage application in different ways, such as
3333
* by purpose, owner, environment, or other criteria. </p>
34-
* <p>Each tag consists of a required <i>tag key</i> and an
35-
* associated <i>tag value</i>, both of which you define. A tag key is a
36-
* general label that acts as a category for more specific tag values. A tag value acts as
37-
* a descriptor within a tag key.</p>
34+
* <p>Each tag consists of a required <i>tag key</i> and an associated
35+
* <i>tag value</i>, both of which you define. A tag key is a general label
36+
* that acts as a category for more specific tag values. A tag value acts as a descriptor
37+
* within a tag key.</p>
3838
* @example
3939
* Use a bare-bones client and the command you need to make an API call.
4040
* ```javascript

clients/client-application-insights/src/commands/UpdateComponentConfigurationCommand.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ export interface UpdateComponentConfigurationCommandOutput
2929
__MetadataBearer {}
3030

3131
/**
32-
* <p>Updates the monitoring configurations for the component. The configuration input parameter
33-
* is an escaped JSON of the configuration and should match the schema of what is returned
34-
* by <code>DescribeComponentConfigurationRecommendation</code>. </p>
32+
* <p>Updates the monitoring configurations for the component. The configuration input
33+
* parameter is an escaped JSON of the configuration and should match the schema of what is
34+
* returned by <code>DescribeComponentConfigurationRecommendation</code>. </p>
3535
* @example
3636
* Use a bare-bones client and the command you need to make an API call.
3737
* ```javascript

0 commit comments

Comments
 (0)