docs(client-amp): Overall documentation updates.

aws · Feb 9, 2024 · 1b75f97 · 1b75f97
1 parent 022ccd4
commit 1b75f97
Show file tree

Hide file tree

Showing 32 changed files with 1,024 additions and 768 deletions.
diff --git a/clients/client-amp/README.md b/clients/client-amp/README.md
@@ -6,7 +6,24 @@
 
 AWS SDK for JavaScript Amp Client for Node.js, Browser and React Native.
 
-Amazon Managed Service for Prometheus
+<p>Amazon Managed Service for Prometheus is a serverless, Prometheus-compatible monitoring service for
+container metrics that makes it easier to securely monitor container environments at
+scale. With Amazon Managed Service for Prometheus, you can use the same open-source Prometheus data
+model and query language that you use today to monitor the performance of your
+containerized workloads, and also enjoy improved scalability, availability, and security
+without having to manage the underlying infrastructure.</p>
+<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>
+<p>Amazon Managed Service for Prometheus includes two APIs.</p>
+<ul>
+<li>
+<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
+managers.</p>
+</li>
+<li>
+<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
+workspace.</p>
+</li>
+</ul>
 
 ## Installing
 

diff --git a/clients/client-amp/src/Amp.ts b/clients/client-amp/src/Amp.ts
@@ -563,7 +563,24 @@ export interface Amp {
 
 /**
  * @public
- * Amazon Managed Service for Prometheus
+ * <p>Amazon Managed Service for Prometheus is a serverless, Prometheus-compatible monitoring service for
+ *             container metrics that makes it easier to securely monitor container environments at
+ *             scale. With Amazon Managed Service for Prometheus, you can use the same open-source Prometheus data
+ *             model and query language that you use today to monitor the performance of your
+ *             containerized workloads, and also enjoy improved scalability, availability, and security
+ *             without having to manage the underlying infrastructure.</p>
+ *          <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>
+ *          <p>Amazon Managed Service for Prometheus includes two APIs.</p>
+ *          <ul>
+ *             <li>
+ *                <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
+ *                     managers.</p>
+ *             </li>
+ *             <li>
+ *                <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
+ *                     workspace.</p>
+ *             </li>
+ *          </ul>
  */
 export class Amp extends AmpClient implements Amp {}
 createAggregatedClient(commands, Amp);
diff --git a/clients/client-amp/src/AmpClient.ts b/clients/client-amp/src/AmpClient.ts
@@ -367,7 +367,24 @@ export interface AmpClientResolvedConfig extends AmpClientResolvedConfigType {}
 
 /**
  * @public
- * Amazon Managed Service for Prometheus
+ * <p>Amazon Managed Service for Prometheus is a serverless, Prometheus-compatible monitoring service for
+ *             container metrics that makes it easier to securely monitor container environments at
+ *             scale. With Amazon Managed Service for Prometheus, you can use the same open-source Prometheus data
+ *             model and query language that you use today to monitor the performance of your
+ *             containerized workloads, and also enjoy improved scalability, availability, and security
+ *             without having to manage the underlying infrastructure.</p>
+ *          <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>
+ *          <p>Amazon Managed Service for Prometheus includes two APIs.</p>
+ *          <ul>
+ *             <li>
+ *                <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
+ *                     managers.</p>
+ *             </li>
+ *             <li>
+ *                <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
+ *                     workspace.</p>
+ *             </li>
+ *          </ul>
  */
 export class AmpClient extends __Client<
   __HttpHandlerOptions,

diff --git a/clients/client-amp/src/commands/CreateAlertManagerDefinitionCommand.ts b/clients/client-amp/src/commands/CreateAlertManagerDefinitionCommand.ts
@@ -33,7 +33,10 @@ export interface CreateAlertManagerDefinitionCommandOutput
 
 /**
  * @public
- * Create an alert manager definition.
+ * <p>The <code>CreateAlertManagerDefinition</code> operation creates the alert manager
+ *             definition in a workspace. If a workspace already has an alert manager definition, don't
+ *             use this operation to update it. Instead, use
+ *             <code>PutAlertManagerDefinition</code>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -63,25 +66,26 @@ export interface CreateAlertManagerDefinitionCommandOutput
  * @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
  *
  * @throws {@link AccessDeniedException} (client fault)
- *  User does not have sufficient access to perform this action.
+ *  <p>You do not have sufficient access to perform this action.</p>
  *
  * @throws {@link ConflictException} (client fault)
- *  Updating or deleting a resource can cause an inconsistent state.
+ *  <p>The request would cause an inconsistent state.</p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  Unexpected error during processing of request.
+ *  <p>An unexpected error occurred during the processing of the request.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  Request references a resource which does not exist.
+ *  <p>The request references a resources that doesn't exist.</p>
  *
  * @throws {@link ServiceQuotaExceededException} (client fault)
- *  Request would cause a service quota to be exceeded.
+ *  <p>Completing the request would cause a service quota to be exceeded.</p>
  *
  * @throws {@link ThrottlingException} (client fault)
- *  Request was denied due to request throttling.
+ *  <p>The request was denied due to request throttling.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  The input fails to satisfy the constraints specified by an AWS service.
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services
+ *             service.</p>
  *
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>

diff --git a/clients/client-amp/src/commands/CreateLoggingConfigurationCommand.ts b/clients/client-amp/src/commands/CreateLoggingConfigurationCommand.ts
@@ -28,7 +28,9 @@ export interface CreateLoggingConfigurationCommandOutput extends CreateLoggingCo
 
 /**
  * @public
- * Create logging configuration.
+ * <p>The <code>CreateLoggingConfiguration</code> operation creates a logging configuration
+ *             for the workspace. Use this operation to set the CloudWatch log group to which
+ *             the logs will be published to.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -58,16 +60,17 @@ export interface CreateLoggingConfigurationCommandOutput extends CreateLoggingCo
  * @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
  *
  * @throws {@link AccessDeniedException} (client fault)
- *  User does not have sufficient access to perform this action.
+ *  <p>You do not have sufficient access to perform this action.</p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  Unexpected error during processing of request.
+ *  <p>An unexpected error occurred during the processing of the request.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  Request references a resource which does not exist.
+ *  <p>The request references a resources that doesn't exist.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  The input fails to satisfy the constraints specified by an AWS service.
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services
+ *             service.</p>
  *
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>

diff --git a/clients/client-amp/src/commands/CreateRuleGroupsNamespaceCommand.ts b/clients/client-amp/src/commands/CreateRuleGroupsNamespaceCommand.ts
@@ -28,7 +28,11 @@ export interface CreateRuleGroupsNamespaceCommandOutput extends CreateRuleGroups
 
 /**
  * @public
- * Create a rule group namespace.
+ * <p>The <code>CreateRuleGroupsNamespace</code> operation creates a rule groups namespace
+ *             within a workspace. A rule groups namespace is associated with exactly one rules file. A
+ *             workspace can have multiple rule groups namespaces.</p>
+ *          <p>Use this operation only to create new rule groups namespaces. To update an existing
+ *             rule groups namespace, use <code>PutRuleGroupsNamespace</code>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -67,25 +71,26 @@ export interface CreateRuleGroupsNamespaceCommandOutput extends CreateRuleGroups
  * @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
  *
  * @throws {@link AccessDeniedException} (client fault)
- *  User does not have sufficient access to perform this action.
+ *  <p>You do not have sufficient access to perform this action.</p>
  *
  * @throws {@link ConflictException} (client fault)
- *  Updating or deleting a resource can cause an inconsistent state.
+ *  <p>The request would cause an inconsistent state.</p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  Unexpected error during processing of request.
+ *  <p>An unexpected error occurred during the processing of the request.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  Request references a resource which does not exist.
+ *  <p>The request references a resources that doesn't exist.</p>
  *
  * @throws {@link ServiceQuotaExceededException} (client fault)
- *  Request would cause a service quota to be exceeded.
+ *  <p>Completing the request would cause a service quota to be exceeded.</p>
  *
  * @throws {@link ThrottlingException} (client fault)
- *  Request was denied due to request throttling.
+ *  <p>The request was denied due to request throttling.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  The input fails to satisfy the constraints specified by an AWS service.
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services
+ *             service.</p>
  *
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>

diff --git a/clients/client-amp/src/commands/CreateScraperCommand.ts b/clients/client-amp/src/commands/CreateScraperCommand.ts
@@ -28,7 +28,24 @@ export interface CreateScraperCommandOutput extends CreateScraperResponse, __Met
 
 /**
  * @public
- * Create a scraper.
+ * <p>The <code>CreateScraper</code> operation creates a scraper to collect metrics. A
+ *             scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS
+ *             cluster, and sends them to your Amazon Managed Service for Prometheus workspace. You can configure the
+ *             scraper to control what metrics are collected, and what transformations are applied
+ *             prior to sending them to your workspace.</p>
+ *          <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
+ *             <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
+ *                     Guide</i>.</p>
+ *          <p>You cannot update a scraper. If you want to change the configuration of the scraper,
+ *             create a new scraper and delete the old one.</p>
+ *          <p>The <code>scrapeConfiguration</code> parameter contains the base64-encoded version of
+ *             the YAML configuration file.</p>
+ *          <note>
+ *             <p>For more information about collectors, including what metrics are collected, and
+ *                 how to configure the scraper, see <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector.html">Amazon Web Services managed
+ *                     collectors</a> in the <i>Amazon Managed Service for Prometheus User
+ *                         Guide</i>.</p>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -83,25 +100,26 @@ export interface CreateScraperCommandOutput extends CreateScraperResponse, __Met
  * @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
  *
  * @throws {@link AccessDeniedException} (client fault)
- *  User does not have sufficient access to perform this action.
+ *  <p>You do not have sufficient access to perform this action.</p>
  *
  * @throws {@link ConflictException} (client fault)
- *  Updating or deleting a resource can cause an inconsistent state.
+ *  <p>The request would cause an inconsistent state.</p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  Unexpected error during processing of request.
+ *  <p>An unexpected error occurred during the processing of the request.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  Request references a resource which does not exist.
+ *  <p>The request references a resources that doesn't exist.</p>
  *
  * @throws {@link ServiceQuotaExceededException} (client fault)
- *  Request would cause a service quota to be exceeded.
+ *  <p>Completing the request would cause a service quota to be exceeded.</p>
  *
  * @throws {@link ThrottlingException} (client fault)
- *  Request was denied due to request throttling.
+ *  <p>The request was denied due to request throttling.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  The input fails to satisfy the constraints specified by an AWS service.
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services
+ *             service.</p>
  *
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>

diff --git a/clients/client-amp/src/commands/CreateWorkspaceCommand.ts b/clients/client-amp/src/commands/CreateWorkspaceCommand.ts
@@ -28,7 +28,9 @@ export interface CreateWorkspaceCommandOutput extends CreateWorkspaceResponse, _
 
 /**
  * @public
- * Creates a new AMP workspace.
+ * <p>Creates a Prometheus workspace. A workspace is a logical space dedicated to the
+ *             storage and querying of Prometheus metrics. You can have one or more workspaces in each
+ *             Region in your account.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -66,22 +68,23 @@ export interface CreateWorkspaceCommandOutput extends CreateWorkspaceResponse, _
  * @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
  *
  * @throws {@link AccessDeniedException} (client fault)
- *  User does not have sufficient access to perform this action.
+ *  <p>You do not have sufficient access to perform this action.</p>
  *
  * @throws {@link ConflictException} (client fault)
- *  Updating or deleting a resource can cause an inconsistent state.
+ *  <p>The request would cause an inconsistent state.</p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  Unexpected error during processing of request.
+ *  <p>An unexpected error occurred during the processing of the request.</p>
  *
  * @throws {@link ServiceQuotaExceededException} (client fault)
- *  Request would cause a service quota to be exceeded.
+ *  <p>Completing the request would cause a service quota to be exceeded.</p>
  *
  * @throws {@link ThrottlingException} (client fault)
- *  Request was denied due to request throttling.
+ *  <p>The request was denied due to request throttling.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  The input fails to satisfy the constraints specified by an AWS service.
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services
+ *             service.</p>
  *
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>

diff --git a/clients/client-amp/src/commands/DeleteAlertManagerDefinitionCommand.ts b/clients/client-amp/src/commands/DeleteAlertManagerDefinitionCommand.ts
@@ -31,7 +31,7 @@ export interface DeleteAlertManagerDefinitionCommandOutput extends __MetadataBea
 
 /**
  * @public
- * Deletes an alert manager definition.
+ * <p>Deletes the alert manager definition from a workspace.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -55,22 +55,23 @@ export interface DeleteAlertManagerDefinitionCommandOutput extends __MetadataBea
  * @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
  *
  * @throws {@link AccessDeniedException} (client fault)
- *  User does not have sufficient access to perform this action.
+ *  <p>You do not have sufficient access to perform this action.</p>
  *
  * @throws {@link ConflictException} (client fault)
- *  Updating or deleting a resource can cause an inconsistent state.
+ *  <p>The request would cause an inconsistent state.</p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  Unexpected error during processing of request.
+ *  <p>An unexpected error occurred during the processing of the request.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  Request references a resource which does not exist.
+ *  <p>The request references a resources that doesn't exist.</p>
  *
  * @throws {@link ThrottlingException} (client fault)
- *  Request was denied due to request throttling.
+ *  <p>The request was denied due to request throttling.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  The input fails to satisfy the constraints specified by an AWS service.
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services
+ *             service.</p>
  *
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>

diff --git a/clients/client-amp/src/commands/DeleteLoggingConfigurationCommand.ts b/clients/client-amp/src/commands/DeleteLoggingConfigurationCommand.ts
@@ -28,7 +28,7 @@ export interface DeleteLoggingConfigurationCommandOutput extends __MetadataBeare
 
 /**
  * @public
- * Delete logging configuration.
+ * <p>Deletes the logging configuration for a workspace.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -52,19 +52,20 @@ export interface DeleteLoggingConfigurationCommandOutput extends __MetadataBeare
  * @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
  *
  * @throws {@link AccessDeniedException} (client fault)
- *  User does not have sufficient access to perform this action.
+ *  <p>You do not have sufficient access to perform this action.</p>
  *
  * @throws {@link ConflictException} (client fault)
- *  Updating or deleting a resource can cause an inconsistent state.
+ *  <p>The request would cause an inconsistent state.</p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  Unexpected error during processing of request.
+ *  <p>An unexpected error occurred during the processing of the request.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  Request references a resource which does not exist.
+ *  <p>The request references a resources that doesn't exist.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  The input fails to satisfy the constraints specified by an AWS service.
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services
+ *             service.</p>
  *
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>