Skip to content

Commit 1b75f97

Browse files
author
awstools
committed
docs(client-amp): Overall documentation updates.
1 parent 022ccd4 commit 1b75f97

32 files changed

+1024
-768
lines changed

‎clients/client-amp/README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,24 @@
66

77
AWS SDK for JavaScript Amp Client for Node.js, Browser and React Native.
88

9-
Amazon Managed Service for Prometheus
9+
<p>Amazon Managed Service for Prometheus is a serverless, Prometheus-compatible monitoring service for
10+
container metrics that makes it easier to securely monitor container environments at
11+
scale. With Amazon Managed Service for Prometheus, you can use the same open-source Prometheus data
12+
model and query language that you use today to monitor the performance of your
13+
containerized workloads, and also enjoy improved scalability, availability, and security
14+
without having to manage the underlying infrastructure.</p>
15+
<p>For more information about Amazon Managed Service for Prometheus, see the <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/what-is-Amazon-Managed-Service-Prometheus.html">Amazon Managed Service for Prometheus</a> User Guide.</p>
16+
<p>Amazon Managed Service for Prometheus includes two APIs.</p>
17+
<ul>
18+
<li>
19+
<p>Use the Amazon Web Services API described in this guide to manage Amazon Managed Service for Prometheus resources, such as workspaces, rule groups, and alert
20+
managers.</p>
21+
</li>
22+
<li>
23+
<p>Use the <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-APIReference.html#AMP-APIReference-Prometheus-Compatible-Apis">Prometheus-compatible API</a> to work within your Prometheus
24+
workspace.</p>
25+
</li>
26+
</ul>
1027

1128
## Installing
1229

‎clients/client-amp/src/Amp.ts

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -563,7 +563,24 @@ export interface Amp {
563563

564564
/**
565565
* @public
566-
* Amazon Managed Service for Prometheus
566+
* <p>Amazon Managed Service for Prometheus is a serverless, Prometheus-compatible monitoring service for
567+
* container metrics that makes it easier to securely monitor container environments at
568+
* scale. With Amazon Managed Service for Prometheus, you can use the same open-source Prometheus data
569+
* model and query language that you use today to monitor the performance of your
570+
* containerized workloads, and also enjoy improved scalability, availability, and security
571+
* without having to manage the underlying infrastructure.</p>
572+
* <p>For more information about Amazon Managed Service for Prometheus, see the <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/what-is-Amazon-Managed-Service-Prometheus.html">Amazon Managed Service for Prometheus</a> User Guide.</p>
573+
* <p>Amazon Managed Service for Prometheus includes two APIs.</p>
574+
* <ul>
575+
* <li>
576+
* <p>Use the Amazon Web Services API described in this guide to manage Amazon Managed Service for Prometheus resources, such as workspaces, rule groups, and alert
577+
* managers.</p>
578+
* </li>
579+
* <li>
580+
* <p>Use the <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-APIReference.html#AMP-APIReference-Prometheus-Compatible-Apis">Prometheus-compatible API</a> to work within your Prometheus
581+
* workspace.</p>
582+
* </li>
583+
* </ul>
567584
*/
568585
export class Amp extends AmpClient implements Amp {}
569586
createAggregatedClient(commands, Amp);

‎clients/client-amp/src/AmpClient.ts

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -367,7 +367,24 @@ export interface AmpClientResolvedConfig extends AmpClientResolvedConfigType {}
367367

368368
/**
369369
* @public
370-
* Amazon Managed Service for Prometheus
370+
* <p>Amazon Managed Service for Prometheus is a serverless, Prometheus-compatible monitoring service for
371+
* container metrics that makes it easier to securely monitor container environments at
372+
* scale. With Amazon Managed Service for Prometheus, you can use the same open-source Prometheus data
373+
* model and query language that you use today to monitor the performance of your
374+
* containerized workloads, and also enjoy improved scalability, availability, and security
375+
* without having to manage the underlying infrastructure.</p>
376+
* <p>For more information about Amazon Managed Service for Prometheus, see the <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/what-is-Amazon-Managed-Service-Prometheus.html">Amazon Managed Service for Prometheus</a> User Guide.</p>
377+
* <p>Amazon Managed Service for Prometheus includes two APIs.</p>
378+
* <ul>
379+
* <li>
380+
* <p>Use the Amazon Web Services API described in this guide to manage Amazon Managed Service for Prometheus resources, such as workspaces, rule groups, and alert
381+
* managers.</p>
382+
* </li>
383+
* <li>
384+
* <p>Use the <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-APIReference.html#AMP-APIReference-Prometheus-Compatible-Apis">Prometheus-compatible API</a> to work within your Prometheus
385+
* workspace.</p>
386+
* </li>
387+
* </ul>
371388
*/
372389
export class AmpClient extends __Client<
373390
__HttpHandlerOptions,

‎clients/client-amp/src/commands/CreateAlertManagerDefinitionCommand.ts

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,10 @@ export interface CreateAlertManagerDefinitionCommandOutput
3333

3434
/**
3535
* @public
36-
* Create an alert manager definition.
36+
* <p>The <code>CreateAlertManagerDefinition</code> operation creates the alert manager
37+
* definition in a workspace. If a workspace already has an alert manager definition, don't
38+
* use this operation to update it. Instead, use
39+
* <code>PutAlertManagerDefinition</code>.</p>
3740
* @example
3841
* Use a bare-bones client and the command you need to make an API call.
3942
* ```javascript
@@ -63,25 +66,26 @@ export interface CreateAlertManagerDefinitionCommandOutput
6366
* @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
6467
*
6568
* @throws {@link AccessDeniedException} (client fault)
66-
* User does not have sufficient access to perform this action.
69+
* <p>You do not have sufficient access to perform this action.</p>
6770
*
6871
* @throws {@link ConflictException} (client fault)
69-
* Updating or deleting a resource can cause an inconsistent state.
72+
* <p>The request would cause an inconsistent state.</p>
7073
*
7174
* @throws {@link InternalServerException} (server fault)
72-
* Unexpected error during processing of request.
75+
* <p>An unexpected error occurred during the processing of the request.</p>
7376
*
7477
* @throws {@link ResourceNotFoundException} (client fault)
75-
* Request references a resource which does not exist.
78+
* <p>The request references a resources that doesn't exist.</p>
7679
*
7780
* @throws {@link ServiceQuotaExceededException} (client fault)
78-
* Request would cause a service quota to be exceeded.
81+
* <p>Completing the request would cause a service quota to be exceeded.</p>
7982
*
8083
* @throws {@link ThrottlingException} (client fault)
81-
* Request was denied due to request throttling.
84+
* <p>The request was denied due to request throttling.</p>
8285
*
8386
* @throws {@link ValidationException} (client fault)
84-
* The input fails to satisfy the constraints specified by an AWS service.
87+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
88+
* service.</p>
8589
*
8690
* @throws {@link AmpServiceException}
8791
* <p>Base exception class for all service exceptions from Amp service.</p>

‎clients/client-amp/src/commands/CreateLoggingConfigurationCommand.ts

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ export interface CreateLoggingConfigurationCommandOutput extends CreateLoggingCo
2828

2929
/**
3030
* @public
31-
* Create logging configuration.
31+
* <p>The <code>CreateLoggingConfiguration</code> operation creates a logging configuration
32+
* for the workspace. Use this operation to set the CloudWatch log group to which
33+
* the logs will be published to.</p>
3234
* @example
3335
* Use a bare-bones client and the command you need to make an API call.
3436
* ```javascript
@@ -58,16 +60,17 @@ export interface CreateLoggingConfigurationCommandOutput extends CreateLoggingCo
5860
* @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
5961
*
6062
* @throws {@link AccessDeniedException} (client fault)
61-
* User does not have sufficient access to perform this action.
63+
* <p>You do not have sufficient access to perform this action.</p>
6264
*
6365
* @throws {@link InternalServerException} (server fault)
64-
* Unexpected error during processing of request.
66+
* <p>An unexpected error occurred during the processing of the request.</p>
6567
*
6668
* @throws {@link ResourceNotFoundException} (client fault)
67-
* Request references a resource which does not exist.
69+
* <p>The request references a resources that doesn't exist.</p>
6870
*
6971
* @throws {@link ValidationException} (client fault)
70-
* The input fails to satisfy the constraints specified by an AWS service.
72+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
73+
* service.</p>
7174
*
7275
* @throws {@link AmpServiceException}
7376
* <p>Base exception class for all service exceptions from Amp service.</p>

‎clients/client-amp/src/commands/CreateRuleGroupsNamespaceCommand.ts

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,11 @@ export interface CreateRuleGroupsNamespaceCommandOutput extends CreateRuleGroups
2828

2929
/**
3030
* @public
31-
* Create a rule group namespace.
31+
* <p>The <code>CreateRuleGroupsNamespace</code> operation creates a rule groups namespace
32+
* within a workspace. A rule groups namespace is associated with exactly one rules file. A
33+
* workspace can have multiple rule groups namespaces.</p>
34+
* <p>Use this operation only to create new rule groups namespaces. To update an existing
35+
* rule groups namespace, use <code>PutRuleGroupsNamespace</code>.</p>
3236
* @example
3337
* Use a bare-bones client and the command you need to make an API call.
3438
* ```javascript
@@ -67,25 +71,26 @@ export interface CreateRuleGroupsNamespaceCommandOutput extends CreateRuleGroups
6771
* @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
6872
*
6973
* @throws {@link AccessDeniedException} (client fault)
70-
* User does not have sufficient access to perform this action.
74+
* <p>You do not have sufficient access to perform this action.</p>
7175
*
7276
* @throws {@link ConflictException} (client fault)
73-
* Updating or deleting a resource can cause an inconsistent state.
77+
* <p>The request would cause an inconsistent state.</p>
7478
*
7579
* @throws {@link InternalServerException} (server fault)
76-
* Unexpected error during processing of request.
80+
* <p>An unexpected error occurred during the processing of the request.</p>
7781
*
7882
* @throws {@link ResourceNotFoundException} (client fault)
79-
* Request references a resource which does not exist.
83+
* <p>The request references a resources that doesn't exist.</p>
8084
*
8185
* @throws {@link ServiceQuotaExceededException} (client fault)
82-
* Request would cause a service quota to be exceeded.
86+
* <p>Completing the request would cause a service quota to be exceeded.</p>
8387
*
8488
* @throws {@link ThrottlingException} (client fault)
85-
* Request was denied due to request throttling.
89+
* <p>The request was denied due to request throttling.</p>
8690
*
8791
* @throws {@link ValidationException} (client fault)
88-
* The input fails to satisfy the constraints specified by an AWS service.
92+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
93+
* service.</p>
8994
*
9095
* @throws {@link AmpServiceException}
9196
* <p>Base exception class for all service exceptions from Amp service.</p>

‎clients/client-amp/src/commands/CreateScraperCommand.ts

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,24 @@ export interface CreateScraperCommandOutput extends CreateScraperResponse, __Met
2828

2929
/**
3030
* @public
31-
* Create a scraper.
31+
* <p>The <code>CreateScraper</code> operation creates a scraper to collect metrics. A
32+
* scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS
33+
* cluster, and sends them to your Amazon Managed Service for Prometheus workspace. You can configure the
34+
* scraper to control what metrics are collected, and what transformations are applied
35+
* prior to sending them to your workspace.</p>
36+
* <p>If needed, an IAM role will be created for you that gives Amazon Managed Service for Prometheus access to the metrics in your cluster. For more information, see
37+
* <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/using-service-linked-roles.html#using-service-linked-roles-prom-scraper">Using roles for scraping metrics from EKS</a> in the <i>Amazon Managed Service for Prometheus User
38+
* Guide</i>.</p>
39+
* <p>You cannot update a scraper. If you want to change the configuration of the scraper,
40+
* create a new scraper and delete the old one.</p>
41+
* <p>The <code>scrapeConfiguration</code> parameter contains the base64-encoded version of
42+
* the YAML configuration file.</p>
43+
* <note>
44+
* <p>For more information about collectors, including what metrics are collected, and
45+
* how to configure the scraper, see <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector.html">Amazon Web Services managed
46+
* collectors</a> in the <i>Amazon Managed Service for Prometheus User
47+
* Guide</i>.</p>
48+
* </note>
3249
* @example
3350
* Use a bare-bones client and the command you need to make an API call.
3451
* ```javascript
@@ -83,25 +100,26 @@ export interface CreateScraperCommandOutput extends CreateScraperResponse, __Met
83100
* @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
84101
*
85102
* @throws {@link AccessDeniedException} (client fault)
86-
* User does not have sufficient access to perform this action.
103+
* <p>You do not have sufficient access to perform this action.</p>
87104
*
88105
* @throws {@link ConflictException} (client fault)
89-
* Updating or deleting a resource can cause an inconsistent state.
106+
* <p>The request would cause an inconsistent state.</p>
90107
*
91108
* @throws {@link InternalServerException} (server fault)
92-
* Unexpected error during processing of request.
109+
* <p>An unexpected error occurred during the processing of the request.</p>
93110
*
94111
* @throws {@link ResourceNotFoundException} (client fault)
95-
* Request references a resource which does not exist.
112+
* <p>The request references a resources that doesn't exist.</p>
96113
*
97114
* @throws {@link ServiceQuotaExceededException} (client fault)
98-
* Request would cause a service quota to be exceeded.
115+
* <p>Completing the request would cause a service quota to be exceeded.</p>
99116
*
100117
* @throws {@link ThrottlingException} (client fault)
101-
* Request was denied due to request throttling.
118+
* <p>The request was denied due to request throttling.</p>
102119
*
103120
* @throws {@link ValidationException} (client fault)
104-
* The input fails to satisfy the constraints specified by an AWS service.
121+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
122+
* service.</p>
105123
*
106124
* @throws {@link AmpServiceException}
107125
* <p>Base exception class for all service exceptions from Amp service.</p>

‎clients/client-amp/src/commands/CreateWorkspaceCommand.ts

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ export interface CreateWorkspaceCommandOutput extends CreateWorkspaceResponse, _
2828

2929
/**
3030
* @public
31-
* Creates a new AMP workspace.
31+
* <p>Creates a Prometheus workspace. A workspace is a logical space dedicated to the
32+
* storage and querying of Prometheus metrics. You can have one or more workspaces in each
33+
* Region in your account.</p>
3234
* @example
3335
* Use a bare-bones client and the command you need to make an API call.
3436
* ```javascript
@@ -66,22 +68,23 @@ export interface CreateWorkspaceCommandOutput extends CreateWorkspaceResponse, _
6668
* @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
6769
*
6870
* @throws {@link AccessDeniedException} (client fault)
69-
* User does not have sufficient access to perform this action.
71+
* <p>You do not have sufficient access to perform this action.</p>
7072
*
7173
* @throws {@link ConflictException} (client fault)
72-
* Updating or deleting a resource can cause an inconsistent state.
74+
* <p>The request would cause an inconsistent state.</p>
7375
*
7476
* @throws {@link InternalServerException} (server fault)
75-
* Unexpected error during processing of request.
77+
* <p>An unexpected error occurred during the processing of the request.</p>
7678
*
7779
* @throws {@link ServiceQuotaExceededException} (client fault)
78-
* Request would cause a service quota to be exceeded.
80+
* <p>Completing the request would cause a service quota to be exceeded.</p>
7981
*
8082
* @throws {@link ThrottlingException} (client fault)
81-
* Request was denied due to request throttling.
83+
* <p>The request was denied due to request throttling.</p>
8284
*
8385
* @throws {@link ValidationException} (client fault)
84-
* The input fails to satisfy the constraints specified by an AWS service.
86+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
87+
* service.</p>
8588
*
8689
* @throws {@link AmpServiceException}
8790
* <p>Base exception class for all service exceptions from Amp service.</p>

‎clients/client-amp/src/commands/DeleteAlertManagerDefinitionCommand.ts

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export interface DeleteAlertManagerDefinitionCommandOutput extends __MetadataBea
3131

3232
/**
3333
* @public
34-
* Deletes an alert manager definition.
34+
* <p>Deletes the alert manager definition from a workspace.</p>
3535
* @example
3636
* Use a bare-bones client and the command you need to make an API call.
3737
* ```javascript
@@ -55,22 +55,23 @@ export interface DeleteAlertManagerDefinitionCommandOutput extends __MetadataBea
5555
* @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
5656
*
5757
* @throws {@link AccessDeniedException} (client fault)
58-
* User does not have sufficient access to perform this action.
58+
* <p>You do not have sufficient access to perform this action.</p>
5959
*
6060
* @throws {@link ConflictException} (client fault)
61-
* Updating or deleting a resource can cause an inconsistent state.
61+
* <p>The request would cause an inconsistent state.</p>
6262
*
6363
* @throws {@link InternalServerException} (server fault)
64-
* Unexpected error during processing of request.
64+
* <p>An unexpected error occurred during the processing of the request.</p>
6565
*
6666
* @throws {@link ResourceNotFoundException} (client fault)
67-
* Request references a resource which does not exist.
67+
* <p>The request references a resources that doesn't exist.</p>
6868
*
6969
* @throws {@link ThrottlingException} (client fault)
70-
* Request was denied due to request throttling.
70+
* <p>The request was denied due to request throttling.</p>
7171
*
7272
* @throws {@link ValidationException} (client fault)
73-
* The input fails to satisfy the constraints specified by an AWS service.
73+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
74+
* service.</p>
7475
*
7576
* @throws {@link AmpServiceException}
7677
* <p>Base exception class for all service exceptions from Amp service.</p>

‎clients/client-amp/src/commands/DeleteLoggingConfigurationCommand.ts

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface DeleteLoggingConfigurationCommandOutput extends __MetadataBeare
2828

2929
/**
3030
* @public
31-
* Delete logging configuration.
31+
* <p>Deletes the logging configuration for a workspace.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript
@@ -52,19 +52,20 @@ export interface DeleteLoggingConfigurationCommandOutput extends __MetadataBeare
5252
* @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
5353
*
5454
* @throws {@link AccessDeniedException} (client fault)
55-
* User does not have sufficient access to perform this action.
55+
* <p>You do not have sufficient access to perform this action.</p>
5656
*
5757
* @throws {@link ConflictException} (client fault)
58-
* Updating or deleting a resource can cause an inconsistent state.
58+
* <p>The request would cause an inconsistent state.</p>
5959
*
6060
* @throws {@link InternalServerException} (server fault)
61-
* Unexpected error during processing of request.
61+
* <p>An unexpected error occurred during the processing of the request.</p>
6262
*
6363
* @throws {@link ResourceNotFoundException} (client fault)
64-
* Request references a resource which does not exist.
64+
* <p>The request references a resources that doesn't exist.</p>
6565
*
6666
* @throws {@link ValidationException} (client fault)
67-
* The input fails to satisfy the constraints specified by an AWS service.
67+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
68+
* service.</p>
6869
*
6970
* @throws {@link AmpServiceException}
7071
* <p>Base exception class for all service exceptions from Amp service.</p>

0 commit comments

Comments
 (0)