@aws-sdk/client-amp 3.509.0 → 3.511.0

package/dist-types/commands/DescribeScraperCommand.d.ts

@@ -26,7 +26,8 @@ declare const DescribeScraperCommand_base: {
 };
 /**
  * @public
- * Describe an existing scraper.
+ * <p>The <code>DescribeScraper</code> operation displays information about an existing
+ *             scraper.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -84,19 +85,20 @@ declare const DescribeScraperCommand_base: {
  * @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 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>

package/dist-types/commands/DescribeWorkspaceCommand.d.ts

@@ -26,7 +26,7 @@ declare const DescribeWorkspaceCommand_base: {
 };
 /**
  * @public
- * Describes an existing AMP workspace.
+ * <p>Returns information about an existing workspace. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -64,19 +64,20 @@ declare const DescribeWorkspaceCommand_base: {
  * @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 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>

package/dist-types/commands/GetDefaultScraperConfigurationCommand.d.ts

@@ -26,7 +26,8 @@ declare const GetDefaultScraperConfigurationCommand_base: {
 };
 /**
  * @public
- * Gets a default configuration.
+ * <p>The <code>GetDefaultScraperConfiguration</code> operation returns the default
+ *             scraper configuration used when Amazon EKS creates a scraper for you.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -49,13 +50,13 @@ declare const GetDefaultScraperConfigurationCommand_base: {
  * @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 ThrottlingException} (client fault)
- *  Request was denied due to request throttling.
+ *  <p>The request was denied due to request throttling.</p>
  *
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>

package/dist-types/commands/ListRuleGroupsNamespacesCommand.d.ts

@@ -26,7 +26,7 @@ declare const ListRuleGroupsNamespacesCommand_base: {
 };
 /**
  * @public
- * Lists rule groups namespaces.
+ * <p>Returns a list of rule groups namespaces in a workspace.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -69,19 +69,20 @@ declare const ListRuleGroupsNamespacesCommand_base: {
  * @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 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>

package/dist-types/commands/ListScrapersCommand.d.ts

@@ -26,7 +26,9 @@ declare const ListScrapersCommand_base: {
 };
 /**
  * @public
- * Lists all scrapers in a customer account, including scrapers being created or deleted. You may provide filters to return a more specific list of results.
+ * <p>The <code>ListScrapers</code> operation lists all of the scrapers in
+ *             your account. This includes scrapers being created or deleted. You can optionally
+ *             filter the returned list.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -90,16 +92,17 @@ declare const ListScrapersCommand_base: {
  * @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 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>

package/dist-types/commands/ListTagsForResourceCommand.d.ts

@@ -26,7 +26,9 @@ declare const ListTagsForResourceCommand_base: {
 };
 /**
  * @public
- * Lists the tags you have assigned to the resource.
+ * <p>The <code>ListTagsForResource</code> operation returns the tags that are associated
+ *             with an Amazon Managed Service for Prometheus resource. Currently, the only resources that can be
+ *             tagged are workspaces and rule groups namespaces. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -53,19 +55,20 @@ declare const ListTagsForResourceCommand_base: {
  * @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 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>

package/dist-types/commands/ListWorkspacesCommand.d.ts

@@ -26,7 +26,8 @@ declare const ListWorkspacesCommand_base: {
 };
 /**
  * @public
- * Lists all AMP workspaces, including workspaces being created or deleted.
+ * <p>Lists all of the Amazon Managed Service for Prometheus workspaces in your account. This includes
+ *             workspaces being created or deleted. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -68,16 +69,17 @@ declare const ListWorkspacesCommand_base: {
  * @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 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>

package/dist-types/commands/PutAlertManagerDefinitionCommand.d.ts

@@ -26,7 +26,9 @@ declare const PutAlertManagerDefinitionCommand_base: {
 };
 /**
  * @public
- * Update an alert manager definition.
+ * <p>Updates an existing alert manager definition in a workspace. If the workspace does not
+ *             already have an alert manager definition, don't use this operation to create it.
+ *             Instead, use <code>CreateAlertManagerDefinition</code>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -56,25 +58,26 @@ declare const PutAlertManagerDefinitionCommand_base: {
  * @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>

package/dist-types/commands/PutRuleGroupsNamespaceCommand.d.ts

@@ -26,7 +26,13 @@ declare const PutRuleGroupsNamespaceCommand_base: {
 };
 /**
  * @public
- * Update a rule groups namespace.
+ * <p>Updates an existing 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 update existing rule groups namespaces. To create a new
+ *             rule groups namespace, use <code>CreateRuleGroupsNamespace</code>.</p>
+ *          <p>You can't use this operation to add tags to an existing rule groups namespace.
+ *             Instead, use <code>TagResource</code>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -62,25 +68,26 @@ declare const PutRuleGroupsNamespaceCommand_base: {
  * @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>

package/dist-types/commands/TagResourceCommand.d.ts

@@ -26,7 +26,13 @@ declare const TagResourceCommand_base: {
 };
 /**
  * @public
- * Creates tags for the specified resource.
+ * <p>The <code>TagResource</code> operation associates tags with an Amazon Managed Service for Prometheus
+ *             resource. The only resources that can be tagged are workspaces and rule groups
+ *             namespaces. </p>
+ *          <p>If you specify a new tag key for the resource, this tag is appended to the list of
+ *             tags associated with the resource. If you specify a tag key that is already associated
+ *             with the resource, the new tag value that you specify replaces the previous value for
+ *             that tag.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -52,19 +58,20 @@ declare const TagResourceCommand_base: {
  * @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 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>

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -26,7 +26,8 @@ declare const UntagResourceCommand_base: {
 };
 /**
  * @public
- * Deletes tags from the specified resource.
+ * <p>Removes the specified tags from an Amazon Managed Service for Prometheus resource. The only resources
+ *             that can be tagged are workspaces and rule groups namespaces. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -52,19 +53,20 @@ declare const UntagResourceCommand_base: {
  * @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 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>

package/dist-types/commands/UpdateLoggingConfigurationCommand.d.ts

@@ -26,7 +26,8 @@ declare const UpdateLoggingConfigurationCommand_base: {
 };
 /**
  * @public
- * Update logging configuration.
+ * <p>Updates the log group ARN or the workspace ID of the current logging
+ *             configuration.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -56,19 +57,20 @@ declare const UpdateLoggingConfigurationCommand_base: {
  * @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>

package/dist-types/commands/UpdateWorkspaceAliasCommand.d.ts

@@ -26,7 +26,7 @@ declare const UpdateWorkspaceAliasCommand_base: {
 };
 /**
  * @public
- * Updates an AMP workspace alias.
+ * <p>Updates the alias of an existing workspace. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -51,25 +51,26 @@ declare const UpdateWorkspaceAliasCommand_base: {
  * @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>

package/dist-types/index.d.ts

@@ -1,5 +1,22 @@
 /**
- * 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>
  *
  * @packageDocumentation
  */