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.
+For more information about Amazon Managed Service for Prometheus, see the Amazon Managed Service for Prometheus User Guide.
+Amazon Managed Service for Prometheus includes two APIs.
+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.
+Use the Prometheus-compatible API to work within your Prometheus +workspace.
+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.
+ *For more information about Amazon Managed Service for Prometheus, see the Amazon Managed Service for Prometheus User Guide.
+ *Amazon Managed Service for Prometheus includes two APIs.
+ *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.
+ *Use the Prometheus-compatible API to work within your Prometheus + * workspace.
+ *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.
+ *For more information about Amazon Managed Service for Prometheus, see the Amazon Managed Service for Prometheus User Guide.
+ *Amazon Managed Service for Prometheus includes two APIs.
+ *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.
+ *Use the Prometheus-compatible API to work within your Prometheus + * workspace.
+ *The CreateAlertManagerDefinition 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
+ * PutAlertManagerDefinition.
You do not have sufficient access to perform this action.
* * @throws {@link ConflictException} (client fault) - * Updating or deleting a resource can cause an inconsistent state. + *The request would cause an inconsistent state.
* * @throws {@link InternalServerException} (server fault) - * Unexpected error during processing of request. + *An unexpected error occurred during the processing of the request.
* * @throws {@link ResourceNotFoundException} (client fault) - * Request references a resource which does not exist. + *The request references a resources that doesn't exist.
* * @throws {@link ServiceQuotaExceededException} (client fault) - * Request would cause a service quota to be exceeded. + *Completing the request would cause a service quota to be exceeded.
* * @throws {@link ThrottlingException} (client fault) - * Request was denied due to request throttling. + *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - * The input fails to satisfy the constraints specified by an AWS service. + *The input fails to satisfy the constraints specified by an Amazon Web Services + * service.
* * @throws {@link AmpServiceException} *Base exception class for all service exceptions from Amp service.
diff --git a/clients/client-amp/src/commands/CreateLoggingConfigurationCommand.ts b/clients/client-amp/src/commands/CreateLoggingConfigurationCommand.ts index bac0bbc976470..5de0ab3e6a4d3 100644 --- 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. + *The CreateLoggingConfiguration 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.
You do not have sufficient access to perform this action.
* * @throws {@link InternalServerException} (server fault) - * Unexpected error during processing of request. + *An unexpected error occurred during the processing of the request.
* * @throws {@link ResourceNotFoundException} (client fault) - * Request references a resource which does not exist. + *The request references a resources that doesn't exist.
* * @throws {@link ValidationException} (client fault) - * The input fails to satisfy the constraints specified by an AWS service. + *The input fails to satisfy the constraints specified by an Amazon Web Services + * service.
* * @throws {@link AmpServiceException} *Base exception class for all service exceptions from Amp service.
diff --git a/clients/client-amp/src/commands/CreateRuleGroupsNamespaceCommand.ts b/clients/client-amp/src/commands/CreateRuleGroupsNamespaceCommand.ts index 0aa327170bb8a..cca28e488294d 100644 --- 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. + *The CreateRuleGroupsNamespace 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.
Use this operation only to create new rule groups namespaces. To update an existing
+ * rule groups namespace, use PutRuleGroupsNamespace.
You do not have sufficient access to perform this action.
* * @throws {@link ConflictException} (client fault) - * Updating or deleting a resource can cause an inconsistent state. + *The request would cause an inconsistent state.
* * @throws {@link InternalServerException} (server fault) - * Unexpected error during processing of request. + *An unexpected error occurred during the processing of the request.
* * @throws {@link ResourceNotFoundException} (client fault) - * Request references a resource which does not exist. + *The request references a resources that doesn't exist.
* * @throws {@link ServiceQuotaExceededException} (client fault) - * Request would cause a service quota to be exceeded. + *Completing the request would cause a service quota to be exceeded.
* * @throws {@link ThrottlingException} (client fault) - * Request was denied due to request throttling. + *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - * The input fails to satisfy the constraints specified by an AWS service. + *The input fails to satisfy the constraints specified by an Amazon Web Services + * service.
* * @throws {@link AmpServiceException} *Base exception class for all service exceptions from Amp service.
diff --git a/clients/client-amp/src/commands/CreateScraperCommand.ts b/clients/client-amp/src/commands/CreateScraperCommand.ts index 5cd6d3256ba71..1dd0cd5d8ae0d 100644 --- 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. + *The CreateScraper 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.
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 + * Using roles for scraping metrics from EKS in the Amazon Managed Service for Prometheus User + * Guide.
+ *You cannot update a scraper. If you want to change the configuration of the scraper, + * create a new scraper and delete the old one.
+ *The scrapeConfiguration parameter contains the base64-encoded version of
+ * the YAML configuration file.
For more information about collectors, including what metrics are collected, and + * how to configure the scraper, see Amazon Web Services managed + * collectors in the Amazon Managed Service for Prometheus User + * Guide.
+ *You do not have sufficient access to perform this action.
* * @throws {@link ConflictException} (client fault) - * Updating or deleting a resource can cause an inconsistent state. + *The request would cause an inconsistent state.
* * @throws {@link InternalServerException} (server fault) - * Unexpected error during processing of request. + *An unexpected error occurred during the processing of the request.
* * @throws {@link ResourceNotFoundException} (client fault) - * Request references a resource which does not exist. + *The request references a resources that doesn't exist.
* * @throws {@link ServiceQuotaExceededException} (client fault) - * Request would cause a service quota to be exceeded. + *Completing the request would cause a service quota to be exceeded.
* * @throws {@link ThrottlingException} (client fault) - * Request was denied due to request throttling. + *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - * The input fails to satisfy the constraints specified by an AWS service. + *The input fails to satisfy the constraints specified by an Amazon Web Services + * service.
* * @throws {@link AmpServiceException} *Base exception class for all service exceptions from Amp service.
diff --git a/clients/client-amp/src/commands/CreateWorkspaceCommand.ts b/clients/client-amp/src/commands/CreateWorkspaceCommand.ts index 31d04443c5800..90f43fc5d6752 100644 --- 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. + *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.
* @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. + *You do not have sufficient access to perform this action.
* * @throws {@link ConflictException} (client fault) - * Updating or deleting a resource can cause an inconsistent state. + *The request would cause an inconsistent state.
* * @throws {@link InternalServerException} (server fault) - * Unexpected error during processing of request. + *An unexpected error occurred during the processing of the request.
* * @throws {@link ServiceQuotaExceededException} (client fault) - * Request would cause a service quota to be exceeded. + *Completing the request would cause a service quota to be exceeded.
* * @throws {@link ThrottlingException} (client fault) - * Request was denied due to request throttling. + *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - * The input fails to satisfy the constraints specified by an AWS service. + *The input fails to satisfy the constraints specified by an Amazon Web Services + * service.
* * @throws {@link AmpServiceException} *Base exception class for all service exceptions from Amp service.
diff --git a/clients/client-amp/src/commands/DeleteAlertManagerDefinitionCommand.ts b/clients/client-amp/src/commands/DeleteAlertManagerDefinitionCommand.ts index 704a5a1cde203..096e30b8cbf03 100644 --- 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. + *Deletes the alert manager definition from a workspace.
* @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. + *You do not have sufficient access to perform this action.
* * @throws {@link ConflictException} (client fault) - * Updating or deleting a resource can cause an inconsistent state. + *The request would cause an inconsistent state.
* * @throws {@link InternalServerException} (server fault) - * Unexpected error during processing of request. + *An unexpected error occurred during the processing of the request.
* * @throws {@link ResourceNotFoundException} (client fault) - * Request references a resource which does not exist. + *The request references a resources that doesn't exist.
* * @throws {@link ThrottlingException} (client fault) - * Request was denied due to request throttling. + *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - * The input fails to satisfy the constraints specified by an AWS service. + *The input fails to satisfy the constraints specified by an Amazon Web Services + * service.
* * @throws {@link AmpServiceException} *Base exception class for all service exceptions from Amp service.
diff --git a/clients/client-amp/src/commands/DeleteLoggingConfigurationCommand.ts b/clients/client-amp/src/commands/DeleteLoggingConfigurationCommand.ts index 9f519a08236dd..f3490e6f150f0 100644 --- 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. + *Deletes the logging configuration for a workspace.
* @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. + *You do not have sufficient access to perform this action.
* * @throws {@link ConflictException} (client fault) - * Updating or deleting a resource can cause an inconsistent state. + *The request would cause an inconsistent state.
* * @throws {@link InternalServerException} (server fault) - * Unexpected error during processing of request. + *An unexpected error occurred during the processing of the request.
* * @throws {@link ResourceNotFoundException} (client fault) - * Request references a resource which does not exist. + *The request references a resources that doesn't exist.
* * @throws {@link ValidationException} (client fault) - * The input fails to satisfy the constraints specified by an AWS service. + *The input fails to satisfy the constraints specified by an Amazon Web Services + * service.
* * @throws {@link AmpServiceException} *Base exception class for all service exceptions from Amp service.
diff --git a/clients/client-amp/src/commands/DeleteRuleGroupsNamespaceCommand.ts b/clients/client-amp/src/commands/DeleteRuleGroupsNamespaceCommand.ts index e6f9103276c5b..fab4aef0eebaf 100644 --- a/clients/client-amp/src/commands/DeleteRuleGroupsNamespaceCommand.ts +++ b/clients/client-amp/src/commands/DeleteRuleGroupsNamespaceCommand.ts @@ -28,7 +28,7 @@ export interface DeleteRuleGroupsNamespaceCommandOutput extends __MetadataBearer /** * @public - * Delete a rule groups namespace. + *Deletes one rule groups namespace and its associated rule groups definition.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -53,22 +53,23 @@ export interface DeleteRuleGroupsNamespaceCommandOutput extends __MetadataBearer * @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * User does not have sufficient access to perform this action. + *You do not have sufficient access to perform this action.
* * @throws {@link ConflictException} (client fault) - * Updating or deleting a resource can cause an inconsistent state. + *The request would cause an inconsistent state.
* * @throws {@link InternalServerException} (server fault) - * Unexpected error during processing of request. + *An unexpected error occurred during the processing of the request.
* * @throws {@link ResourceNotFoundException} (client fault) - * Request references a resource which does not exist. + *The request references a resources that doesn't exist.
* * @throws {@link ThrottlingException} (client fault) - * Request was denied due to request throttling. + *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - * The input fails to satisfy the constraints specified by an AWS service. + *The input fails to satisfy the constraints specified by an Amazon Web Services + * service.
* * @throws {@link AmpServiceException} *Base exception class for all service exceptions from Amp service.
diff --git a/clients/client-amp/src/commands/DeleteScraperCommand.ts b/clients/client-amp/src/commands/DeleteScraperCommand.ts index 5328a9a8d002a..a2efa83afe485 100644 --- a/clients/client-amp/src/commands/DeleteScraperCommand.ts +++ b/clients/client-amp/src/commands/DeleteScraperCommand.ts @@ -28,7 +28,8 @@ export interface DeleteScraperCommandOutput extends DeleteScraperResponse, __Met /** * @public - * Deletes a scraper. + *The DeleteScraper operation deletes one scraper, and stops any metrics
+ * collection that the scraper performs.
You do not have sufficient access to perform this action.
* * @throws {@link ConflictException} (client fault) - * Updating or deleting a resource can cause an inconsistent state. + *The request would cause an inconsistent state.
* * @throws {@link InternalServerException} (server fault) - * Unexpected error during processing of request. + *An unexpected error occurred during the processing of the request.
* * @throws {@link ResourceNotFoundException} (client fault) - * Request references a resource which does not exist. + *The request references a resources that doesn't exist.
* * @throws {@link ThrottlingException} (client fault) - * Request was denied due to request throttling. + *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - * The input fails to satisfy the constraints specified by an AWS service. + *The input fails to satisfy the constraints specified by an Amazon Web Services + * service.
* * @throws {@link AmpServiceException} *Base exception class for all service exceptions from Amp service.
diff --git a/clients/client-amp/src/commands/DeleteWorkspaceCommand.ts b/clients/client-amp/src/commands/DeleteWorkspaceCommand.ts index 8b1a201d8352f..9362c14a6f61c 100644 --- a/clients/client-amp/src/commands/DeleteWorkspaceCommand.ts +++ b/clients/client-amp/src/commands/DeleteWorkspaceCommand.ts @@ -28,7 +28,11 @@ export interface DeleteWorkspaceCommandOutput extends __MetadataBearer {} /** * @public - * Deletes an AMP workspace. + *Deletes an existing workspace.
+ *When you delete a workspace, the data that has been ingested into it is not + * immediately deleted. It will be permanently deleted within one month.
+ *You do not have sufficient access to perform this action.
* * @throws {@link ConflictException} (client fault) - * Updating or deleting a resource can cause an inconsistent state. + *The request would cause an inconsistent state.
* * @throws {@link InternalServerException} (server fault) - * Unexpected error during processing of request. + *An unexpected error occurred during the processing of the request.
* * @throws {@link ResourceNotFoundException} (client fault) - * Request references a resource which does not exist. + *The request references a resources that doesn't exist.
* * @throws {@link ThrottlingException} (client fault) - * Request was denied due to request throttling. + *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - * The input fails to satisfy the constraints specified by an AWS service. + *The input fails to satisfy the constraints specified by an Amazon Web Services + * service.
* * @throws {@link AmpServiceException} *Base exception class for all service exceptions from Amp service.
diff --git a/clients/client-amp/src/commands/DescribeAlertManagerDefinitionCommand.ts b/clients/client-amp/src/commands/DescribeAlertManagerDefinitionCommand.ts index ab7b7f853200d..5d7f2dc5cc125 100644 --- a/clients/client-amp/src/commands/DescribeAlertManagerDefinitionCommand.ts +++ b/clients/client-amp/src/commands/DescribeAlertManagerDefinitionCommand.ts @@ -33,7 +33,8 @@ export interface DescribeAlertManagerDefinitionCommandOutput /** * @public - * Describes an alert manager definition. + *Retrieves the full information about the alert manager definition for a + * workspace.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -66,19 +67,20 @@ export interface DescribeAlertManagerDefinitionCommandOutput * @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * User does not have sufficient access to perform this action. + *You do not have sufficient access to perform this action.
* * @throws {@link InternalServerException} (server fault) - * Unexpected error during processing of request. + *An unexpected error occurred during the processing of the request.
* * @throws {@link ResourceNotFoundException} (client fault) - * Request references a resource which does not exist. + *The request references a resources that doesn't exist.
* * @throws {@link ThrottlingException} (client fault) - * Request was denied due to request throttling. + *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - * The input fails to satisfy the constraints specified by an AWS service. + *The input fails to satisfy the constraints specified by an Amazon Web Services + * service.
* * @throws {@link AmpServiceException} *Base exception class for all service exceptions from Amp service.
diff --git a/clients/client-amp/src/commands/DescribeLoggingConfigurationCommand.ts b/clients/client-amp/src/commands/DescribeLoggingConfigurationCommand.ts index 3b58803a3b645..d5d0f635d3500 100644 --- a/clients/client-amp/src/commands/DescribeLoggingConfigurationCommand.ts +++ b/clients/client-amp/src/commands/DescribeLoggingConfigurationCommand.ts @@ -33,7 +33,8 @@ export interface DescribeLoggingConfigurationCommandOutput /** * @public - * Describes logging configuration. + *Returns complete information about the current logging configuration of the + * workspace.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -67,16 +68,17 @@ export interface DescribeLoggingConfigurationCommandOutput * @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * User does not have sufficient access to perform this action. + *You do not have sufficient access to perform this action.
* * @throws {@link InternalServerException} (server fault) - * Unexpected error during processing of request. + *An unexpected error occurred during the processing of the request.
* * @throws {@link ResourceNotFoundException} (client fault) - * Request references a resource which does not exist. + *The request references a resources that doesn't exist.
* * @throws {@link ValidationException} (client fault) - * The input fails to satisfy the constraints specified by an AWS service. + *The input fails to satisfy the constraints specified by an Amazon Web Services + * service.
* * @throws {@link AmpServiceException} *Base exception class for all service exceptions from Amp service.
diff --git a/clients/client-amp/src/commands/DescribeRuleGroupsNamespaceCommand.ts b/clients/client-amp/src/commands/DescribeRuleGroupsNamespaceCommand.ts index c6238915abe27..2ed1e04b6e711 100644 --- a/clients/client-amp/src/commands/DescribeRuleGroupsNamespaceCommand.ts +++ b/clients/client-amp/src/commands/DescribeRuleGroupsNamespaceCommand.ts @@ -33,7 +33,8 @@ export interface DescribeRuleGroupsNamespaceCommandOutput /** * @public - * Describe a rule groups namespace. + *Returns complete information about one rule groups namespace. To retrieve a list of
+ * rule groups namespaces, use ListRuleGroupsNamespaces.
You do not have sufficient access to perform this action.
* * @throws {@link InternalServerException} (server fault) - * Unexpected error during processing of request. + *An unexpected error occurred during the processing of the request.
* * @throws {@link ResourceNotFoundException} (client fault) - * Request references a resource which does not exist. + *The request references a resources that doesn't exist.
* * @throws {@link ThrottlingException} (client fault) - * Request was denied due to request throttling. + *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - * The input fails to satisfy the constraints specified by an AWS service. + *The input fails to satisfy the constraints specified by an Amazon Web Services + * service.
* * @throws {@link AmpServiceException} *Base exception class for all service exceptions from Amp service.
diff --git a/clients/client-amp/src/commands/DescribeScraperCommand.ts b/clients/client-amp/src/commands/DescribeScraperCommand.ts index d6bbd5a0c8cbe..edc6100bc2c90 100644 --- a/clients/client-amp/src/commands/DescribeScraperCommand.ts +++ b/clients/client-amp/src/commands/DescribeScraperCommand.ts @@ -28,7 +28,8 @@ export interface DescribeScraperCommandOutput extends DescribeScraperResponse, _ /** * @public - * Describe an existing scraper. + *The DescribeScraper operation displays information about an existing
+ * scraper.
You do not have sufficient access to perform this action.
* * @throws {@link InternalServerException} (server fault) - * Unexpected error during processing of request. + *An unexpected error occurred during the processing of the request.
* * @throws {@link ResourceNotFoundException} (client fault) - * Request references a resource which does not exist. + *The request references a resources that doesn't exist.
* * @throws {@link ThrottlingException} (client fault) - * Request was denied due to request throttling. + *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - * The input fails to satisfy the constraints specified by an AWS service. + *The input fails to satisfy the constraints specified by an Amazon Web Services + * service.
* * @throws {@link AmpServiceException} *Base exception class for all service exceptions from Amp service.
diff --git a/clients/client-amp/src/commands/DescribeWorkspaceCommand.ts b/clients/client-amp/src/commands/DescribeWorkspaceCommand.ts index 74582b6b86cd0..ecccd3716c973 100644 --- a/clients/client-amp/src/commands/DescribeWorkspaceCommand.ts +++ b/clients/client-amp/src/commands/DescribeWorkspaceCommand.ts @@ -28,7 +28,7 @@ export interface DescribeWorkspaceCommandOutput extends DescribeWorkspaceRespons /** * @public - * Describes an existing AMP workspace. + *Returns information about an existing workspace.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -66,19 +66,20 @@ export interface DescribeWorkspaceCommandOutput extends DescribeWorkspaceRespons * @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * User does not have sufficient access to perform this action. + *You do not have sufficient access to perform this action.
* * @throws {@link InternalServerException} (server fault) - * Unexpected error during processing of request. + *An unexpected error occurred during the processing of the request.
* * @throws {@link ResourceNotFoundException} (client fault) - * Request references a resource which does not exist. + *The request references a resources that doesn't exist.
* * @throws {@link ThrottlingException} (client fault) - * Request was denied due to request throttling. + *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - * The input fails to satisfy the constraints specified by an AWS service. + *The input fails to satisfy the constraints specified by an Amazon Web Services + * service.
* * @throws {@link AmpServiceException} *Base exception class for all service exceptions from Amp service.
diff --git a/clients/client-amp/src/commands/GetDefaultScraperConfigurationCommand.ts b/clients/client-amp/src/commands/GetDefaultScraperConfigurationCommand.ts index b29b5007f2d83..c942ea4423ed0 100644 --- a/clients/client-amp/src/commands/GetDefaultScraperConfigurationCommand.ts +++ b/clients/client-amp/src/commands/GetDefaultScraperConfigurationCommand.ts @@ -33,7 +33,8 @@ export interface GetDefaultScraperConfigurationCommandOutput /** * @public - * Gets a default configuration. + *The GetDefaultScraperConfiguration operation returns the default
+ * scraper configuration used when Amazon EKS creates a scraper for you.
You do not have sufficient access to perform this action.
* * @throws {@link InternalServerException} (server fault) - * Unexpected error during processing of request. + *An unexpected error occurred during the processing of the request.
* * @throws {@link ThrottlingException} (client fault) - * Request was denied due to request throttling. + *The request was denied due to request throttling.
* * @throws {@link AmpServiceException} *Base exception class for all service exceptions from Amp service.
diff --git a/clients/client-amp/src/commands/ListRuleGroupsNamespacesCommand.ts b/clients/client-amp/src/commands/ListRuleGroupsNamespacesCommand.ts index 9e69427a881a3..e01ca30bb31aa 100644 --- a/clients/client-amp/src/commands/ListRuleGroupsNamespacesCommand.ts +++ b/clients/client-amp/src/commands/ListRuleGroupsNamespacesCommand.ts @@ -28,7 +28,7 @@ export interface ListRuleGroupsNamespacesCommandOutput extends ListRuleGroupsNam /** * @public - * Lists rule groups namespaces. + *Returns a list of rule groups namespaces in a workspace.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -71,19 +71,20 @@ export interface ListRuleGroupsNamespacesCommandOutput extends ListRuleGroupsNam * @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * User does not have sufficient access to perform this action. + *You do not have sufficient access to perform this action.
* * @throws {@link InternalServerException} (server fault) - * Unexpected error during processing of request. + *An unexpected error occurred during the processing of the request.
* * @throws {@link ResourceNotFoundException} (client fault) - * Request references a resource which does not exist. + *The request references a resources that doesn't exist.
* * @throws {@link ThrottlingException} (client fault) - * Request was denied due to request throttling. + *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - * The input fails to satisfy the constraints specified by an AWS service. + *The input fails to satisfy the constraints specified by an Amazon Web Services + * service.
* * @throws {@link AmpServiceException} *Base exception class for all service exceptions from Amp service.
diff --git a/clients/client-amp/src/commands/ListScrapersCommand.ts b/clients/client-amp/src/commands/ListScrapersCommand.ts index 4203a6f6c62ab..1c648b76402be 100644 --- a/clients/client-amp/src/commands/ListScrapersCommand.ts +++ b/clients/client-amp/src/commands/ListScrapersCommand.ts @@ -28,7 +28,9 @@ export interface ListScrapersCommandOutput extends ListScrapersResponse, __Metad /** * @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. + *The ListScrapers operation lists all of the scrapers in
+ * your account. This includes scrapers being created or deleted. You can optionally
+ * filter the returned list.
You do not have sufficient access to perform this action.
* * @throws {@link InternalServerException} (server fault) - * Unexpected error during processing of request. + *An unexpected error occurred during the processing of the request.
* * @throws {@link ThrottlingException} (client fault) - * Request was denied due to request throttling. + *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - * The input fails to satisfy the constraints specified by an AWS service. + *The input fails to satisfy the constraints specified by an Amazon Web Services + * service.
* * @throws {@link AmpServiceException} *Base exception class for all service exceptions from Amp service.
diff --git a/clients/client-amp/src/commands/ListTagsForResourceCommand.ts b/clients/client-amp/src/commands/ListTagsForResourceCommand.ts index 82f1e70f5715e..caffc4ceeb793 100644 --- a/clients/client-amp/src/commands/ListTagsForResourceCommand.ts +++ b/clients/client-amp/src/commands/ListTagsForResourceCommand.ts @@ -28,7 +28,9 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** * @public - * Lists the tags you have assigned to the resource. + *The ListTagsForResource 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.
You do not have sufficient access to perform this action.
* * @throws {@link InternalServerException} (server fault) - * Unexpected error during processing of request. + *An unexpected error occurred during the processing of the request.
* * @throws {@link ResourceNotFoundException} (client fault) - * Request references a resource which does not exist. + *The request references a resources that doesn't exist.
* * @throws {@link ThrottlingException} (client fault) - * Request was denied due to request throttling. + *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - * The input fails to satisfy the constraints specified by an AWS service. + *The input fails to satisfy the constraints specified by an Amazon Web Services + * service.
* * @throws {@link AmpServiceException} *Base exception class for all service exceptions from Amp service.
diff --git a/clients/client-amp/src/commands/ListWorkspacesCommand.ts b/clients/client-amp/src/commands/ListWorkspacesCommand.ts index 99484a891fa89..8cc3a157a3601 100644 --- a/clients/client-amp/src/commands/ListWorkspacesCommand.ts +++ b/clients/client-amp/src/commands/ListWorkspacesCommand.ts @@ -28,7 +28,8 @@ export interface ListWorkspacesCommandOutput extends ListWorkspacesResponse, __M /** * @public - * Lists all AMP workspaces, including workspaces being created or deleted. + *Lists all of the Amazon Managed Service for Prometheus workspaces in your account. This includes + * workspaces being created or deleted.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -70,16 +71,17 @@ export interface ListWorkspacesCommandOutput extends ListWorkspacesResponse, __M * @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * User does not have sufficient access to perform this action. + *You do not have sufficient access to perform this action.
* * @throws {@link InternalServerException} (server fault) - * Unexpected error during processing of request. + *An unexpected error occurred during the processing of the request.
* * @throws {@link ThrottlingException} (client fault) - * Request was denied due to request throttling. + *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - * The input fails to satisfy the constraints specified by an AWS service. + *The input fails to satisfy the constraints specified by an Amazon Web Services + * service.
* * @throws {@link AmpServiceException} *Base exception class for all service exceptions from Amp service.
diff --git a/clients/client-amp/src/commands/PutAlertManagerDefinitionCommand.ts b/clients/client-amp/src/commands/PutAlertManagerDefinitionCommand.ts index d81644837f080..3d162cc8e2780 100644 --- a/clients/client-amp/src/commands/PutAlertManagerDefinitionCommand.ts +++ b/clients/client-amp/src/commands/PutAlertManagerDefinitionCommand.ts @@ -28,7 +28,9 @@ export interface PutAlertManagerDefinitionCommandOutput extends PutAlertManagerD /** * @public - * Update an alert manager definition. + *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 CreateAlertManagerDefinition.
You do not have sufficient access to perform this action.
* * @throws {@link ConflictException} (client fault) - * Updating or deleting a resource can cause an inconsistent state. + *The request would cause an inconsistent state.
* * @throws {@link InternalServerException} (server fault) - * Unexpected error during processing of request. + *An unexpected error occurred during the processing of the request.
* * @throws {@link ResourceNotFoundException} (client fault) - * Request references a resource which does not exist. + *The request references a resources that doesn't exist.
* * @throws {@link ServiceQuotaExceededException} (client fault) - * Request would cause a service quota to be exceeded. + *Completing the request would cause a service quota to be exceeded.
* * @throws {@link ThrottlingException} (client fault) - * Request was denied due to request throttling. + *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - * The input fails to satisfy the constraints specified by an AWS service. + *The input fails to satisfy the constraints specified by an Amazon Web Services + * service.
* * @throws {@link AmpServiceException} *Base exception class for all service exceptions from Amp service.
diff --git a/clients/client-amp/src/commands/PutRuleGroupsNamespaceCommand.ts b/clients/client-amp/src/commands/PutRuleGroupsNamespaceCommand.ts index 90fd2b8146e62..4060f350cd129 100644 --- a/clients/client-amp/src/commands/PutRuleGroupsNamespaceCommand.ts +++ b/clients/client-amp/src/commands/PutRuleGroupsNamespaceCommand.ts @@ -28,7 +28,13 @@ export interface PutRuleGroupsNamespaceCommandOutput extends PutRuleGroupsNamesp /** * @public - * Update a rule groups namespace. + *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.
+ *Use this operation only to update existing rule groups namespaces. To create a new
+ * rule groups namespace, use CreateRuleGroupsNamespace.
You can't use this operation to add tags to an existing rule groups namespace.
+ * Instead, use TagResource.
You do not have sufficient access to perform this action.
* * @throws {@link ConflictException} (client fault) - * Updating or deleting a resource can cause an inconsistent state. + *The request would cause an inconsistent state.
* * @throws {@link InternalServerException} (server fault) - * Unexpected error during processing of request. + *An unexpected error occurred during the processing of the request.
* * @throws {@link ResourceNotFoundException} (client fault) - * Request references a resource which does not exist. + *The request references a resources that doesn't exist.
* * @throws {@link ServiceQuotaExceededException} (client fault) - * Request would cause a service quota to be exceeded. + *Completing the request would cause a service quota to be exceeded.
* * @throws {@link ThrottlingException} (client fault) - * Request was denied due to request throttling. + *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - * The input fails to satisfy the constraints specified by an AWS service. + *The input fails to satisfy the constraints specified by an Amazon Web Services + * service.
* * @throws {@link AmpServiceException} *Base exception class for all service exceptions from Amp service.
diff --git a/clients/client-amp/src/commands/TagResourceCommand.ts b/clients/client-amp/src/commands/TagResourceCommand.ts index d6856f8187f99..fc060b0a59619 100644 --- a/clients/client-amp/src/commands/TagResourceCommand.ts +++ b/clients/client-amp/src/commands/TagResourceCommand.ts @@ -28,7 +28,13 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** * @public - * Creates tags for the specified resource. + *The TagResource operation associates tags with an Amazon Managed Service for Prometheus
+ * resource. The only resources that can be tagged are workspaces and rule groups
+ * namespaces.
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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -54,19 +60,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * User does not have sufficient access to perform this action. + *You do not have sufficient access to perform this action.
* * @throws {@link InternalServerException} (server fault) - * Unexpected error during processing of request. + *An unexpected error occurred during the processing of the request.
* * @throws {@link ResourceNotFoundException} (client fault) - * Request references a resource which does not exist. + *The request references a resources that doesn't exist.
* * @throws {@link ThrottlingException} (client fault) - * Request was denied due to request throttling. + *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - * The input fails to satisfy the constraints specified by an AWS service. + *The input fails to satisfy the constraints specified by an Amazon Web Services + * service.
* * @throws {@link AmpServiceException} *Base exception class for all service exceptions from Amp service.
diff --git a/clients/client-amp/src/commands/UntagResourceCommand.ts b/clients/client-amp/src/commands/UntagResourceCommand.ts index fbc4e26f8f24b..46a49b6a4f980 100644 --- a/clients/client-amp/src/commands/UntagResourceCommand.ts +++ b/clients/client-amp/src/commands/UntagResourceCommand.ts @@ -28,7 +28,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** * @public - * Deletes tags from the specified resource. + *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -54,19 +55,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __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. + *You do not have sufficient access to perform this action.
* * @throws {@link InternalServerException} (server fault) - * Unexpected error during processing of request. + *An unexpected error occurred during the processing of the request.
* * @throws {@link ResourceNotFoundException} (client fault) - * Request references a resource which does not exist. + *The request references a resources that doesn't exist.
* * @throws {@link ThrottlingException} (client fault) - * Request was denied due to request throttling. + *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - * The input fails to satisfy the constraints specified by an AWS service. + *The input fails to satisfy the constraints specified by an Amazon Web Services + * service.
* * @throws {@link AmpServiceException} *Base exception class for all service exceptions from Amp service.
diff --git a/clients/client-amp/src/commands/UpdateLoggingConfigurationCommand.ts b/clients/client-amp/src/commands/UpdateLoggingConfigurationCommand.ts index 1d5b587442537..4eded256d5b8c 100644 --- a/clients/client-amp/src/commands/UpdateLoggingConfigurationCommand.ts +++ b/clients/client-amp/src/commands/UpdateLoggingConfigurationCommand.ts @@ -28,7 +28,8 @@ export interface UpdateLoggingConfigurationCommandOutput extends UpdateLoggingCo /** * @public - * Update logging configuration. + *Updates the log group ARN or the workspace ID of the current logging + * configuration.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -58,19 +59,20 @@ export interface UpdateLoggingConfigurationCommandOutput extends UpdateLoggingCo * @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * User does not have sufficient access to perform this action. + *You do not have sufficient access to perform this action.
* * @throws {@link ConflictException} (client fault) - * Updating or deleting a resource can cause an inconsistent state. + *The request would cause an inconsistent state.
* * @throws {@link InternalServerException} (server fault) - * Unexpected error during processing of request. + *An unexpected error occurred during the processing of the request.
* * @throws {@link ResourceNotFoundException} (client fault) - * Request references a resource which does not exist. + *The request references a resources that doesn't exist.
* * @throws {@link ValidationException} (client fault) - * The input fails to satisfy the constraints specified by an AWS service. + *The input fails to satisfy the constraints specified by an Amazon Web Services + * service.
* * @throws {@link AmpServiceException} *Base exception class for all service exceptions from Amp service.
diff --git a/clients/client-amp/src/commands/UpdateWorkspaceAliasCommand.ts b/clients/client-amp/src/commands/UpdateWorkspaceAliasCommand.ts index 6199ca5e4e904..66b38e88c7e79 100644 --- a/clients/client-amp/src/commands/UpdateWorkspaceAliasCommand.ts +++ b/clients/client-amp/src/commands/UpdateWorkspaceAliasCommand.ts @@ -28,7 +28,7 @@ export interface UpdateWorkspaceAliasCommandOutput extends __MetadataBearer {} /** * @public - * Updates an AMP workspace alias. + *Updates the alias of an existing workspace.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -53,25 +53,26 @@ export interface UpdateWorkspaceAliasCommandOutput extends __MetadataBearer {} * @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * User does not have sufficient access to perform this action. + *You do not have sufficient access to perform this action.
* * @throws {@link ConflictException} (client fault) - * Updating or deleting a resource can cause an inconsistent state. + *The request would cause an inconsistent state.
* * @throws {@link InternalServerException} (server fault) - * Unexpected error during processing of request. + *An unexpected error occurred during the processing of the request.
* * @throws {@link ResourceNotFoundException} (client fault) - * Request references a resource which does not exist. + *The request references a resources that doesn't exist.
* * @throws {@link ServiceQuotaExceededException} (client fault) - * Request would cause a service quota to be exceeded. + *Completing the request would cause a service quota to be exceeded.
* * @throws {@link ThrottlingException} (client fault) - * Request was denied due to request throttling. + *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - * The input fails to satisfy the constraints specified by an AWS service. + *The input fails to satisfy the constraints specified by an Amazon Web Services + * service.
* * @throws {@link AmpServiceException} *Base exception class for all service exceptions from Amp service.
diff --git a/clients/client-amp/src/index.ts b/clients/client-amp/src/index.ts index f9b5b137ba32f..9b198719e888e 100644 --- a/clients/client-amp/src/index.ts +++ b/clients/client-amp/src/index.ts @@ -1,7 +1,24 @@ // smithy-typescript generated code /* eslint-disable */ /** - * Amazon Managed Service for Prometheus + *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.
+ *For more information about Amazon Managed Service for Prometheus, see the Amazon Managed Service for Prometheus User Guide.
+ *Amazon Managed Service for Prometheus includes two APIs.
+ *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.
+ *Use the Prometheus-compatible API to work within your Prometheus + * workspace.
+ *You do not have sufficient access to perform this action.
*/ export class AccessDeniedException extends __BaseException { readonly name: "AccessDeniedException" = "AccessDeniedException"; @@ -25,20 +25,20 @@ export class AccessDeniedException extends __BaseException { /** * @public - * Updating or deleting a resource can cause an inconsistent state. + *The request would cause an inconsistent state.
*/ export class ConflictException extends __BaseException { readonly name: "ConflictException" = "ConflictException"; readonly $fault: "client" = "client"; /** * @public - * Identifier of the resource affected. + *Identifier of the resource affected.
*/ resourceId: string | undefined; /** * @public - * Type of the resource affected. + *Type of the resource affected.
*/ resourceType: string | undefined; @@ -59,24 +59,27 @@ export class ConflictException extends __BaseException { /** * @public - * Represents the input of a CreateAlertManagerDefinition operation. + *Represents the input of a CreateAlertManagerDefinition operation.
The ID of the workspace to add the alert manager definition to.
*/ workspaceId: string | undefined; /** * @public - * The alert manager definition data. + *The alert manager definition to add. A base64-encoded version of the YAML alert + * manager definition file.
+ *For details about the alert manager definition, see AlertManagedDefinitionData.
*/ data: Uint8Array | undefined; /** * @public - * Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request. + *A unique identifier that you can provide to ensure the idempotency of the request. + * Case-sensitive.
*/ clientToken?: string; } @@ -120,37 +123,37 @@ export type AlertManagerDefinitionStatusCode = /** * @public - * Represents the status of a definition. + *The status of the alert manager.
*/ export interface AlertManagerDefinitionStatus { /** * @public - * Status code of this definition. + *The current status of the alert manager.
*/ statusCode: AlertManagerDefinitionStatusCode | undefined; /** * @public - * The reason for failure if any. + *If there is a failure, the reason for the failure.
*/ statusReason?: string; } /** * @public - * Represents the output of a CreateAlertManagerDefinition operation. + *Represents the output of a CreateAlertManagerDefinition operation.
A structure that displays the current status of the alert manager definition.
*/ status: AlertManagerDefinitionStatus | undefined; } /** * @public - * Unexpected error during processing of request. + *An unexpected error occurred during the processing of the request.
*/ export class InternalServerException extends __BaseException { readonly name: "InternalServerException" = "InternalServerException"; @@ -158,7 +161,7 @@ export class InternalServerException extends __BaseException { $retryable = {}; /** * @public - * Advice to clients on when the call can be safely retried. + *Advice to clients on when the call can be safely retried.
*/ retryAfterSeconds?: number; @@ -178,20 +181,20 @@ export class InternalServerException extends __BaseException { /** * @public - * Request references a resource which does not exist. + *The request references a resources that doesn't exist.
*/ export class ResourceNotFoundException extends __BaseException { readonly name: "ResourceNotFoundException" = "ResourceNotFoundException"; readonly $fault: "client" = "client"; /** * @public - * Identifier of the resource affected. + *Identifier of the resource affected.
*/ resourceId: string | undefined; /** * @public - * Type of the resource affected. + *Type of the resource affected.
*/ resourceType: string | undefined; @@ -212,32 +215,32 @@ export class ResourceNotFoundException extends __BaseException { /** * @public - * Request would cause a service quota to be exceeded. + *Completing the request would cause a service quota to be exceeded.
*/ export class ServiceQuotaExceededException extends __BaseException { readonly name: "ServiceQuotaExceededException" = "ServiceQuotaExceededException"; readonly $fault: "client" = "client"; /** * @public - * Identifier of the resource affected. + *Identifier of the resource affected.
*/ resourceId: string | undefined; /** * @public - * Type of the resource affected. + *Type of the resource affected.
*/ resourceType: string | undefined; /** * @public - * Service Quotas requirement to identify originating service. + *Service quotas code for the originating service.
*/ serviceCode: string | undefined; /** * @public - * Service Quotas requirement to identify originating quota. + *Service quotas code of the originating quota.
*/ quotaCode: string | undefined; @@ -260,7 +263,7 @@ export class ServiceQuotaExceededException extends __BaseException { /** * @public - * Request was denied due to request throttling. + *The request was denied due to request throttling.
*/ export class ThrottlingException extends __BaseException { readonly name: "ThrottlingException" = "ThrottlingException"; @@ -268,19 +271,19 @@ export class ThrottlingException extends __BaseException { $retryable = {}; /** * @public - * Service Quotas requirement to identify originating service. + *Service quotas code for the originating service.
*/ serviceCode?: string; /** * @public - * Service Quotas requirement to identify originating quota. + *Service quotas code for the originating quota.
*/ quotaCode?: string; /** * @public - * Advice to clients on when the call can be safely retried. + *Advice to clients on when the call can be safely retried.
*/ retryAfterSeconds?: number; @@ -302,18 +305,18 @@ export class ThrottlingException extends __BaseException { /** * @public - * Stores information about a field passed inside a request that resulted in an exception. + *Information about a field passed into a request that resulted in an exception.
*/ export interface ValidationExceptionField { /** * @public - * The field name. + *The name of the field that caused an exception.
*/ name: string | undefined; /** * @public - * Message describing why the field failed validation. + *A message describing why the field caused an exception.
*/ message: string | undefined; } @@ -336,20 +339,21 @@ export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof /** * @public - * The input fails to satisfy the constraints specified by an AWS service. + *The input fails to satisfy the constraints specified by an Amazon Web Services + * service.
*/ export class ValidationException extends __BaseException { readonly name: "ValidationException" = "ValidationException"; readonly $fault: "client" = "client"; /** * @public - * Reason the request failed validation. + *Reason the request failed validation.
*/ reason: ValidationExceptionReason | undefined; /** * @public - * The field that caused the error, if applicable. If more than one field caused the error, pick one and elaborate in the message. + *The field that caused the error, if applicable.
*/ fieldList?: ValidationExceptionField[]; @@ -370,126 +374,133 @@ export class ValidationException extends __BaseException { /** * @public - * Represents the input of a DeleteAlertManagerDefinition operation. + *Represents the input of a DeleteAlertManagerDefinition operation.
The ID of the workspace to delete the alert manager definition from.
*/ workspaceId: string | undefined; /** * @public - * Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request. + *A unique identifier that you can provide to ensure the idempotency of the request. + * Case-sensitive.
*/ clientToken?: string; } /** * @public - * Represents the input of a DescribeAlertManagerDefinition operation. + *Represents the input of a DescribeAlertManagerDefinition operation.
The ID of the workspace to retrieve the alert manager definition from.
*/ workspaceId: string | undefined; } /** * @public - * Represents the properties of an alert manager definition. + *The details of an alert manager definition.
*/ export interface AlertManagerDefinitionDescription { /** * @public - * The status of alert manager definition. + *A structure that displays the current status of the alert manager definition..
*/ status: AlertManagerDefinitionStatus | undefined; /** * @public - * The alert manager definition. + *The actual alert manager definition.
+ *For details about the alert manager definition, see AlertManagedDefinitionData.
*/ data: Uint8Array | undefined; /** * @public - * The time when the alert manager definition was created. + *The date and time that the alert manager definition was created.
*/ createdAt: Date | undefined; /** * @public - * The time when the alert manager definition was modified. + *The date and time that the alert manager definition was most recently changed.
*/ modifiedAt: Date | undefined; } /** * @public - * Represents the output of a DescribeAlertManagerDefinition operation. + *Represents the output of a DescribeAlertManagerDefinition operation.
The alert manager definition.
*/ alertManagerDefinition: AlertManagerDefinitionDescription | undefined; } /** * @public - * Represents the input of a PutAlertManagerDefinition operation. + *Represents the input of a PutAlertManagerDefinition operation.
The ID of the workspace to update the alert manager definition in.
*/ workspaceId: string | undefined; /** * @public - * The alert manager definition data. + *The alert manager definition to use. A base64-encoded version of the YAML alert + * manager definition file.
+ *For details about the alert manager definition, see AlertManagedDefinitionData.
*/ data: Uint8Array | undefined; /** * @public - * Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request. + *A unique identifier that you can provide to ensure the idempotency of the request. + * Case-sensitive.
*/ clientToken?: string; } /** * @public - * Represents the output of a PutAlertManagerDefinition operation. + *Represents the output of a PutAlertManagerDefinition operation.
A structure that returns the current status of the alert manager definition.
*/ status: AlertManagerDefinitionStatus | undefined; } /** * @public - * Represents the input of a GetDefaultScraperConfiguration operation. + *Represents the input of a GetDefaultScraperConfiguration operation.
Represents the output of a GetDefaultScraperConfiguration operation.
The configuration file. Base 64 encoded. + * For more information, see Scraper configurationin the Amazon Managed Service for Prometheus User + * Guide.
*/ configuration: Uint8Array | undefined; } @@ -500,7 +511,8 @@ export interface GetDefaultScraperConfigurationResponse { export interface ListTagsForResourceRequest { /** * @public - * The ARN of the resource. + *The ARN of the resource to list tages for. Must be a workspace or rule groups + * namespace resource.
*/ resourceArn: string | undefined; } @@ -511,26 +523,27 @@ export interface ListTagsForResourceRequest { export interface ListTagsForResourceResponse { /** * @public - * The list of tags assigned to the resource. + *The list of tag keys and values associated with the resource.
*/ tags?: RecordThe AmpConfiguration structure defines the Amazon Managed Service for Prometheus instance a scraper
+ * should send metrics to.
ARN of the Amazon Managed Service for Prometheus workspace.
*/ workspaceArn: string | undefined; } /** * @public - * A representation of a destination that a scraper can produce metrics to. + *Where to send the metrics from a scraper.
*/ export type Destination = Destination.AmpConfigurationMember | Destination.$UnknownMember; @@ -540,7 +553,7 @@ export type Destination = Destination.AmpConfigurationMember | Destination.$Unkn export namespace Destination { /** * @public - * A representation of an AMP destination. + *The Amazon Managed Service for Prometheusworkspace to send metrics to.
*/ export interface AmpConfigurationMember { ampConfiguration: AmpConfiguration; @@ -568,7 +581,8 @@ export namespace Destination { /** * @public - * A representation of a Prometheus configuration file. + *A scrape configuration for a scraper, base 64 encoded. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User + * Guide.
*/ export type ScrapeConfiguration = ScrapeConfiguration.ConfigurationBlobMember | ScrapeConfiguration.$UnknownMember; @@ -578,7 +592,7 @@ export type ScrapeConfiguration = ScrapeConfiguration.ConfigurationBlobMember | export namespace ScrapeConfiguration { /** * @public - * Binary data representing a Prometheus configuration file. + *The base 64 encoded scrape configuration file.
*/ export interface ConfigurationBlobMember { configurationBlob: Uint8Array; @@ -606,31 +620,32 @@ export namespace ScrapeConfiguration { /** * @public - * A representation of an EKS source. + *The EksConfiguration structure describes the connection to the
+ * Amazon EKS cluster from which a scraper collects metrics.
ARN of the Amazon EKS cluster.
*/ clusterArn: string | undefined; /** * @public - * A list of security group IDs specified for VPC configuration. + *A list of the security group IDs for the Amazon EKS cluster VPC configuration.
*/ securityGroupIds?: string[]; /** * @public - * A list of subnet IDs specified for VPC configuration. + *A list of subnet IDs for the Amazon EKS cluster VPC configuration.
*/ subnetIds: string[] | undefined; } /** * @public - * A representation of a source that a scraper can discover and collect metrics from. + *The source of collected metrics for a scraper.
*/ export type Source = Source.EksConfigurationMember | Source.$UnknownMember; @@ -640,7 +655,7 @@ export type Source = Source.EksConfigurationMember | Source.$UnknownMember; export namespace Source { /** * @public - * A representation of an EKS source. + *The Amazon EKS cluster from which a scraper collects metrics.
*/ export interface EksConfigurationMember { eksConfiguration: EksConfiguration; @@ -668,42 +683,45 @@ export namespace Source { /** * @public - * Represents the input of a CreateScraper operation. + *Represents the input of a CreateScraper operation.
(optional) a name to associate with the scraper. This is for your use, and does not + * need to be unique.
*/ alias?: string; /** * @public - * The configuration used to create the scraper. + *The configuration file to use in the new scraper. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User + * Guide.
*/ scrapeConfiguration: ScrapeConfiguration | undefined; /** * @public - * The source that the scraper will be discovering and collecting metrics from. + *The Amazon EKS cluster from which the scraper will collect metrics.
*/ source: Source | undefined; /** * @public - * The destination that the scraper will be producing metrics to. + *The Amazon Managed Service for Prometheus workspace to send metrics to.
*/ destination: Destination | undefined; /** * @public - * Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request. + *(Optional) A unique, case-sensitive identifier that you can provide to ensure the + * idempotency of the request.
*/ clientToken?: string; /** * @public - * Optional, user-provided tags for this scraper. + *(Optional) The list of tag keys and values to associate with the scraper.
*/ tags?: RecordThe ScraperStatus structure contains status information about the
+ * scraper.
The current status of the scraper.
*/ statusCode: ScraperStatusCode | undefined; } /** * @public - * Represents the output of a CreateScraper operation. + *Represents the output of a CreateScraper operation.
The ID of the new scraper.
*/ scraperId: string | undefined; /** * @public - * The ARN of the scraper that was just created. + *The Amazon Resource Name (ARN) of the new scraper.
*/ arn: string | undefined; /** * @public - * The status of the scraper that was just created (usually CREATING). + *A structure that displays the current status of the scraper.
*/ status: ScraperStatus | undefined; /** * @public - * The tags of this scraper. + *The list of tag keys and values that are associated with the scraper.
*/ tags?: RecordRepresents the input of a DeleteScraper operation.
The ID of the scraper to delete.
*/ scraperId: string | undefined; /** * @public - * Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request. + *(Optional) A unique, case-sensitive identifier that you can provide to ensure the + * idempotency of the request.
*/ clientToken?: string; } /** * @public - * Represents the output of a DeleteScraper operation. + *Represents the output of a DeleteScraper operation.
The ID of the scraper to delete.
*/ scraperId: string | undefined; /** * @public - * The status of the scraper that is being deleted. + *The current status of the scraper.
*/ status: ScraperStatus | undefined; } /** * @public - * Represents the input of a DescribeScraper operation. + *Represents the input of a DescribeScraper operation.
The ID of the scraper to describe.
*/ scraperId: string | undefined; } /** * @public - * Represents the properties of a scraper. + *The ScraperDescription structure contains the full details about one
+ * scraper in your account.
(Optional) A name associated with the scraper.
*/ alias?: string; /** * @public - * Unique string identifying this scraper. + *The ID of the scraper.
*/ scraperId: string | undefined; /** * @public - * The Amazon Resource Name (ARN) of this scraper. + *The Amazon Resource Name (ARN) of the scraper.
*/ arn: string | undefined; /** * @public - * The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to dsicover, collect, and produce metrics on your behalf. + *The Amazon Resource Name (ARN) of the IAM role that provides + * permissions for the scraper to discover and collect metrics on your behalf.
*/ roleArn: string | undefined; /** * @public - * The status of this scraper. + *A structure that contains the current status of the scraper.
*/ status: ScraperStatus | undefined; /** * @public - * The time when the scraper was created. + *The date and time that the scraper was created.
*/ createdAt: Date | undefined; /** * @public - * The time when the scraper was last modified. + *The date and time that the scraper was last modified.
*/ lastModifiedAt: Date | undefined; /** * @public - * The tags of this scraper. + *(Optional) The list of tag keys and values associated with the scraper.
*/ tags?: RecordIf there is a failure, the reason for the failure.
*/ statusReason?: string; /** * @public - * The configuration used to create the scraper. + *The configuration file in use by the scraper.
*/ scrapeConfiguration: ScrapeConfiguration | undefined; /** * @public - * The source that the scraper is discovering and collecting metrics from. + *The Amazon EKS cluster from which the scraper collects metrics.
*/ source: Source | undefined; /** * @public - * The destination that the scraper is producing metrics to. + *The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
*/ destination: Destination | undefined; } /** * @public - * Represents the output of a DescribeScraper operation. + *Represents the output of a DescribeScraper operation.
Contains details about the scraper.
*/ scraper: ScraperDescription | undefined; } /** * @public - * Represents the input of a ListScrapers operation. + *Represents the input of a ListScrapers operation.
(Optional) A list of key-value pairs to filter the list of scrapers returned.
+ * Keys include status, sourceArn,
+ * destinationArn, and alias.
Filters on the same key are OR'd together, and filters on different
+ * keys are AND'd together. For example,
+ * status=ACTIVE&status=CREATING&alias=Test, will return all
+ * scrapers that have the alias Test, and are either in status ACTIVE or CREATING.
To find all active scrapers that are sending metrics to a specific Amazon Managed Service for Prometheus + * workspace, you would use the ARN of the workspace in a query:
+ *
+ * status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012
+ *
If this is included, it filters the results to only the scrapers that match + * the filter.
*/ filters?: Record(Optional) The token for the next set of + * items to return. (You received this token from a previous call.)
*/ nextToken?: string; /** * @public - * Maximum results to return in response (default=100, maximum=1000). + *Optional) The maximum number of
+ * scrapers to return in one ListScrapers operation. The range is
+ * 1-1000.
If you omit this parameter, the default of 100 is used.
*/ maxResults?: number; } /** * @public - * Represents a summary of the properties of a scraper. + *The ScraperSummary structure contains a summary of the details about one
+ * scraper in your account.
(Optional) A name associated with the scraper.
*/ alias?: string; /** * @public - * Unique string identifying this scraper. + *The ID of the scraper.
*/ scraperId: string | undefined; /** * @public - * The Amazon Resource Name (ARN) of this scraper. + *The Amazon Resource Name (ARN) of the scraper.
*/ arn: string | undefined; /** * @public - * The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to dsicover, collect, and produce metrics on your behalf. + *The Amazon Resource Name (ARN) of the IAM role that provides + * permissions for the scraper to discover and collect metrics on your behalf.
*/ roleArn: string | undefined; /** * @public - * The status of this scraper. + *A structure that contains the current status of the scraper.
*/ status: ScraperStatus | undefined; /** * @public - * The time when the scraper was created. + *The date and time that the scraper was created.
*/ createdAt: Date | undefined; /** * @public - * The time when the scraper was last modified. + *The date and time that the scraper was last modified.
*/ lastModifiedAt: Date | undefined; /** * @public - * The tags of this scraper. + *(Optional) The list of tag keys and values associated with the scraper.
*/ tags?: RecordIf there is a failure, the reason for the failure.
*/ statusReason?: string; /** * @public - * The source that the scraper is discovering and collecting metrics from. + *The Amazon EKS cluster from which the scraper collects metrics.
*/ source: Source | undefined; /** * @public - * The destination that the scraper is producing metrics to. + *The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
*/ destination: Destination | undefined; } /** * @public - * Represents the output of a ListScrapers operation. + *Represents the output of a ListScrapers operation.
A list of ScraperSummary structures giving information about scrapers
+ * in the account that match the filters provided.
A token indicating that there are more
+ * results to retrieve. You can use this token as part of your next
+ * ListScrapers operation to retrieve those results.
The ARN of the workspace or rule groups namespace to apply tags to.
*/ resourceArn: string | undefined; /** * @public - * The list of tags assigned to the resource. + *The list of tag keys and values to associate with the resource.
+ *Keys may not begin with aws:.
The ARN of the workspace or rule groups namespace.
*/ resourceArn: string | undefined; /** * @public - * One or more tag keys + *The keys of the tags to remove.
*/ tagKeys: string[] | undefined; } @@ -1080,30 +1125,37 @@ export interface UntagResourceResponse {} /** * @public - * Represents the input of a CreateWorkspace operation. + *Represents the input of a CreateWorkspace operation.
An alias that you assign to this workspace to help you identify it. It does not need + * to be unique.
+ *Blank spaces at the beginning or end of the alias that you specify will be trimmed + * from the value used.
*/ alias?: string; /** * @public - * Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request. + *A unique identifier that you can provide to ensure the idempotency of the request. + * Case-sensitive.
*/ clientToken?: string; /** * @public - * Optional, user-provided tags for this workspace. + *The list of tag keys and values to associate with the workspace.
*/ tags?: Record(optional) The ARN for a customer managed KMS key to use for + * encrypting data within your workspace. For more information about using your + * own key in your workspace, see Encryption at rest in the Amazon Managed Service for Prometheus User + * Guide.
*/ kmsKeyArn?: string; } @@ -1142,258 +1194,278 @@ export type WorkspaceStatusCode = (typeof WorkspaceStatusCode)[keyof typeof Work /** * @public - * Represents the status of a workspace. + *The status of the workspace.
*/ export interface WorkspaceStatus { /** * @public - * Status code of this workspace. + *The current status of the workspace.
*/ statusCode: WorkspaceStatusCode | undefined; } /** * @public - * Represents the output of a CreateWorkspace operation. + *Represents the output of a CreateWorkspace operation.
The unique ID for the new workspace.
*/ workspaceId: string | undefined; /** * @public - * The ARN of the workspace that was just created. + *The ARN for the new workspace.
*/ arn: string | undefined; /** * @public - * The status of the workspace that was just created (usually CREATING). + *The current status of the new workspace. Immediately after you create the workspace,
+ * the status is usually CREATING.
The list of tag keys and values that are associated with the workspace.
*/ tags?: Record(optional) If the workspace was created with a customer managed KMS + * key, the ARN for the key used.
*/ kmsKeyArn?: string; } /** * @public - * Represents the input of a DeleteWorkspace operation. + *Represents the input of a DeleteWorkspace operation.
The ID of the workspace to delete.
*/ workspaceId: string | undefined; /** * @public - * Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request. + *A unique identifier that you can provide to ensure the idempotency of the request. + * Case-sensitive.
*/ clientToken?: string; } /** * @public - * Represents the input of a DescribeWorkspace operation. + *Represents the input of a DescribeWorkspace operation.
The ID of the workspace to describe.
*/ workspaceId: string | undefined; } /** * @public - * Represents the properties of a workspace. + *The full details about one Amazon Managed Service for Prometheus workspace in your account.
*/ export interface WorkspaceDescription { /** * @public - * Unique string identifying this workspace. + *The unique ID for the workspace.
*/ workspaceId: string | undefined; /** * @public - * Alias of this workspace. + *The alias that is assigned to this workspace to help identify it. It may not be + * unique.
*/ alias?: string; /** * @public - * The Amazon Resource Name (ARN) of this workspace. + *The ARN of the workspace.
*/ arn: string | undefined; /** * @public - * The status of this workspace. + *The current status of the workspace.
*/ status: WorkspaceStatus | undefined; /** * @public - * Prometheus endpoint URI. + *The Prometheus endpoint available for this workspace.
*/ prometheusEndpoint?: string; /** * @public - * The time when the workspace was created. + *The date and time that the workspace was created.
*/ createdAt: Date | undefined; /** * @public - * The tags of this workspace. + *The list of tag keys and values that are associated with the workspace.
*/ tags?: Record(optional) If the workspace was created with a customer managed KMS + * key, the ARN for the key used.
*/ kmsKeyArn?: string; } /** * @public - * Represents the output of a DescribeWorkspace operation. + *Represents the output of a DescribeWorkspace operation.
A structure that contains details about the workspace.
*/ workspace: WorkspaceDescription | undefined; } /** * @public - * Represents the input of a ListWorkspaces operation. + *Represents the input of a ListWorkspaces operation.
The token for the next set of items to return. You receive this token from a previous + * call, and use it to get the next page of results. The other parameters must be the same + * as the initial call.
+ *For example, if your initial request has maxResults of 10, and there are
+ * 12 workspaces to return, then your initial request will return 10 and a
+ * nextToken. Using the next token in a subsequent call will return the
+ * remaining 2 workspaces.
If this is included, it filters the results to only the workspaces with names that + * start with the value that you specify here.
+ *Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning + * and end of the alias that you specify.
*/ alias?: string; /** * @public - * Maximum results to return in response (default=100, maximum=1000). + *The maximum number of workspaces to return per request. The default is 100.
*/ maxResults?: number; } /** * @public - * Represents a summary of the properties of a workspace. + *The information about one Amazon Managed Service for Prometheus workspace in your account.
*/ export interface WorkspaceSummary { /** * @public - * Unique string identifying this workspace. + *The unique ID for the workspace.
*/ workspaceId: string | undefined; /** * @public - * Alias of this workspace. + *The alias that is assigned to this workspace to help identify it. It may not be + * unique.
*/ alias?: string; /** * @public - * The AmazonResourceName of this workspace. + *The ARN of the workspace.
*/ arn: string | undefined; /** * @public - * The status of this workspace. + *The current status of the workspace.
*/ status: WorkspaceStatus | undefined; /** * @public - * The time when the workspace was created. + *The date and time that the workspace was created.
*/ createdAt: Date | undefined; /** * @public - * The tags of this workspace. + *The list of tag keys and values that are associated with the workspace.
*/ tags?: Record(optional) If the workspace was created with a customer managed KMS + * key, the ARN for the key used.
*/ kmsKeyArn?: string; } /** * @public - * Represents the output of a ListWorkspaces operation. + *Represents the output of a ListWorkspaces operation.
An array of WorkspaceSummary structures containing information about the
+ * workspaces requested.
A token indicating that there are more results to retrieve. You can use this token as
+ * part of your next ListWorkspaces request to retrieve those results.
Represents the input of a CreateLoggingConfiguration operation.
The ID of the workspace to create the logging configuration for.
*/ workspaceId: string | undefined; /** * @public - * The ARN of the CW log group to which the vended log data will be published. + *The ARN of the CloudWatch log group to which the vended log data will be + * published. This log group must exist prior to calling this API.
*/ logGroupArn: string | undefined; /** * @public - * Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request. + *A unique identifier that you can provide to ensure the idempotency of the request. + * Case-sensitive.
*/ clientToken?: string; } @@ -1437,180 +1509,187 @@ export type LoggingConfigurationStatusCode = /** * @public - * Represents the status of a logging configuration. + *The status of the logging configuration.
*/ export interface LoggingConfigurationStatus { /** * @public - * Status code of the logging configuration. + *The current status of the logging configuration.
*/ statusCode: LoggingConfigurationStatusCode | undefined; /** * @public - * The reason for failure if any. + *If failed, the reason for the failure.
*/ statusReason?: string; } /** * @public - * Represents the output of a CreateLoggingConfiguration operation. + *Represents the output of a CreateLoggingConfiguration operation.
A structure that displays the current status of the logging configuration.
*/ status: LoggingConfigurationStatus | undefined; } /** * @public - * Represents the input of a DeleteLoggingConfiguration operation. + *Represents the input of a DeleteLoggingConfiguration operation.
The ID of the workspace containing the logging configuration to delete.
*/ workspaceId: string | undefined; /** * @public - * Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request. + *A unique identifier that you can provide to ensure the idempotency of the request. + * Case-sensitive.
*/ clientToken?: string; } /** * @public - * Represents the input of a DescribeLoggingConfiguration operation. + *Represents the input of a DescribeLoggingConfiguration operation.
The ID of the workspace to describe the logging configuration for.
*/ workspaceId: string | undefined; } /** * @public - * Represents the properties of a logging configuration metadata. + *Contains information about the logging configuration.
*/ export interface LoggingConfigurationMetadata { /** * @public - * The status of the logging configuration. + *The current status of the logging configuration.
*/ status: LoggingConfigurationStatus | undefined; /** * @public - * The workspace where the logging configuration exists. + *The ID of the workspace the logging configuration is for.
*/ workspace: string | undefined; /** * @public - * The ARN of the CW log group to which the vended log data will be published. + *The ARN of the CloudWatch log group to which the vended log data will be + * published.
*/ logGroupArn: string | undefined; /** * @public - * The time when the logging configuration was created. + *The date and time that the logging configuration was created.
*/ createdAt: Date | undefined; /** * @public - * The time when the logging configuration was modified. + *The date and time that the logging configuration was most recently changed.
*/ modifiedAt: Date | undefined; } /** * @public - * Represents the output of a DescribeLoggingConfiguration operation. + *Represents the output of a DescribeLoggingConfiguration operation.
A structure that displays the information about the logging configuration.
*/ loggingConfiguration: LoggingConfigurationMetadata | undefined; } /** * @public - * Represents the input of an UpdateLoggingConfiguration operation. + *Represents the input of an UpdateLoggingConfiguration operation.
The ID of the workspace to update the logging configuration for.
*/ workspaceId: string | undefined; /** * @public - * The ARN of the CW log group to which the vended log data will be published. + *The ARN of the CloudWatch log group to which the vended log data will be + * published.
*/ logGroupArn: string | undefined; /** * @public - * Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request. + *A unique identifier that you can provide to ensure the idempotency of the request. + * Case-sensitive.
*/ clientToken?: string; } /** * @public - * Represents the output of an UpdateLoggingConfiguration operation. + *Represents the output of an UpdateLoggingConfiguration operation.
A structure that contains the current status of the logging configuration.
*/ status: LoggingConfigurationStatus | undefined; } /** * @public - * Represents the input of a CreateRuleGroupsNamespace operation. + *Represents the input of a CreateRuleGroupsNamespace operation.
The ID of the workspace to add the rule groups namespace.
*/ workspaceId: string | undefined; /** * @public - * The rule groups namespace name. + *The name for the new rule groups namespace.
*/ name: string | undefined; /** * @public - * The namespace data that define the rule groups. + *The rules file to use in the new namespace.
+ *Contains the base64-encoded version of the YAML rules file.
+ *For details about the rule groups namespace structure, see RuleGroupsNamespaceData.
*/ data: Uint8Array | undefined; /** * @public - * Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request. + *A unique identifier that you can provide to ensure the idempotency of the request. + * Case-sensitive.
*/ clientToken?: string; /** * @public - * Optional, user-provided tags for this rule groups namespace. + *The list of tag keys and values to associate with the rule groups namespace.
*/ tags?: RecordThe status information about a rule groups namespace.
*/ export interface RuleGroupsNamespaceStatus { /** * @public - * Status code of this namespace. + *The current status of the namespace.
*/ statusCode: RuleGroupsNamespaceStatusCode | undefined; /** * @public - * The reason for failure if any. + *The reason for the failure, if any.
*/ statusReason?: string; } /** * @public - * Represents the output of a CreateRuleGroupsNamespace operation. + *Represents the output of a CreateRuleGroupsNamespace operation.
The name of the new rule groups namespace.
*/ name: string | undefined; /** * @public - * The Amazon Resource Name (ARN) of this rule groups namespace. + *The Amazon Resource Name (ARN) of the new rule groups namespace.
*/ arn: string | undefined; /** * @public - * The status of rule groups namespace. + *A structure that returns the current status of the rule groups namespace.
*/ status: RuleGroupsNamespaceStatus | undefined; /** * @public - * The tags of this rule groups namespace. + *The list of tag keys and values that are associated with the namespace.
*/ tags?: RecordRepresents the input of a DeleteRuleGroupsNamespace operation.
The ID of the workspace containing the rule groups namespace and definition to + * delete.
*/ workspaceId: string | undefined; /** * @public - * The rule groups namespace name. + *The name of the rule groups namespace to delete.
*/ name: string | undefined; /** * @public - * Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request. + *A unique identifier that you can provide to ensure the idempotency of the request. + * Case-sensitive.
*/ clientToken?: string; } /** * @public - * Represents the input of a DescribeRuleGroupsNamespace operation. + *Represents the input of a DescribeRuleGroupsNamespace operation.
The ID of the workspace containing the rule groups namespace.
*/ workspaceId: string | undefined; /** * @public - * The rule groups namespace. + *The name of the rule groups namespace that you want information for.
*/ name: string | undefined; } /** * @public - * Represents a description of the rule groups namespace. + *The details about one rule groups namespace.
*/ export interface RuleGroupsNamespaceDescription { /** * @public - * The Amazon Resource Name (ARN) of this rule groups namespace. + *The ARN of the rule groups namespace.
*/ arn: string | undefined; /** * @public - * The rule groups namespace name. + *The name of the rule groups namespace.
*/ name: string | undefined; /** * @public - * The status of rule groups namespace. + *The current status of the rule groups namespace.
*/ status: RuleGroupsNamespaceStatus | undefined; /** * @public - * The rule groups namespace data. + *The rule groups file used in the namespace.
+ *For details about the rule groups namespace structure, see RuleGroupsNamespaceData.
*/ data: Uint8Array | undefined; /** * @public - * The time when the rule groups namespace was created. + *The date and time that the rule groups namespace was created.
*/ createdAt: Date | undefined; /** * @public - * The time when the rule groups namespace was modified. + *The date and time that the rule groups namespace was most recently changed.
*/ modifiedAt: Date | undefined; /** * @public - * The tags of this rule groups namespace. + *The list of tag keys and values that are associated with the rule groups + * namespace.
*/ tags?: RecordRepresents the output of a DescribeRuleGroupsNamespace operation.
The information about the rule groups namespace.
*/ ruleGroupsNamespace: RuleGroupsNamespaceDescription | undefined; } /** * @public - * Represents the input of a ListRuleGroupsNamespaces operation. + *Represents the input of a ListRuleGroupsNamespaces operation.
The ID of the workspace containing the rule groups namespaces.
*/ workspaceId: string | undefined; /** * @public - * Optional filter for rule groups namespace name. Only the rule groups namespace that begin with this value will be returned. + *Use this parameter to filter the rule groups namespaces that are returned. Only the + * namespaces with names that begin with the value that you specify are returned.
*/ name?: string; /** * @public - * Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListRuleGroupsNamespaces request. + *The token for the next set of items to return. You receive this token from a previous + * call, and use it to get the next page of results. The other parameters must be the same + * as the initial call.
+ *For example, if your initial request has maxResults of 10, and there are
+ * 12 rule groups namespaces to return, then your initial request will return 10 and a
+ * nextToken. Using the next token in a subsequent call will return the
+ * remaining 2 namespaces.
The maximum number of results to return. The default is 100.
*/ maxResults?: number; } /** * @public - * Represents a summary of the rule groups namespace. + *The high-level information about a rule groups namespace. To retrieve more
+ * information, use DescribeRuleGroupsNamespace.
The ARN of the rule groups namespace.
*/ arn: string | undefined; /** * @public - * The rule groups namespace name. + *The name of the rule groups namespace.
*/ name: string | undefined; /** * @public - * The status of rule groups namespace. + *A structure that displays the current status of the rule groups namespace.
*/ status: RuleGroupsNamespaceStatus | undefined; /** * @public - * The time when the rule groups namespace was created. + *The date and time that the rule groups namespace was created.
*/ createdAt: Date | undefined; /** * @public - * The time when the rule groups namespace was modified. + *The date and time that the rule groups namespace was most recently changed.
*/ modifiedAt: Date | undefined; /** * @public - * The tags of this rule groups namespace. + *The list of tag keys and values that are associated with the rule groups + * namespace.
*/ tags?: RecordRepresents the output of a ListRuleGroupsNamespaces operation.
The returned list of rule groups namespaces.
*/ ruleGroupsNamespaces: RuleGroupsNamespaceSummary[] | undefined; /** * @public - * Pagination token to use when requesting the next page in this list. + *A token indicating that there are more results to retrieve. You can use this token as
+ * part of your next ListRuleGroupsNamespaces request to retrieve those
+ * results.
Represents the input of a PutRuleGroupsNamespace operation.
The ID of the workspace where you are updating the rule groups namespace.
*/ workspaceId: string | undefined; /** * @public - * The rule groups namespace name. + *The name of the rule groups namespace that you are updating.
*/ name: string | undefined; /** * @public - * The namespace data that define the rule groups. + *The new rules file to use in the namespace. A base64-encoded version of the YAML rule + * groups file.
+ *For details about the rule groups namespace structure, see RuleGroupsNamespaceData.
*/ data: Uint8Array | undefined; /** * @public - * Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request. + *A unique identifier that you can provide to ensure the idempotency of the request. + * Case-sensitive.
*/ clientToken?: string; } /** * @public - * Represents the output of a PutRuleGroupsNamespace operation. + *Represents the output of a PutRuleGroupsNamespace operation.
The name of the rule groups namespace that was updated.
*/ name: string | undefined; /** * @public - * The Amazon Resource Name (ARN) of this rule groups namespace. + *The ARN of the rule groups namespace.
*/ arn: string | undefined; /** * @public - * The status of rule groups namespace. + *A structure that includes the current status of the rule groups namespace.
*/ status: RuleGroupsNamespaceStatus | undefined; /** * @public - * The tags of this rule groups namespace. + *The list of tag keys and values that are associated with the namespace.
*/ tags?: RecordRepresents the input of an UpdateWorkspaceAlias operation.
The ID of the workspace to update.
*/ workspaceId: string | undefined; /** * @public - * The new alias of the workspace. + *The new alias for the workspace. It does not need to be unique.
+ *Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning + * and end of the alias that you specify.
*/ alias?: string; /** * @public - * Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request. + *A unique identifier that you can provide to ensure the idempotency of the request. + * Case-sensitive.
*/ clientToken?: string; } diff --git a/codegen/sdk-codegen/aws-models/amp.json b/codegen/sdk-codegen/aws-models/amp.json index 9aaa83e9701ec..5abfddd587930 100644 --- a/codegen/sdk-codegen/aws-models/amp.json +++ b/codegen/sdk-codegen/aws-models/amp.json @@ -7,13 +7,13 @@ "message": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Description of the error.", + "smithy.api#documentation": "Description of the error.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "User does not have sufficient access to perform this action.", + "smithy.api#documentation": "You do not have sufficient access to perform this action.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -41,13 +41,13 @@ "aws.api#arn": { "template": "workspace/{workspaceId}" }, - "smithy.api#documentation": "The definition of the alert manager in the AMP workspace" + "smithy.api#documentation": "The alert manager definition, a YAML configuration for the alertmanager in your\n Amazon Managed Service for Prometheus workspace.
\nFor details about the alert manager definition, see AlertManagedDefinitionData.
" } }, "com.amazonaws.amp#AlertManagerDefinitionData": { "type": "blob", "traits": { - "smithy.api#documentation": "The alert manager definition data." + "smithy.api#documentation": "The base-64 encoded blob that is alert manager definition.
\nFor details about the alert manager definition, see AlertManagedDefinitionData.
" } }, "com.amazonaws.amp#AlertManagerDefinitionDescription": { @@ -56,34 +56,34 @@ "status": { "target": "com.amazonaws.amp#AlertManagerDefinitionStatus", "traits": { - "smithy.api#documentation": "The status of alert manager definition.", + "smithy.api#documentation": "A structure that displays the current status of the alert manager definition..
", "smithy.api#required": {} } }, "data": { "target": "com.amazonaws.amp#AlertManagerDefinitionData", "traits": { - "smithy.api#documentation": "The alert manager definition.", + "smithy.api#documentation": "The actual alert manager definition.
\nFor details about the alert manager definition, see AlertManagedDefinitionData.
", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the alert manager definition was created.", + "smithy.api#documentation": "The date and time that the alert manager definition was created.
", "smithy.api#required": {} } }, "modifiedAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the alert manager definition was modified.", + "smithy.api#documentation": "The date and time that the alert manager definition was most recently changed.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the properties of an alert manager definition." + "smithy.api#documentation": "The details of an alert manager definition.
" } }, "com.amazonaws.amp#AlertManagerDefinitionStatus": { @@ -92,25 +92,25 @@ "statusCode": { "target": "com.amazonaws.amp#AlertManagerDefinitionStatusCode", "traits": { - "smithy.api#documentation": "Status code of this definition.", + "smithy.api#documentation": "The current status of the alert manager.
", "smithy.api#required": {} } }, "statusReason": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The reason for failure if any." + "smithy.api#documentation": "If there is a failure, the reason for the failure.
" } } }, "traits": { - "smithy.api#documentation": "Represents the status of a definition." + "smithy.api#documentation": "The status of the alert manager.
" } }, "com.amazonaws.amp#AlertManagerDefinitionStatusCode": { "type": "string", "traits": { - "smithy.api#documentation": "State of an alert manager definition.", + "smithy.api#documentation": "State of an AlertManagerDefinition.
Amazon Managed Service for Prometheus is a serverless, Prometheus-compatible monitoring service for\n container metrics that makes it easier to securely monitor container environments at\n scale. With Amazon Managed Service for Prometheus, you can use the same open-source Prometheus data\n model and query language that you use today to monitor the performance of your\n containerized workloads, and also enjoy improved scalability, availability, and security\n without having to manage the underlying infrastructure.
\nFor more information about Amazon Managed Service for Prometheus, see the Amazon Managed Service for Prometheus User Guide.
\nAmazon Managed Service for Prometheus includes two APIs.
\nUse the Amazon Web Services API described in this guide to manage Amazon Managed Service for Prometheus resources, such as workspaces, rule groups, and alert\n managers.
\nUse the Prometheus-compatible API to work within your Prometheus\n workspace.
\nARN of the Amazon Managed Service for Prometheus workspace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A representation of an AMP destination." + "smithy.api#documentation": "The AmpConfiguration structure defines the Amazon Managed Service for Prometheus instance a scraper\n should send metrics to.
The ARN of an EKS cluster.
", "smithy.api#pattern": "^arn:aws[-a-z]*:eks:[-a-z0-9]+:[0-9]{12}:cluster/.+$" } }, @@ -983,27 +983,27 @@ "message": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Description of the error.", + "smithy.api#documentation": "Description of the error.
", "smithy.api#required": {} } }, "resourceId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Identifier of the resource affected.", + "smithy.api#documentation": "Identifier of the resource affected.
", "smithy.api#required": {} } }, "resourceType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Type of the resource affected.", + "smithy.api#documentation": "Type of the resource affected.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Updating or deleting a resource can cause an inconsistent state.", + "smithy.api#documentation": "The request would cause an inconsistent state.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -1040,7 +1040,7 @@ } ], "traits": { - "smithy.api#documentation": "Create an alert manager definition.", + "smithy.api#documentation": "The CreateAlertManagerDefinition operation creates the alert manager\n definition in a workspace. If a workspace already has an alert manager definition, don't\n use this operation to update it. Instead, use\n PutAlertManagerDefinition.
The ID of the workspace to add the alert manager definition to.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1063,20 +1063,20 @@ "data": { "target": "com.amazonaws.amp#AlertManagerDefinitionData", "traits": { - "smithy.api#documentation": "The alert manager definition data.", + "smithy.api#documentation": "The alert manager definition to add. A base64-encoded version of the YAML alert\n manager definition file.
\nFor details about the alert manager definition, see AlertManagedDefinitionData.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.amp#IdempotencyToken", "traits": { - "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#documentation": "A unique identifier that you can provide to ensure the idempotency of the request.\n Case-sensitive.
", "smithy.api#idempotencyToken": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a CreateAlertManagerDefinition operation." + "smithy.api#documentation": "Represents the input of a CreateAlertManagerDefinition operation.
A structure that displays the current status of the alert manager definition.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the output of a CreateAlertManagerDefinition operation." + "smithy.api#documentation": "Represents the output of a CreateAlertManagerDefinition operation.
The CreateLoggingConfiguration operation creates a logging configuration\n for the workspace. Use this operation to set the CloudWatch log group to which\n the logs will be published to.
The ID of the workspace to create the logging configuration for.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1140,20 +1140,20 @@ "logGroupArn": { "target": "com.amazonaws.amp#LogGroupArn", "traits": { - "smithy.api#documentation": "The ARN of the CW log group to which the vended log data will be published.", + "smithy.api#documentation": "The ARN of the CloudWatch log group to which the vended log data will be\n published. This log group must exist prior to calling this API.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.amp#IdempotencyToken", "traits": { - "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#documentation": "A unique identifier that you can provide to ensure the idempotency of the request.\n Case-sensitive.
", "smithy.api#idempotencyToken": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a CreateLoggingConfiguration operation." + "smithy.api#documentation": "Represents the input of a CreateLoggingConfiguration operation.
A structure that displays the current status of the logging configuration.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the output of a CreateLoggingConfiguration operation." + "smithy.api#documentation": "Represents the output of a CreateLoggingConfiguration operation.
The CreateRuleGroupsNamespace operation creates a rule groups namespace\n within a workspace. A rule groups namespace is associated with exactly one rules file. A\n workspace can have multiple rule groups namespaces.
Use this operation only to create new rule groups namespaces. To update an existing\n rule groups namespace, use PutRuleGroupsNamespace.
The ID of the workspace to add the rule groups namespace.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1226,33 +1226,33 @@ "name": { "target": "com.amazonaws.amp#RuleGroupsNamespaceName", "traits": { - "smithy.api#documentation": "The rule groups namespace name.", + "smithy.api#documentation": "The name for the new rule groups namespace.
", "smithy.api#required": {} } }, "data": { "target": "com.amazonaws.amp#RuleGroupsNamespaceData", "traits": { - "smithy.api#documentation": "The namespace data that define the rule groups.", + "smithy.api#documentation": "The rules file to use in the new namespace.
\nContains the base64-encoded version of the YAML rules file.
\nFor details about the rule groups namespace structure, see RuleGroupsNamespaceData.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.amp#IdempotencyToken", "traits": { - "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#documentation": "A unique identifier that you can provide to ensure the idempotency of the request.\n Case-sensitive.
", "smithy.api#idempotencyToken": {} } }, "tags": { "target": "com.amazonaws.amp#TagMap", "traits": { - "smithy.api#documentation": "Optional, user-provided tags for this rule groups namespace." + "smithy.api#documentation": "The list of tag keys and values to associate with the rule groups namespace.
" } } }, "traits": { - "smithy.api#documentation": "Represents the input of a CreateRuleGroupsNamespace operation." + "smithy.api#documentation": "Represents the input of a CreateRuleGroupsNamespace operation.
The name of the new rule groups namespace.
", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.amp#RuleGroupsNamespaceArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of this rule groups namespace.", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the new rule groups namespace.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.amp#RuleGroupsNamespaceStatus", "traits": { - "smithy.api#documentation": "The status of rule groups namespace.", + "smithy.api#documentation": "A structure that returns the current status of the rule groups namespace.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.amp#TagMap", "traits": { - "smithy.api#documentation": "The tags of this rule groups namespace." + "smithy.api#documentation": "The list of tag keys and values that are associated with the namespace.
" } } }, "traits": { - "smithy.api#documentation": "Represents the output of a CreateRuleGroupsNamespace operation." + "smithy.api#documentation": "Represents the output of a CreateRuleGroupsNamespace operation.
The CreateScraper operation creates a scraper to collect metrics. A\n scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS\n cluster, and sends them to your Amazon Managed Service for Prometheus workspace. You can configure the\n scraper to control what metrics are collected, and what transformations are applied\n prior to sending them to your workspace.
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 \n Using roles for scraping metrics from EKS in the Amazon Managed Service for Prometheus User \n Guide.
\nYou cannot update a scraper. If you want to change the configuration of the scraper,\n create a new scraper and delete the old one.
\nThe scrapeConfiguration parameter contains the base64-encoded version of\n the YAML configuration file.
For more information about collectors, including what metrics are collected, and\n how to configure the scraper, see Amazon Web Services managed\n collectors in the Amazon Managed Service for Prometheus User \n Guide.
\n(optional) a name to associate with the scraper. This is for your use, and does not\n need to be unique.
" } }, "scrapeConfiguration": { "target": "com.amazonaws.amp#ScrapeConfiguration", "traits": { - "smithy.api#documentation": "The configuration used to create the scraper.", + "smithy.api#documentation": "The configuration file to use in the new scraper. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User \n Guide.
", "smithy.api#required": {} } }, "source": { "target": "com.amazonaws.amp#Source", "traits": { - "smithy.api#documentation": "The source that the scraper will be discovering and collecting metrics from.", + "smithy.api#documentation": "The Amazon EKS cluster from which the scraper will collect metrics.
", "smithy.api#required": {} } }, "destination": { "target": "com.amazonaws.amp#Destination", "traits": { - "smithy.api#documentation": "The destination that the scraper will be producing metrics to.", + "smithy.api#documentation": "The Amazon Managed Service for Prometheus workspace to send metrics to.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.amp#IdempotencyToken", "traits": { - "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#documentation": "(Optional) A unique, case-sensitive identifier that you can provide to ensure the\n idempotency of the request.
", "smithy.api#idempotencyToken": {} } }, "tags": { "target": "com.amazonaws.amp#TagMap", "traits": { - "smithy.api#documentation": "Optional, user-provided tags for this scraper." + "smithy.api#documentation": "(Optional) The list of tag keys and values to associate with the scraper.
" } } }, "traits": { - "smithy.api#documentation": "Represents the input of a CreateScraper operation.", + "smithy.api#documentation": "Represents the input of a CreateScraper operation.
The ID of the new scraper.
", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.amp#ScraperArn", "traits": { - "smithy.api#documentation": "The ARN of the scraper that was just created.", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the new scraper.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.amp#ScraperStatus", "traits": { - "smithy.api#documentation": "The status of the scraper that was just created (usually CREATING).", + "smithy.api#documentation": "A structure that displays the current status of the scraper.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.amp#TagMap", "traits": { - "smithy.api#documentation": "The tags of this scraper." + "smithy.api#documentation": "The list of tag keys and values that are associated with the scraper.
" } } }, "traits": { - "smithy.api#documentation": "Represents the output of a CreateScraper operation.", + "smithy.api#documentation": "Represents the output of a CreateScraper operation.
Creates a Prometheus workspace. A workspace is a logical space dedicated to the\n storage and querying of Prometheus metrics. You can have one or more workspaces in each\n Region in your account.
", "smithy.api#http": { "code": 202, "method": "POST", @@ -1497,31 +1497,31 @@ "alias": { "target": "com.amazonaws.amp#WorkspaceAlias", "traits": { - "smithy.api#documentation": "An optional user-assigned alias for this workspace. This alias is for user reference and does not need to be unique." + "smithy.api#documentation": "An alias that you assign to this workspace to help you identify it. It does not need\n to be unique.
\nBlank spaces at the beginning or end of the alias that you specify will be trimmed\n from the value used.
" } }, "clientToken": { "target": "com.amazonaws.amp#IdempotencyToken", "traits": { - "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#documentation": "A unique identifier that you can provide to ensure the idempotency of the request.\n Case-sensitive.
", "smithy.api#idempotencyToken": {} } }, "tags": { "target": "com.amazonaws.amp#TagMap", "traits": { - "smithy.api#documentation": "Optional, user-provided tags for this workspace." + "smithy.api#documentation": "The list of tag keys and values to associate with the workspace.
" } }, "kmsKeyArn": { "target": "com.amazonaws.amp#KmsKeyArn", "traits": { - "smithy.api#documentation": "Optional, customer managed KMS key used to encrypt data for this workspace" + "smithy.api#documentation": "(optional) The ARN for a customer managed KMS key to use for \n encrypting data within your workspace. For more information about using your\n own key in your workspace, see Encryption at rest in the Amazon Managed Service for Prometheus User \n Guide.
" } } }, "traits": { - "smithy.api#documentation": "Represents the input of a CreateWorkspace operation." + "smithy.api#documentation": "Represents the input of a CreateWorkspace operation.
The unique ID for the new workspace.
", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.amp#WorkspaceArn", "traits": { - "smithy.api#documentation": "The ARN of the workspace that was just created.", + "smithy.api#documentation": "The ARN for the new workspace.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.amp#WorkspaceStatus", "traits": { - "smithy.api#documentation": "The status of the workspace that was just created (usually CREATING).", + "smithy.api#documentation": "The current status of the new workspace. Immediately after you create the workspace,\n the status is usually CREATING.
The list of tag keys and values that are associated with the workspace.
" } }, "kmsKeyArn": { "target": "com.amazonaws.amp#KmsKeyArn", "traits": { - "smithy.api#documentation": "Customer managed KMS key ARN for this workspace" + "smithy.api#documentation": "(optional) If the workspace was created with a customer managed KMS \n key, the ARN for the key used.
" } } }, "traits": { - "smithy.api#documentation": "Represents the output of a CreateWorkspace operation." + "smithy.api#documentation": "Represents the output of a CreateWorkspace operation.
Deletes the alert manager definition from a workspace.
", "smithy.api#http": { "code": 202, "method": "DELETE", @@ -1609,7 +1609,7 @@ "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "The ID of the workspace in which to delete the alert manager definition.", + "smithy.api#documentation": "The ID of the workspace to delete the alert manager definition from.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1617,14 +1617,14 @@ "clientToken": { "target": "com.amazonaws.amp#IdempotencyToken", "traits": { - "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#documentation": "A unique identifier that you can provide to ensure the idempotency of the request.\n Case-sensitive.
", "smithy.api#httpQuery": "clientToken", "smithy.api#idempotencyToken": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a DeleteAlertManagerDefinition operation." + "smithy.api#documentation": "Represents the input of a DeleteAlertManagerDefinition operation.
Deletes the logging configuration for a workspace.
", "smithy.api#http": { "code": 202, "method": "DELETE", @@ -1668,7 +1668,7 @@ "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "The ID of the workspace to vend logs to.", + "smithy.api#documentation": "The ID of the workspace containing the logging configuration to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1676,14 +1676,14 @@ "clientToken": { "target": "com.amazonaws.amp#IdempotencyToken", "traits": { - "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#documentation": "A unique identifier that you can provide to ensure the idempotency of the request.\n Case-sensitive.
", "smithy.api#httpQuery": "clientToken", "smithy.api#idempotencyToken": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a DeleteLoggingConfiguration operation." + "smithy.api#documentation": "Represents the input of a DeleteLoggingConfiguration operation.
Deletes one rule groups namespace and its associated rule groups definition.
", "smithy.api#http": { "code": 202, "method": "DELETE", @@ -1730,7 +1730,7 @@ "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "The ID of the workspace to delete rule group definition.", + "smithy.api#documentation": "The ID of the workspace containing the rule groups namespace and definition to\n delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1738,7 +1738,7 @@ "name": { "target": "com.amazonaws.amp#RuleGroupsNamespaceName", "traits": { - "smithy.api#documentation": "The rule groups namespace name.", + "smithy.api#documentation": "The name of the rule groups namespace to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1746,14 +1746,14 @@ "clientToken": { "target": "com.amazonaws.amp#IdempotencyToken", "traits": { - "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#documentation": "A unique identifier that you can provide to ensure the idempotency of the request.\n Case-sensitive.
", "smithy.api#httpQuery": "clientToken", "smithy.api#idempotencyToken": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a DeleteRuleGroupsNamespace operation." + "smithy.api#documentation": "Represents the input of a DeleteRuleGroupsNamespace operation.
The DeleteScraper operation deletes one scraper, and stops any metrics\n collection that the scraper performs.
The ID of the scraper to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1823,14 +1823,14 @@ "clientToken": { "target": "com.amazonaws.amp#IdempotencyToken", "traits": { - "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#documentation": "(Optional) A unique, case-sensitive identifier that you can provide to ensure the \n idempotency of the request.
", "smithy.api#httpQuery": "clientToken", "smithy.api#idempotencyToken": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a DeleteScraper operation.", + "smithy.api#documentation": "Represents the input of a DeleteScraper operation.
The ID of the scraper to delete.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.amp#ScraperStatus", "traits": { - "smithy.api#documentation": "The status of the scraper that is being deleted.", + "smithy.api#documentation": "The current status of the scraper.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the output of a DeleteScraper operation.", + "smithy.api#documentation": "Represents the output of a DeleteScraper operation.
Deletes an existing workspace.
\nWhen you delete a workspace, the data that has been ingested into it is not\n immediately deleted. It will be permanently deleted within one month.
\nThe ID of the workspace to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1909,14 +1909,14 @@ "clientToken": { "target": "com.amazonaws.amp#IdempotencyToken", "traits": { - "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#documentation": "A unique identifier that you can provide to ensure the idempotency of the request.\n Case-sensitive.
", "smithy.api#httpQuery": "clientToken", "smithy.api#idempotencyToken": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a DeleteWorkspace operation." + "smithy.api#documentation": "Represents the input of a DeleteWorkspace operation.
Retrieves the full information about the alert manager definition for a\n workspace.
", "smithy.api#http": { "code": 200, "method": "GET", @@ -1960,14 +1960,14 @@ "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "The ID of the workspace to describe.", + "smithy.api#documentation": "The ID of the workspace to retrieve the alert manager definition from.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a DescribeAlertManagerDefinition operation." + "smithy.api#documentation": "Represents the input of a DescribeAlertManagerDefinition operation.
The alert manager definition.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the output of a DescribeAlertManagerDefinition operation." + "smithy.api#documentation": "Represents the output of a DescribeAlertManagerDefinition operation.
Returns complete information about the current logging configuration of the\n workspace.
", "smithy.api#http": { "code": 200, "method": "GET", @@ -2023,14 +2023,14 @@ "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "The ID of the workspace to vend logs to.", + "smithy.api#documentation": "The ID of the workspace to describe the logging configuration for.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a DescribeLoggingConfiguration operation." + "smithy.api#documentation": "Represents the input of a DescribeLoggingConfiguration operation.
A structure that displays the information about the logging configuration.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the output of a DescribeLoggingConfiguration operation." + "smithy.api#documentation": "Represents the output of a DescribeLoggingConfiguration operation.
Returns complete information about one rule groups namespace. To retrieve a list of\n rule groups namespaces, use ListRuleGroupsNamespaces.
The ID of the workspace containing the rule groups namespace.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2097,14 +2097,14 @@ "name": { "target": "com.amazonaws.amp#RuleGroupsNamespaceName", "traits": { - "smithy.api#documentation": "The rule groups namespace.", + "smithy.api#documentation": "The name of the rule groups namespace that you want information for.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a DescribeRuleGroupsNamespace operation." + "smithy.api#documentation": "Represents the input of a DescribeRuleGroupsNamespace operation.
The information about the rule groups namespace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the output of a DescribeRuleGroupsNamespace operation." + "smithy.api#documentation": "Represents the output of a DescribeRuleGroupsNamespace operation.
The DescribeScraper operation displays information about an existing\n scraper.
The ID of the scraper to describe.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a DescribeScraper operation.", + "smithy.api#documentation": "Represents the input of a DescribeScraper operation.
Contains details about the scraper.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the output of a DescribeScraper operation.", + "smithy.api#documentation": "Represents the output of a DescribeScraper operation.
Returns information about an existing workspace.
", "smithy.api#http": { "code": 200, "method": "GET", @@ -2376,14 +2376,14 @@ "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "The ID of the workspace to describe.", + "smithy.api#documentation": "The ID of the workspace to describe.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a DescribeWorkspace operation." + "smithy.api#documentation": "Represents the input of a DescribeWorkspace operation.
A structure that contains details about the workspace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the output of a DescribeWorkspace operation." + "smithy.api#documentation": "Represents the output of a DescribeWorkspace operation.
The Amazon Managed Service for Prometheusworkspace to send metrics to.
" } } }, "traits": { - "smithy.api#documentation": "A representation of a destination that a scraper can produce metrics to." + "smithy.api#documentation": "Where to send the metrics from a scraper.
" } }, "com.amazonaws.amp#EksConfiguration": { @@ -2421,32 +2421,32 @@ "clusterArn": { "target": "com.amazonaws.amp#ClusterArn", "traits": { - "smithy.api#documentation": "The ARN of an EKS cluster.", + "smithy.api#documentation": "ARN of the Amazon EKS cluster.
", "smithy.api#required": {} } }, "securityGroupIds": { "target": "com.amazonaws.amp#SecurityGroupIds", "traits": { - "smithy.api#documentation": "A list of security group IDs specified for VPC configuration." + "smithy.api#documentation": "A list of the security group IDs for the Amazon EKS cluster VPC configuration.
" } }, "subnetIds": { "target": "com.amazonaws.amp#SubnetIds", "traits": { - "smithy.api#documentation": "A list of subnet IDs specified for VPC configuration.", + "smithy.api#documentation": "A list of subnet IDs for the Amazon EKS cluster VPC configuration.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A representation of an EKS source." + "smithy.api#documentation": "The EksConfiguration structure describes the connection to the \n Amazon EKS cluster from which a scraper collects metrics.
The name of the key by which to filter.
", "smithy.api#length": { "min": 1, "max": 256 @@ -2456,7 +2456,7 @@ "com.amazonaws.amp#FilterValue": { "type": "string", "traits": { - "smithy.api#documentation": "The value of a given key to filter by.", + "smithy.api#documentation": "The value for a given key by which to filter.
", "smithy.api#length": { "min": 1, "max": 256 @@ -2469,7 +2469,7 @@ "target": "com.amazonaws.amp#FilterValue" }, "traits": { - "smithy.api#documentation": "A list of scraper filter values.", + "smithy.api#documentation": "A list of scraper filter values.
", "smithy.api#length": { "min": 1, "max": 20 @@ -2496,7 +2496,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets a default configuration.", + "smithy.api#documentation": "The GetDefaultScraperConfiguration operation returns the default \n scraper configuration used when Amazon EKS creates a scraper for you.
Represents the input of a GetDefaultScraperConfiguration operation.
The configuration file. Base 64 encoded. \n For more information, see Scraper configurationin the Amazon Managed Service for Prometheus User \n Guide.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the output of a GetDefaultScraperConfiguration operation.", + "smithy.api#documentation": "Represents the output of a GetDefaultScraperConfiguration operation.
An ARN identifying an IAM role used by the scraper.
" } }, "com.amazonaws.amp#IdempotencyToken": { "type": "string", "traits": { - "smithy.api#documentation": "An identifier used to ensure the idempotency of a write request.", + "smithy.api#documentation": "An identifier used to ensure the idempotency of a write request.
", "smithy.api#length": { "min": 1, "max": 64 @@ -2564,20 +2564,20 @@ "message": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Description of the error.", + "smithy.api#documentation": "Description of the error.
", "smithy.api#required": {} } }, "retryAfterSeconds": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "Advice to clients on when the call can be safely retried.", + "smithy.api#documentation": "Advice to clients on when the call can be safely retried.
", "smithy.api#httpHeader": "Retry-After" } } }, "traits": { - "smithy.api#documentation": "Unexpected error during processing of request.", + "smithy.api#documentation": "An unexpected error occurred during the processing of the request.
", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} @@ -2589,7 +2589,7 @@ "aws.api#arnReference": { "type": "AWS::KMS::Key" }, - "smithy.api#documentation": "A KMS Key ARN.", + "smithy.api#documentation": "A KMS Key ARN.
", "smithy.api#length": { "min": 20, "max": 2048 @@ -2623,7 +2623,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists rule groups namespaces.", + "smithy.api#documentation": "Returns a list of rule groups namespaces in a workspace.
", "smithy.api#http": { "code": 200, "method": "GET", @@ -2644,7 +2644,7 @@ "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "The ID of the workspace.", + "smithy.api#documentation": "The ID of the workspace containing the rule groups namespaces.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2652,21 +2652,21 @@ "name": { "target": "com.amazonaws.amp#RuleGroupsNamespaceName", "traits": { - "smithy.api#documentation": "Optional filter for rule groups namespace name. Only the rule groups namespace that begin with this value will be returned.", + "smithy.api#documentation": "Use this parameter to filter the rule groups namespaces that are returned. Only the\n namespaces with names that begin with the value that you specify are returned.
", "smithy.api#httpQuery": "name" } }, "nextToken": { "target": "com.amazonaws.amp#PaginationToken", "traits": { - "smithy.api#documentation": "Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListRuleGroupsNamespaces request.", + "smithy.api#documentation": "The token for the next set of items to return. You receive this token from a previous\n call, and use it to get the next page of results. The other parameters must be the same\n as the initial call.
\nFor example, if your initial request has maxResults of 10, and there are\n 12 rule groups namespaces to return, then your initial request will return 10 and a\n nextToken. Using the next token in a subsequent call will return the\n remaining 2 namespaces.
The maximum number of results to return. The default is 100.
", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, @@ -2676,7 +2676,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the input of a ListRuleGroupsNamespaces operation." + "smithy.api#documentation": "Represents the input of a ListRuleGroupsNamespaces operation.
The returned list of rule groups namespaces.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.amp#PaginationToken", "traits": { - "smithy.api#documentation": "Pagination token to use when requesting the next page in this list." + "smithy.api#documentation": "A token indicating that there are more results to retrieve. You can use this token as\n part of your next ListRuleGroupsNamespaces request to retrieve those\n results.
Represents the output of a ListRuleGroupsNamespaces operation.
The ListScrapers operation lists all of the scrapers in\n your account. This includes scrapers being created or deleted. You can optionally\n filter the returned list.
(Optional) A list of key-value pairs to filter the list of scrapers returned.\n Keys include status, sourceArn, \n destinationArn, and alias.
Filters on the same key are OR'd together, and filters on different\n keys are AND'd together. For example, \n status=ACTIVE&status=CREATING&alias=Test, will return all\n scrapers that have the alias Test, and are either in status ACTIVE or CREATING.
To find all active scrapers that are sending metrics to a specific Amazon Managed Service for Prometheus\n workspace, you would use the ARN of the workspace in a query:
\n\n status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012\n
If this is included, it filters the results to only the scrapers that match \n the filter.
", "smithy.api#httpQueryParams": {} } }, "nextToken": { "target": "com.amazonaws.amp#PaginationToken", "traits": { - "smithy.api#documentation": "Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListScrapers request.", + "smithy.api#documentation": "(Optional) The token for the next set of\n items to return. (You received this token from a previous call.)
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "Maximum results to return in response (default=100, maximum=1000).", + "smithy.api#documentation": "Optional) The maximum number of\n scrapers to return in one ListScrapers operation. The range is\n 1-1000.
If you omit this parameter, the default of 100 is used.
", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, @@ -2873,7 +2873,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the input of a ListScrapers operation.", + "smithy.api#documentation": "Represents the input of a ListScrapers operation.
A list of ScraperSummary structures giving information about scrapers\n in the account that match the filters provided.
A token indicating that there are more\n results to retrieve. You can use this token as part of your next\n ListScrapers operation to retrieve those results.
Represents the output of a ListScrapers operation.
The ListTagsForResource operation returns the tags that are associated\n with an Amazon Managed Service for Prometheus resource. Currently, the only resources that can be\n tagged are workspaces and rule groups namespaces.
The ARN of the resource to list tages for. Must be a workspace or rule groups\n namespace resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2950,7 +2950,10 @@ "type": "structure", "members": { "tags": { - "target": "com.amazonaws.amp#TagMap" + "target": "com.amazonaws.amp#TagMap", + "traits": { + "smithy.api#documentation": "The list of tag keys and values associated with the resource.
" + } } } }, @@ -2977,7 +2980,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all AMP workspaces, including workspaces being created or deleted.", + "smithy.api#documentation": "Lists all of the Amazon Managed Service for Prometheus workspaces in your account. This includes\n workspaces being created or deleted.
", "smithy.api#http": { "code": 200, "method": "GET", @@ -2998,21 +3001,21 @@ "nextToken": { "target": "com.amazonaws.amp#PaginationToken", "traits": { - "smithy.api#documentation": "Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListWorkspaces request.", + "smithy.api#documentation": "The token for the next set of items to return. You receive this token from a previous\n call, and use it to get the next page of results. The other parameters must be the same\n as the initial call.
\nFor example, if your initial request has maxResults of 10, and there are\n 12 workspaces to return, then your initial request will return 10 and a\n nextToken. Using the next token in a subsequent call will return the\n remaining 2 workspaces.
If this is included, it filters the results to only the workspaces with names that\n start with the value that you specify here.
\nAmazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning\n and end of the alias that you specify.
", "smithy.api#httpQuery": "alias" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "Maximum results to return in response (default=100, maximum=1000).", + "smithy.api#documentation": "The maximum number of workspaces to return per request. The default is 100.
", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, @@ -3022,7 +3025,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the input of a ListWorkspaces operation." + "smithy.api#documentation": "Represents the input of a ListWorkspaces operation.
An array of WorkspaceSummary structures containing information about the\n workspaces requested.
A token indicating that there are more results to retrieve. You can use this token as\n part of your next ListWorkspaces request to retrieve those results.
Represents the output of a ListWorkspaces operation.
The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.
" } }, "com.amazonaws.amp#LoggingConfigurationMetadata": { @@ -3087,41 +3090,41 @@ "status": { "target": "com.amazonaws.amp#LoggingConfigurationStatus", "traits": { - "smithy.api#documentation": "The status of the logging configuration.", + "smithy.api#documentation": "The current status of the logging configuration.
", "smithy.api#required": {} } }, "workspace": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "The workspace where the logging configuration exists.", + "smithy.api#documentation": "The ID of the workspace the logging configuration is for.
", "smithy.api#required": {} } }, "logGroupArn": { "target": "com.amazonaws.amp#LogGroupArn", "traits": { - "smithy.api#documentation": "The ARN of the CW log group to which the vended log data will be published.", + "smithy.api#documentation": "The ARN of the CloudWatch log group to which the vended log data will be\n published.
", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the logging configuration was created.", + "smithy.api#documentation": "The date and time that the logging configuration was created.
", "smithy.api#required": {} } }, "modifiedAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the logging configuration was modified.", + "smithy.api#documentation": "The date and time that the logging configuration was most recently changed.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the properties of a logging configuration metadata." + "smithy.api#documentation": "Contains information about the logging configuration.
" } }, "com.amazonaws.amp#LoggingConfigurationStatus": { @@ -3130,25 +3133,25 @@ "statusCode": { "target": "com.amazonaws.amp#LoggingConfigurationStatusCode", "traits": { - "smithy.api#documentation": "Status code of the logging configuration.", + "smithy.api#documentation": "The current status of the logging configuration.
", "smithy.api#required": {} } }, "statusReason": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The reason for failure if any." + "smithy.api#documentation": "If failed, the reason for the failure.
" } } }, "traits": { - "smithy.api#documentation": "Represents the status of a logging configuration." + "smithy.api#documentation": "The status of the logging configuration.
" } }, "com.amazonaws.amp#LoggingConfigurationStatusCode": { "type": "string", "traits": { - "smithy.api#documentation": "State of a logging configuration.", + "smithy.api#documentation": "State of a logging configuration.
", "smithy.api#enum": [ { "name": "CREATING", @@ -3186,7 +3189,7 @@ "com.amazonaws.amp#PaginationToken": { "type": "string", "traits": { - "smithy.api#documentation": "A token used to access the next page in a paginated result set.", + "smithy.api#documentation": "A token used to access the next page in a paginated result set.
", "smithy.api#length": { "max": 1000 } @@ -3224,7 +3227,7 @@ } ], "traits": { - "smithy.api#documentation": "Update an alert manager definition.", + "smithy.api#documentation": "Updates an existing alert manager definition in a workspace. If the workspace does not\n already have an alert manager definition, don't use this operation to create it.\n Instead, use CreateAlertManagerDefinition.
The ID of the workspace to update the alert manager definition in.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3247,20 +3250,20 @@ "data": { "target": "com.amazonaws.amp#AlertManagerDefinitionData", "traits": { - "smithy.api#documentation": "The alert manager definition data.", + "smithy.api#documentation": "The alert manager definition to use. A base64-encoded version of the YAML alert\n manager definition file.
\nFor details about the alert manager definition, see AlertManagedDefinitionData.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.amp#IdempotencyToken", "traits": { - "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#documentation": "A unique identifier that you can provide to ensure the idempotency of the request.\n Case-sensitive.
", "smithy.api#idempotencyToken": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a PutAlertManagerDefinition operation." + "smithy.api#documentation": "Represents the input of a PutAlertManagerDefinition operation.
A structure that returns the current status of the alert manager definition.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the output of a PutAlertManagerDefinition operation." + "smithy.api#documentation": "Represents the output of a PutAlertManagerDefinition operation.
Updates an existing rule groups namespace within a workspace. A rule groups namespace\n is associated with exactly one rules file. A workspace can have multiple rule groups\n namespaces.
\nUse this operation only to update existing rule groups namespaces. To create a new\n rule groups namespace, use CreateRuleGroupsNamespace.
You can't use this operation to add tags to an existing rule groups namespace.\n Instead, use TagResource.
The ID of the workspace where you are updating the rule groups namespace.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3333,7 +3336,7 @@ "name": { "target": "com.amazonaws.amp#RuleGroupsNamespaceName", "traits": { - "smithy.api#documentation": "The rule groups namespace name.", + "smithy.api#documentation": "The name of the rule groups namespace that you are updating.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3341,20 +3344,20 @@ "data": { "target": "com.amazonaws.amp#RuleGroupsNamespaceData", "traits": { - "smithy.api#documentation": "The namespace data that define the rule groups.", + "smithy.api#documentation": "The new rules file to use in the namespace. A base64-encoded version of the YAML rule\n groups file.
\nFor details about the rule groups namespace structure, see RuleGroupsNamespaceData.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.amp#IdempotencyToken", "traits": { - "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#documentation": "A unique identifier that you can provide to ensure the idempotency of the request.\n Case-sensitive.
", "smithy.api#idempotencyToken": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a PutRuleGroupsNamespace operation." + "smithy.api#documentation": "Represents the input of a PutRuleGroupsNamespace operation.
The name of the rule groups namespace that was updated.
", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.amp#RuleGroupsNamespaceArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of this rule groups namespace.", + "smithy.api#documentation": "The ARN of the rule groups namespace.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.amp#RuleGroupsNamespaceStatus", "traits": { - "smithy.api#documentation": "The status of rule groups namespace.", + "smithy.api#documentation": "A structure that includes the current status of the rule groups namespace.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.amp#TagMap", "traits": { - "smithy.api#documentation": "The tags of this rule groups namespace." + "smithy.api#documentation": "The list of tag keys and values that are associated with the namespace.
" } } }, "traits": { - "smithy.api#documentation": "Represents the output of a PutRuleGroupsNamespace operation." + "smithy.api#documentation": "Represents the output of a PutRuleGroupsNamespace operation.
Description of the error.
", "smithy.api#required": {} } }, "resourceId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Identifier of the resource affected.", + "smithy.api#documentation": "Identifier of the resource affected.
", "smithy.api#required": {} } }, "resourceType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Type of the resource affected.", + "smithy.api#documentation": "Type of the resource affected.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Request references a resource which does not exist.", + "smithy.api#documentation": "The request references a resources that doesn't exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -3452,7 +3455,7 @@ "aws.api#arn": { "template": "rulegroupsnamespace/{workspaceId}/{name}" }, - "smithy.api#documentation": "The definition of a rule group namespace in an AMP workspace" + "smithy.api#documentation": "The definition of a rule group namespace in an Amazon Managed Service for Prometheus workspace.
" } }, "com.amazonaws.amp#RuleGroupsNamespaceArn": { @@ -3463,13 +3466,13 @@ "service": "ManagedPrometheusCP", "resource": "RuleGroupsNamespace" }, - "smithy.api#documentation": "An ARN identifying a rule groups namespace." + "smithy.api#documentation": "An ARN identifying a rule groups namespace.
" } }, "com.amazonaws.amp#RuleGroupsNamespaceData": { "type": "blob", "traits": { - "smithy.api#documentation": "The rule groups namespace data." + "smithy.api#documentation": "The rule groups namespace data.
" } }, "com.amazonaws.amp#RuleGroupsNamespaceDescription": { @@ -3478,60 +3481,60 @@ "arn": { "target": "com.amazonaws.amp#RuleGroupsNamespaceArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of this rule groups namespace.", + "smithy.api#documentation": "The ARN of the rule groups namespace.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.amp#RuleGroupsNamespaceName", "traits": { - "smithy.api#documentation": "The rule groups namespace name.", + "smithy.api#documentation": "The name of the rule groups namespace.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.amp#RuleGroupsNamespaceStatus", "traits": { - "smithy.api#documentation": "The status of rule groups namespace.", + "smithy.api#documentation": "The current status of the rule groups namespace.
", "smithy.api#required": {} } }, "data": { "target": "com.amazonaws.amp#RuleGroupsNamespaceData", "traits": { - "smithy.api#documentation": "The rule groups namespace data.", + "smithy.api#documentation": "The rule groups file used in the namespace.
\nFor details about the rule groups namespace structure, see RuleGroupsNamespaceData.
", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the rule groups namespace was created.", + "smithy.api#documentation": "The date and time that the rule groups namespace was created.
", "smithy.api#required": {} } }, "modifiedAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the rule groups namespace was modified.", + "smithy.api#documentation": "The date and time that the rule groups namespace was most recently changed.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.amp#TagMap", "traits": { - "smithy.api#documentation": "The tags of this rule groups namespace." + "smithy.api#documentation": "The list of tag keys and values that are associated with the rule groups\n namespace.
" } } }, "traits": { - "smithy.api#documentation": "Represents a description of the rule groups namespace." + "smithy.api#documentation": "The details about one rule groups namespace.
" } }, "com.amazonaws.amp#RuleGroupsNamespaceName": { "type": "string", "traits": { - "smithy.api#documentation": "The namespace name that the rule group belong to.", + "smithy.api#documentation": "The name of the namespace that the rule group belong to.
", "smithy.api#length": { "min": 1, "max": 64 @@ -3545,25 +3548,25 @@ "statusCode": { "target": "com.amazonaws.amp#RuleGroupsNamespaceStatusCode", "traits": { - "smithy.api#documentation": "Status code of this namespace.", + "smithy.api#documentation": "The current status of the namespace.
", "smithy.api#required": {} } }, "statusReason": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The reason for failure if any." + "smithy.api#documentation": "The reason for the failure, if any.
" } } }, "traits": { - "smithy.api#documentation": "Represents the status of a namespace." + "smithy.api#documentation": "The status information about a rule groups namespace.
" } }, "com.amazonaws.amp#RuleGroupsNamespaceStatusCode": { "type": "string", "traits": { - "smithy.api#documentation": "State of a namespace.", + "smithy.api#documentation": "State of a namespace.
", "smithy.api#enum": [ { "name": "CREATING", @@ -3604,47 +3607,47 @@ "arn": { "target": "com.amazonaws.amp#RuleGroupsNamespaceArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of this rule groups namespace.", + "smithy.api#documentation": "The ARN of the rule groups namespace.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.amp#RuleGroupsNamespaceName", "traits": { - "smithy.api#documentation": "The rule groups namespace name.", + "smithy.api#documentation": "The name of the rule groups namespace.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.amp#RuleGroupsNamespaceStatus", "traits": { - "smithy.api#documentation": "The status of rule groups namespace.", + "smithy.api#documentation": "A structure that displays the current status of the rule groups namespace.
", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the rule groups namespace was created.", + "smithy.api#documentation": "The date and time that the rule groups namespace was created.
", "smithy.api#required": {} } }, "modifiedAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the rule groups namespace was modified.", + "smithy.api#documentation": "The date and time that the rule groups namespace was most recently changed.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.amp#TagMap", "traits": { - "smithy.api#documentation": "The tags of this rule groups namespace." + "smithy.api#documentation": "The list of tag keys and values that are associated with the rule groups\n namespace.
" } } }, "traits": { - "smithy.api#documentation": "Represents a summary of the rule groups namespace." + "smithy.api#documentation": "The high-level information about a rule groups namespace. To retrieve more\n information, use DescribeRuleGroupsNamespace.
A list of rule groups namespace summary.
" } }, "com.amazonaws.amp#ScrapeConfiguration": { @@ -3662,12 +3665,12 @@ "configurationBlob": { "target": "smithy.api#Blob", "traits": { - "smithy.api#documentation": "Binary data representing a Prometheus configuration file." + "smithy.api#documentation": "The base 64 encoded scrape configuration file.
" } } }, "traits": { - "smithy.api#documentation": "A representation of a Prometheus configuration file." + "smithy.api#documentation": "A scrape configuration for a scraper, base 64 encoded. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User \n Guide.
" } }, "com.amazonaws.amp#Scraper": { @@ -3693,13 +3696,13 @@ "aws.api#arn": { "template": "scraper/{scraperId}" }, - "smithy.api#documentation": "A scraper is a logical and isolated Prometheus server dedicated to discovering and collecting metrics and producing them to an AMP workspace." + "smithy.api#documentation": "A scraper is a logical and isolated Prometheus server dedicated to discovering and \n collecting metrics and producing them to an Amazon Managed Service for Prometheus workspace.
" } }, "com.amazonaws.amp#ScraperAlias": { "type": "string", "traits": { - "smithy.api#documentation": "A user-assigned scraper alias.", + "smithy.api#documentation": "A user-assigned scraper alias.
", "smithy.api#length": { "min": 1, "max": 100 @@ -3715,7 +3718,7 @@ "service": "ManagedPrometheusCP", "resource": "Scraper" }, - "smithy.api#documentation": "An ARN identifying a scrape configuration." + "smithy.api#documentation": "An ARN identifying a scrape configuration.
" } }, "com.amazonaws.amp#ScraperDescription": { @@ -3724,87 +3727,87 @@ "alias": { "target": "com.amazonaws.amp#ScraperAlias", "traits": { - "smithy.api#documentation": "Alias of this scraper." + "smithy.api#documentation": "(Optional) A name associated with the scraper.
" } }, "scraperId": { "target": "com.amazonaws.amp#ScraperId", "traits": { - "smithy.api#documentation": "Unique string identifying this scraper.", + "smithy.api#documentation": "The ID of the scraper.
", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.amp#ScraperArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of this scraper.", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the scraper.
", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.amp#IamRoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to dsicover, collect, and produce metrics on your behalf.", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that provides \n permissions for the scraper to discover and collect metrics on your behalf.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.amp#ScraperStatus", "traits": { - "smithy.api#documentation": "The status of this scraper.", + "smithy.api#documentation": "A structure that contains the current status of the scraper.
", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the scraper was created.", + "smithy.api#documentation": "The date and time that the scraper was created.
", "smithy.api#required": {} } }, "lastModifiedAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the scraper was last modified.", + "smithy.api#documentation": "The date and time that the scraper was last modified.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.amp#TagMap", "traits": { - "smithy.api#documentation": "The tags of this scraper." + "smithy.api#documentation": "(Optional) The list of tag keys and values associated with the scraper.
" } }, "statusReason": { "target": "com.amazonaws.amp#StatusReason", "traits": { - "smithy.api#documentation": "The reason for failure if any." + "smithy.api#documentation": "If there is a failure, the reason for the failure.
" } }, "scrapeConfiguration": { "target": "com.amazonaws.amp#ScrapeConfiguration", "traits": { - "smithy.api#documentation": "The configuration used to create the scraper.", + "smithy.api#documentation": "The configuration file in use by the scraper.
", "smithy.api#required": {} } }, "source": { "target": "com.amazonaws.amp#Source", "traits": { - "smithy.api#documentation": "The source that the scraper is discovering and collecting metrics from.", + "smithy.api#documentation": "The Amazon EKS cluster from which the scraper collects metrics.
", "smithy.api#required": {} } }, "destination": { "target": "com.amazonaws.amp#Destination", "traits": { - "smithy.api#documentation": "The destination that the scraper is producing metrics to.", + "smithy.api#documentation": "The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the properties of a scraper.", + "smithy.api#documentation": "The ScraperDescription structure contains the full details about one\n scraper in your account.
The name of the key to filter by. Currently supported filter keys are \n status, sourceArn, destinationArn, and \n alias.
The values of the given key by which to filter.
" } }, "traits": { - "smithy.api#documentation": "A list of scraper filters.", + "smithy.api#documentation": "A list of scraper filters.
", "smithy.api#length": { "min": 1, "max": 4 @@ -3837,7 +3840,7 @@ "com.amazonaws.amp#ScraperId": { "type": "string", "traits": { - "smithy.api#documentation": "A scraper ID.", + "smithy.api#documentation": "A scraper ID.
", "smithy.api#length": { "min": 1, "max": 64 @@ -3851,19 +3854,19 @@ "statusCode": { "target": "com.amazonaws.amp#ScraperStatusCode", "traits": { - "smithy.api#documentation": "Status code of this scraper.", + "smithy.api#documentation": "The current status of the scraper.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the status of a scraper." + "smithy.api#documentation": "The ScraperStatus structure contains status information about the \n scraper.
State of a scraper.
", "smithy.api#enum": [ { "name": "CREATING", @@ -3899,80 +3902,80 @@ "alias": { "target": "com.amazonaws.amp#ScraperAlias", "traits": { - "smithy.api#documentation": "Alias of this scraper." + "smithy.api#documentation": "(Optional) A name associated with the scraper.
" } }, "scraperId": { "target": "com.amazonaws.amp#ScraperId", "traits": { - "smithy.api#documentation": "Unique string identifying this scraper.", + "smithy.api#documentation": "The ID of the scraper.
", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.amp#ScraperArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of this scraper.", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the scraper.
", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.amp#IamRoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to dsicover, collect, and produce metrics on your behalf.", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that provides \n permissions for the scraper to discover and collect metrics on your behalf.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.amp#ScraperStatus", "traits": { - "smithy.api#documentation": "The status of this scraper.", + "smithy.api#documentation": "A structure that contains the current status of the scraper.
", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the scraper was created.", + "smithy.api#documentation": "The date and time that the scraper was created.
", "smithy.api#required": {} } }, "lastModifiedAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the scraper was last modified.", + "smithy.api#documentation": "The date and time that the scraper was last modified.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.amp#TagMap", "traits": { - "smithy.api#documentation": "The tags of this scraper." + "smithy.api#documentation": "(Optional) The list of tag keys and values associated with the scraper.
" } }, "statusReason": { "target": "com.amazonaws.amp#StatusReason", "traits": { - "smithy.api#documentation": "The reason for failure if any." + "smithy.api#documentation": "If there is a failure, the reason for the failure.
" } }, "source": { "target": "com.amazonaws.amp#Source", "traits": { - "smithy.api#documentation": "The source that the scraper is discovering and collecting metrics from.", + "smithy.api#documentation": "The Amazon EKS cluster from which the scraper collects metrics.
", "smithy.api#required": {} } }, "destination": { "target": "com.amazonaws.amp#Destination", "traits": { - "smithy.api#documentation": "The destination that the scraper is producing metrics to.", + "smithy.api#documentation": "The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents a summary of the properties of a scraper.", + "smithy.api#documentation": "The ScraperSummary structure contains a summary of the details about one\n scraper in your account.
A list of scraper summaries.
" } }, "com.amazonaws.amp#SecurityGroupId": { "type": "string", "traits": { - "smithy.api#documentation": "ID of a VPC security group.", + "smithy.api#documentation": "ID of a VPC security group.
", "smithy.api#length": { "min": 0, "max": 255 @@ -4006,7 +4009,7 @@ "target": "com.amazonaws.amp#SecurityGroupId" }, "traits": { - "smithy.api#documentation": "A list of security group IDs specified for VPC configuration.", + "smithy.api#documentation": "A list of security group IDs specified for VPC configuration.
", "smithy.api#length": { "min": 1, "max": 5 @@ -4019,41 +4022,41 @@ "message": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Description of the error.", + "smithy.api#documentation": "Description of the error.
", "smithy.api#required": {} } }, "resourceId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Identifier of the resource affected.", + "smithy.api#documentation": "Identifier of the resource affected.
", "smithy.api#required": {} } }, "resourceType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Type of the resource affected.", + "smithy.api#documentation": "Type of the resource affected.
", "smithy.api#required": {} } }, "serviceCode": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Service Quotas requirement to identify originating service.", + "smithy.api#documentation": "Service quotas code for the originating service.
", "smithy.api#required": {} } }, "quotaCode": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Service Quotas requirement to identify originating quota.", + "smithy.api#documentation": "Service quotas code of the originating quota.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Request would cause a service quota to be exceeded.", + "smithy.api#documentation": "Completing the request would cause a service quota to be exceeded.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -4064,18 +4067,18 @@ "eksConfiguration": { "target": "com.amazonaws.amp#EksConfiguration", "traits": { - "smithy.api#documentation": "A representation of an EKS source." + "smithy.api#documentation": "The Amazon EKS cluster from which a scraper collects metrics.
" } } }, "traits": { - "smithy.api#documentation": "A representation of a source that a scraper can discover and collect metrics from." + "smithy.api#documentation": "The source of collected metrics for a scraper.
" } }, "com.amazonaws.amp#StatusReason": { "type": "string", "traits": { - "smithy.api#documentation": "The reason for failure if any.", + "smithy.api#documentation": "The reason for the failure, if any.
", "smithy.api#length": { "min": 1, "max": 256 @@ -4085,7 +4088,7 @@ "com.amazonaws.amp#SubnetId": { "type": "string", "traits": { - "smithy.api#documentation": "ID of a VPC subnet.", + "smithy.api#documentation": "ID of a VPC subnet.
", "smithy.api#length": { "min": 0, "max": 255 @@ -4099,7 +4102,7 @@ "target": "com.amazonaws.amp#SubnetId" }, "traits": { - "smithy.api#documentation": "A list of subnet IDs specified for VPC configuration.", + "smithy.api#documentation": "A list of subnet IDs specified for VPC configuration.
", "smithy.api#length": { "min": 1, "max": 5 @@ -4127,17 +4130,17 @@ "key": { "target": "com.amazonaws.amp#TagKey", "traits": { - "smithy.api#documentation": "The key of the tag.\n\nConstraints: Tag keys are case-sensitive and accept a maximum of 128 Unicode characters.\nValid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @\nMay not begin with `aws:`.\n" + "smithy.api#documentation": "The key of the tag. May not begin with aws:.
The value of the tag.
" } }, "traits": { - "smithy.api#documentation": "The list of tags assigned to the resource.", + "smithy.api#documentation": "The list of tags assigned to the resource.
", "smithy.api#length": { "max": 50 } @@ -4169,7 +4172,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates tags for the specified resource.", + "smithy.api#documentation": "The TagResource operation associates tags with an Amazon Managed Service for Prometheus\n resource. The only resources that can be tagged are workspaces and rule groups\n namespaces.
If you specify a new tag key for the resource, this tag is appended to the list of\n tags associated with the resource. If you specify a tag key that is already associated\n with the resource, the new tag value that you specify replaces the previous value for\n that tag.
", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}" @@ -4182,7 +4185,7 @@ "resourceArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The ARN of the resource.", + "smithy.api#documentation": "The ARN of the workspace or rule groups namespace to apply tags to.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4190,6 +4193,7 @@ "tags": { "target": "com.amazonaws.amp#TagMap", "traits": { + "smithy.api#documentation": "The list of tag keys and values to associate with the resource.
\nKeys may not begin with aws:.
Description of the error.
", "smithy.api#required": {} } }, "serviceCode": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Service Quotas requirement to identify originating service." + "smithy.api#documentation": "Service quotas code for the originating service.
" } }, "quotaCode": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Service Quotas requirement to identify originating quota." + "smithy.api#documentation": "Service quotas code for the originating quota.
" } }, "retryAfterSeconds": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "Advice to clients on when the call can be safely retried.", + "smithy.api#documentation": "Advice to clients on when the call can be safely retried.
", "smithy.api#httpHeader": "Retry-After" } } }, "traits": { - "smithy.api#documentation": "Request was denied due to request throttling.", + "smithy.api#documentation": "The request was denied due to request throttling.
", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": {} @@ -4272,7 +4276,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes tags from the specified resource.", + "smithy.api#documentation": "Removes the specified tags from an Amazon Managed Service for Prometheus resource. The only resources\n that can be tagged are workspaces and rule groups namespaces.
", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{resourceArn}" @@ -4286,7 +4290,7 @@ "resourceArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The ARN of the resource.", + "smithy.api#documentation": "The ARN of the workspace or rule groups namespace.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4294,7 +4298,7 @@ "tagKeys": { "target": "com.amazonaws.amp#TagKeys", "traits": { - "smithy.api#documentation": "One or more tag keys", + "smithy.api#documentation": "The keys of the tags to remove.
", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } @@ -4331,7 +4335,7 @@ } ], "traits": { - "smithy.api#documentation": "Update logging configuration.", + "smithy.api#documentation": "Updates the log group ARN or the workspace ID of the current logging\n configuration.
", "smithy.api#http": { "code": 202, "method": "PUT", @@ -4346,7 +4350,7 @@ "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "The ID of the workspace to vend logs to.", + "smithy.api#documentation": "The ID of the workspace to update the logging configuration for.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4354,20 +4358,20 @@ "logGroupArn": { "target": "com.amazonaws.amp#LogGroupArn", "traits": { - "smithy.api#documentation": "The ARN of the CW log group to which the vended log data will be published.", + "smithy.api#documentation": "The ARN of the CloudWatch log group to which the vended log data will be\n published.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.amp#IdempotencyToken", "traits": { - "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#documentation": "A unique identifier that you can provide to ensure the idempotency of the request.\n Case-sensitive.
", "smithy.api#idempotencyToken": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of an UpdateLoggingConfiguration operation." + "smithy.api#documentation": "Represents the input of an UpdateLoggingConfiguration operation.
A structure that contains the current status of the logging configuration.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the output of an UpdateLoggingConfiguration operation." + "smithy.api#documentation": "Represents the output of an UpdateLoggingConfiguration operation.
Updates the alias of an existing workspace.
", "smithy.api#http": { "code": 204, "method": "POST", @@ -4432,7 +4436,7 @@ "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "The ID of the workspace being updated.", + "smithy.api#documentation": "The ID of the workspace to update.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4440,19 +4444,19 @@ "alias": { "target": "com.amazonaws.amp#WorkspaceAlias", "traits": { - "smithy.api#documentation": "The new alias of the workspace." + "smithy.api#documentation": "The new alias for the workspace. It does not need to be unique.
\nAmazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning\n and end of the alias that you specify.
" } }, "clientToken": { "target": "com.amazonaws.amp#IdempotencyToken", "traits": { - "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#documentation": "A unique identifier that you can provide to ensure the idempotency of the request.\n Case-sensitive.
", "smithy.api#idempotencyToken": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of an UpdateWorkspaceAlias operation." + "smithy.api#documentation": "Represents the input of an UpdateWorkspaceAlias operation.
Description of the error.
", "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.amp#ValidationExceptionReason", "traits": { - "smithy.api#documentation": "Reason the request failed validation.", + "smithy.api#documentation": "Reason the request failed validation.
", "smithy.api#required": {} } }, "fieldList": { "target": "com.amazonaws.amp#ValidationExceptionFieldList", "traits": { - "smithy.api#documentation": "The field that caused the error, if applicable. If more than one field caused the error, pick one and elaborate in the message." + "smithy.api#documentation": "The field that caused the error, if applicable.
" } } }, "traits": { - "smithy.api#documentation": "The input fails to satisfy the constraints specified by an AWS service.", + "smithy.api#documentation": "The input fails to satisfy the constraints specified by an Amazon Web Services\n service.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -4500,20 +4504,20 @@ "name": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The field name.", + "smithy.api#documentation": "The name of the field that caused an exception.
", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Message describing why the field failed validation.", + "smithy.api#documentation": "A message describing why the field caused an exception.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Stores information about a field passed inside a request that resulted in an exception." + "smithy.api#documentation": "Information about a field passed into a request that resulted in an exception.
" } }, "com.amazonaws.amp#ValidationExceptionFieldList": { @@ -4522,13 +4526,13 @@ "target": "com.amazonaws.amp#ValidationExceptionField" }, "traits": { - "smithy.api#documentation": "A list of fields." + "smithy.api#documentation": "A list of fields.
" } }, "com.amazonaws.amp#ValidationExceptionReason": { "type": "string", "traits": { - "smithy.api#documentation": "Possible reasons a request failed validation.", + "smithy.api#documentation": "Possible reasons a request failed validation.
", "smithy.api#enum": [ { "name": "UNKNOWN_OPERATION", @@ -4586,13 +4590,13 @@ "aws.api#arn": { "template": "workspace/{workspaceId}" }, - "smithy.api#documentation": "An AMP workspace is a logical and isolated Prometheus server dedicated to Prometheus resources such as metrics, where you ingest, store, and query your Prometheus metrics." + "smithy.api#documentation": "An Amazon Managed Service for Prometheus workspace is a logical and isolated Prometheus server \n dedicated to ingesting, storing, and querying your Prometheus-compatible metrics.
" } }, "com.amazonaws.amp#WorkspaceAlias": { "type": "string", "traits": { - "smithy.api#documentation": "A user-assigned workspace alias.", + "smithy.api#documentation": "A user-assigned workspace alias.
", "smithy.api#length": { "min": 1, "max": 100 @@ -4607,7 +4611,7 @@ "service": "ManagedPrometheusCP", "resource": "Workspace" }, - "smithy.api#documentation": "An ARN identifying a Workspace.", + "smithy.api#documentation": "An ARN identifying a Workspace.
", "smithy.api#pattern": "^arn:aws[-a-z]*:aps:[-a-z0-9]+:[0-9]{12}:workspace/.+$" } }, @@ -4617,58 +4621,58 @@ "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "Unique string identifying this workspace.", + "smithy.api#documentation": "The unique ID for the workspace.
", "smithy.api#required": {} } }, "alias": { "target": "com.amazonaws.amp#WorkspaceAlias", "traits": { - "smithy.api#documentation": "Alias of this workspace." + "smithy.api#documentation": "The alias that is assigned to this workspace to help identify it. It may not be\n unique.
" } }, "arn": { "target": "com.amazonaws.amp#WorkspaceArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of this workspace.", + "smithy.api#documentation": "The ARN of the workspace.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.amp#WorkspaceStatus", "traits": { - "smithy.api#documentation": "The status of this workspace.", + "smithy.api#documentation": "The current status of the workspace.
", "smithy.api#required": {} } }, "prometheusEndpoint": { "target": "com.amazonaws.amp#Uri", "traits": { - "smithy.api#documentation": "Prometheus endpoint URI." + "smithy.api#documentation": "The Prometheus endpoint available for this workspace.
" } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the workspace was created.", + "smithy.api#documentation": "The date and time that the workspace was created.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.amp#TagMap", "traits": { - "smithy.api#documentation": "The tags of this workspace." + "smithy.api#documentation": "The list of tag keys and values that are associated with the workspace.
" } }, "kmsKeyArn": { "target": "com.amazonaws.amp#KmsKeyArn", "traits": { - "smithy.api#documentation": "The customer managed KMS key of this workspace." + "smithy.api#documentation": "(optional) If the workspace was created with a customer managed KMS \n key, the ARN for the key used.
" } } }, "traits": { - "smithy.api#documentation": "Represents the properties of a workspace.", + "smithy.api#documentation": "The full details about one Amazon Managed Service for Prometheus workspace in your account.
", "smithy.api#references": [ { "resource": "com.amazonaws.amp#Workspace" @@ -4679,7 +4683,7 @@ "com.amazonaws.amp#WorkspaceId": { "type": "string", "traits": { - "smithy.api#documentation": "A workspace ID.", + "smithy.api#documentation": "A workspace ID.
", "smithy.api#length": { "min": 1, "max": 64 @@ -4693,19 +4697,19 @@ "statusCode": { "target": "com.amazonaws.amp#WorkspaceStatusCode", "traits": { - "smithy.api#documentation": "Status code of this workspace.", + "smithy.api#documentation": "The current status of the workspace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the status of a workspace." + "smithy.api#documentation": "The status of the workspace.
" } }, "com.amazonaws.amp#WorkspaceStatusCode": { "type": "string", "traits": { - "smithy.api#documentation": "State of a workspace.", + "smithy.api#documentation": "State of a workspace.
", "smithy.api#enum": [ { "name": "CREATING", @@ -4741,52 +4745,52 @@ "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "Unique string identifying this workspace.", + "smithy.api#documentation": "The unique ID for the workspace.
", "smithy.api#required": {} } }, "alias": { "target": "com.amazonaws.amp#WorkspaceAlias", "traits": { - "smithy.api#documentation": "Alias of this workspace." + "smithy.api#documentation": "The alias that is assigned to this workspace to help identify it. It may not be\n unique.
" } }, "arn": { "target": "com.amazonaws.amp#WorkspaceArn", "traits": { - "smithy.api#documentation": "The AmazonResourceName of this workspace.", + "smithy.api#documentation": "The ARN of the workspace.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.amp#WorkspaceStatus", "traits": { - "smithy.api#documentation": "The status of this workspace.", + "smithy.api#documentation": "The current status of the workspace.
", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the workspace was created.", + "smithy.api#documentation": "The date and time that the workspace was created.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.amp#TagMap", "traits": { - "smithy.api#documentation": "The tags of this workspace." + "smithy.api#documentation": "The list of tag keys and values that are associated with the workspace.
" } }, "kmsKeyArn": { "target": "com.amazonaws.amp#KmsKeyArn", "traits": { - "smithy.api#documentation": "Customer managed KMS key ARN for this workspace" + "smithy.api#documentation": "(optional) If the workspace was created with a customer managed KMS \n key, the ARN for the key used.
" } } }, "traits": { - "smithy.api#documentation": "Represents a summary of the properties of a workspace.", + "smithy.api#documentation": "The information about one Amazon Managed Service for Prometheus workspace in your account.
", "smithy.api#references": [ { "resource": "com.amazonaws.amp#Workspace" @@ -4800,7 +4804,7 @@ "target": "com.amazonaws.amp#WorkspaceSummary" }, "traits": { - "smithy.api#documentation": "A list of workspace summaries." + "smithy.api#documentation": "A list of workspace summaries.
" } } }