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.
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.
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.
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. Scrapers are flexible, and can be configured to control what metrics are collected, the frequency of collection, what transformations are applied to the metrics, and more.
An IAM role will be created for you that Amazon Managed Service for Prometheus uses to access the metrics in your cluster. You must configure this role with a policy that allows it to scrape metrics from your cluster. For more information, see Configuring your Amazon EKS cluster in the Amazon Managed Service for Prometheus User Guide.
The scrapeConfiguration parameter contains the base-64 encoded YAML configuration for the scraper.
For more information about collectors, including what metrics are collected, and how to configure the scraper, see Using an Amazon Web Services managed collector in the Amazon Managed Service for Prometheus User Guide.
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.
", "DeleteAlertManagerDefinition": "Deletes the alert manager definition from a workspace.
", "DeleteLoggingConfiguration": "Deletes the logging configuration for a workspace.
", "DeleteRuleGroupsNamespace": "Deletes one rule groups namespace and its associated rule groups definition.
", "DeleteScraper": "The DeleteScraper operation deletes one scraper, and stops any metrics collection that the scraper performs.
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.
Retrieves the full information about the alert manager definition for a workspace.
", "DescribeLoggingConfiguration": "Returns complete information about the current logging configuration of the workspace.
", "DescribeRuleGroupsNamespace": "Returns complete information about one rule groups namespace. To retrieve a list of rule groups namespaces, use ListRuleGroupsNamespaces.
The DescribeScraper operation displays information about an existing scraper.
Returns information about an existing workspace.
", "GetDefaultScraperConfiguration": "The GetDefaultScraperConfiguration operation returns the default scraper configuration used when Amazon EKS creates a scraper for you.
Returns a list of rule groups namespaces in a workspace.
", "ListScrapers": "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.
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 scrapers, workspaces, and rule groups namespaces.
Lists all of the Amazon Managed Service for Prometheus workspaces in your account. This includes workspaces being created or deleted.
", "PutAlertManagerDefinition": "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.
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.
The TagResource operation associates tags with an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are rule groups namespaces, scrapers, and workspaces.
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. To remove a tag, use UntagResource.
Removes the specified tags from an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are rule groups namespaces, scrapers, and workspaces.
", "UpdateLoggingConfiguration": "Updates the log group ARN or the workspace ID of the current logging configuration.
", "UpdateScraper": "Updates an existing scraper.
You can't use this function to update the source from which the scraper is collecting metrics. To change the source, delete the scraper and create a new one.
", "UpdateWorkspaceAlias": "Updates the alias of an existing workspace.
" }, "shapes": { "AccessDeniedException": { "base": "You do not have sufficient access to perform this action.
", "refs": { } }, "AlertManagerDefinitionData": { "base": "The base-64 encoded blob that is alert manager definition.
For details about the alert manager definition, see AlertManagedDefinitionData.
", "refs": { "AlertManagerDefinitionDescription$data": "The actual alert manager definition.
For details about the alert manager definition, see AlertManagedDefinitionData.
", "CreateAlertManagerDefinitionRequest$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.
", "PutAlertManagerDefinitionRequest$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.
" } }, "AlertManagerDefinitionDescription": { "base": "The details of an alert manager definition. It is the configuration for the alert manager, including information about receivers for routing alerts.
", "refs": { "DescribeAlertManagerDefinitionResponse$alertManagerDefinition": "The alert manager definition.
" } }, "AlertManagerDefinitionStatus": { "base": "The status of the alert manager.
", "refs": { "AlertManagerDefinitionDescription$status": "A structure that displays the current status of the alert manager definition..
", "CreateAlertManagerDefinitionResponse$status": "A structure that displays the current status of the alert manager definition.
", "PutAlertManagerDefinitionResponse$status": "A structure that returns the current status of the alert manager definition.
" } }, "AlertManagerDefinitionStatusCode": { "base": "State of an AlertManagerDefinition.
The current status of the alert manager.
" } }, "AmpConfiguration": { "base": "The AmpConfiguration structure defines the Amazon Managed Service for Prometheus instance a scraper should send metrics to.
The Amazon Managed Service for Prometheus workspace to send metrics to.
" } }, "Blob": { "base": null, "refs": { "GetDefaultScraperConfigurationResponse$configuration": "The configuration file. Base 64 encoded. For more information, see Scraper configurationin the Amazon Managed Service for Prometheus User Guide.
", "ScrapeConfiguration$configurationBlob": "The base 64 encoded scrape configuration file.
" } }, "ClusterArn": { "base": "The ARN of an EKS cluster.
", "refs": { "EksConfiguration$clusterArn": "ARN of the Amazon EKS cluster.
" } }, "ConflictException": { "base": "The request would cause an inconsistent state.
", "refs": { } }, "CreateAlertManagerDefinitionRequest": { "base": "Represents the input of a CreateAlertManagerDefinition operation.
Represents the output of a CreateAlertManagerDefinition operation.
Represents the input of a CreateLoggingConfiguration operation.
Represents the output of a CreateLoggingConfiguration operation.
Represents the input of a CreateRuleGroupsNamespace operation.
Represents the output of a CreateRuleGroupsNamespace operation.
Represents the input of a CreateScraper operation.
Represents the output of a CreateScraper operation.
Represents the input of a CreateWorkspace operation.
Represents the output of a CreateWorkspace operation.
Represents the input of a DeleteAlertManagerDefinition operation.
Represents the input of a DeleteLoggingConfiguration operation.
Represents the input of a DeleteRuleGroupsNamespace operation.
Represents the input of a DeleteScraper operation.
Represents the output of a DeleteScraper operation.
Represents the input of a DeleteWorkspace operation.
Represents the input of a DescribeAlertManagerDefinition operation.
Represents the output of a DescribeAlertManagerDefinition operation.
Represents the input of a DescribeLoggingConfiguration operation.
Represents the output of a DescribeLoggingConfiguration operation.
Represents the input of a DescribeRuleGroupsNamespace operation.
Represents the output of a DescribeRuleGroupsNamespace operation.
Represents the input of a DescribeScraper operation.
Represents the output of a DescribeScraper operation.
Represents the input of a DescribeWorkspace operation.
Represents the output of a DescribeWorkspace operation.
Where to send the metrics from a scraper.
", "refs": { "CreateScraperRequest$destination": "The Amazon Managed Service for Prometheus workspace to send metrics to.
", "ScraperDescription$destination": "The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
", "ScraperSummary$destination": "The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
", "UpdateScraperRequest$destination": "The new Amazon Managed Service for Prometheus workspace to send metrics to.
" } }, "EksConfiguration": { "base": "The EksConfiguration structure describes the connection to the Amazon EKS cluster from which a scraper collects metrics.
The Amazon EKS cluster from which a scraper collects metrics.
" } }, "FilterKey": { "base": "The name of the key by which to filter.
", "refs": { "ScraperFilters$key": "The name of the key to filter by. Currently supported filter keys are status, sourceArn, destinationArn, and alias.
The value for a given key by which to filter.
", "refs": { "FilterValues$member": null } }, "FilterValues": { "base": "A list of scraper filter values.
", "refs": { "ScraperFilters$value": "The values of the given key by which to filter.
" } }, "GetDefaultScraperConfigurationRequest": { "base": "Represents the input of a GetDefaultScraperConfiguration operation.
Represents the output of a GetDefaultScraperConfiguration operation.
An ARN identifying an IAM role used by the scraper.
", "refs": { "ScraperDescription$roleArn": "The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.
For example, arn:aws:iam::123456789012:role/service-role/AmazonGrafanaServiceRole-12example.
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.
" } }, "IdempotencyToken": { "base": "An identifier used to ensure the idempotency of a write request.
", "refs": { "CreateAlertManagerDefinitionRequest$clientToken": "A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "CreateLoggingConfigurationRequest$clientToken": "A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "CreateRuleGroupsNamespaceRequest$clientToken": "A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "CreateScraperRequest$clientToken": "(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.
", "CreateWorkspaceRequest$clientToken": "A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "DeleteAlertManagerDefinitionRequest$clientToken": "A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "DeleteLoggingConfigurationRequest$clientToken": "A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "DeleteRuleGroupsNamespaceRequest$clientToken": "A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "DeleteScraperRequest$clientToken": "(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.
", "DeleteWorkspaceRequest$clientToken": "A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "PutAlertManagerDefinitionRequest$clientToken": "A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "PutRuleGroupsNamespaceRequest$clientToken": "A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "UpdateLoggingConfigurationRequest$clientToken": "A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "UpdateScraperRequest$clientToken": "A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "UpdateWorkspaceAliasRequest$clientToken": "A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
" } }, "Integer": { "base": null, "refs": { "InternalServerException$retryAfterSeconds": "Advice to clients on when the call can be safely retried.
", "ThrottlingException$retryAfterSeconds": "Advice to clients on when the call can be safely retried.
" } }, "InternalServerException": { "base": "An unexpected error occurred during the processing of the request.
", "refs": { } }, "KmsKeyArn": { "base": "A KMS Key ARN.
", "refs": { "CreateWorkspaceRequest$kmsKeyArn": "(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.
", "CreateWorkspaceResponse$kmsKeyArn": "(optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.
", "WorkspaceDescription$kmsKeyArn": "(optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.
", "WorkspaceSummary$kmsKeyArn": "(optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.
" } }, "ListRuleGroupsNamespacesRequest": { "base": "Represents the input of a ListRuleGroupsNamespaces operation.
The maximum number of results to return. The default is 100.
" } }, "ListRuleGroupsNamespacesResponse": { "base": "Represents the output of a ListRuleGroupsNamespaces operation.
Represents the input of a ListScrapers operation.
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.
" } }, "ListScrapersResponse": { "base": "Represents the output of a ListScrapers operation.
Represents the input of a ListWorkspaces operation.
The maximum number of workspaces to return per request. The default is 100.
" } }, "ListWorkspacesResponse": { "base": "Represents the output of a ListWorkspaces operation.
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 operation.
", "LoggingConfigurationMetadata$logGroupArn": "The ARN of the CloudWatch log group to which the vended log data will be published.
", "UpdateLoggingConfigurationRequest$logGroupArn": "The ARN of the CloudWatch log group to which the vended log data will be published.
" } }, "LoggingConfigurationMetadata": { "base": "Contains information about the logging configuration for the workspace.
", "refs": { "DescribeLoggingConfigurationResponse$loggingConfiguration": "A structure that displays the information about the logging configuration.
" } }, "LoggingConfigurationStatus": { "base": "The status of the logging configuration.
", "refs": { "CreateLoggingConfigurationResponse$status": "A structure that displays the current status of the logging configuration.
", "LoggingConfigurationMetadata$status": "The current status of the logging configuration.
", "UpdateLoggingConfigurationResponse$status": "A structure that contains the current status of the logging configuration.
" } }, "LoggingConfigurationStatusCode": { "base": "State of a logging configuration.
", "refs": { "LoggingConfigurationStatus$statusCode": "The current status of the logging configuration.
" } }, "PaginationToken": { "base": "A token used to access the next page in a paginated result set.
", "refs": { "ListRuleGroupsNamespacesRequest$nextToken": "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.
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.
(Optional) The token for the next set of items to return. (You received this token from a previous call.)
", "ListScrapersResponse$nextToken": "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 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.
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 PutAlertManagerDefinition operation.
Represents the output of a PutAlertManagerDefinition operation.
Represents the input of a PutRuleGroupsNamespace operation.
Represents the output of a PutRuleGroupsNamespace operation.
The request references a resources that doesn't exist.
", "refs": { } }, "RuleGroupsNamespaceArn": { "base": "An ARN identifying a rule groups namespace.
", "refs": { "CreateRuleGroupsNamespaceResponse$arn": "The Amazon Resource Name (ARN) of the new rule groups namespace.
", "PutRuleGroupsNamespaceResponse$arn": "The ARN of the rule groups namespace.
", "RuleGroupsNamespaceDescription$arn": "The ARN of the rule groups namespace. For example, arn:aws:aps:<region>:123456789012:rulegroupsnamespace/ws-example1-1234-abcd-5678-ef90abcd1234/rulesfile1.
The ARN of the rule groups namespace.
" } }, "RuleGroupsNamespaceData": { "base": "The rule groups namespace data.
", "refs": { "CreateRuleGroupsNamespaceRequest$data": "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.
", "PutRuleGroupsNamespaceRequest$data": "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.
", "RuleGroupsNamespaceDescription$data": "The rule groups file used in the namespace.
For details about the rule groups namespace structure, see RuleGroupsNamespaceData.
" } }, "RuleGroupsNamespaceDescription": { "base": "The details about one rule groups namespace.
", "refs": { "DescribeRuleGroupsNamespaceResponse$ruleGroupsNamespace": "The information about the rule groups namespace.
" } }, "RuleGroupsNamespaceName": { "base": "The name of the namespace that the rule group belong to.
", "refs": { "CreateRuleGroupsNamespaceRequest$name": "The name for the new rule groups namespace.
", "CreateRuleGroupsNamespaceResponse$name": "The name of the new rule groups namespace.
", "DeleteRuleGroupsNamespaceRequest$name": "The name of the rule groups namespace to delete.
", "DescribeRuleGroupsNamespaceRequest$name": "The name of the rule groups namespace that you want information for.
", "ListRuleGroupsNamespacesRequest$name": "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.
", "PutRuleGroupsNamespaceRequest$name": "The name of the rule groups namespace that you are updating.
", "PutRuleGroupsNamespaceResponse$name": "The name of the rule groups namespace that was updated.
", "RuleGroupsNamespaceDescription$name": "The name of the rule groups namespace.
", "RuleGroupsNamespaceSummary$name": "The name of the rule groups namespace.
" } }, "RuleGroupsNamespaceStatus": { "base": "The status information about a rule groups namespace.
", "refs": { "CreateRuleGroupsNamespaceResponse$status": "A structure that returns the current status of the rule groups namespace.
", "PutRuleGroupsNamespaceResponse$status": "A structure that includes the current status of the rule groups namespace.
", "RuleGroupsNamespaceDescription$status": "The current status of the rule groups namespace.
", "RuleGroupsNamespaceSummary$status": "A structure that displays the current status of the rule groups namespace.
" } }, "RuleGroupsNamespaceStatusCode": { "base": "State of a namespace.
", "refs": { "RuleGroupsNamespaceStatus$statusCode": "The current status of the namespace.
" } }, "RuleGroupsNamespaceSummary": { "base": "The high-level information about a rule groups namespace. To retrieve more information, use DescribeRuleGroupsNamespace.
A list of rule groups namespace summary.
", "refs": { "ListRuleGroupsNamespacesResponse$ruleGroupsNamespaces": "The returned list of rule groups namespaces.
" } }, "ScrapeConfiguration": { "base": "A scrape configuration for a scraper, base 64 encoded. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User Guide.
", "refs": { "CreateScraperRequest$scrapeConfiguration": "The configuration file to use in the new scraper. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User Guide.
", "ScraperDescription$scrapeConfiguration": "The configuration in use by the scraper.
", "UpdateScraperRequest$scrapeConfiguration": "Contains the base-64 encoded YAML configuration for the scraper.
For more information about configuring a scraper, see Using an Amazon Web Services managed collector in the Amazon Managed Service for Prometheus User Guide.
An optional user-assigned scraper alias.
", "refs": { "CreateScraperRequest$alias": "(optional) An alias to associate with the scraper. This is for your use, and does not need to be unique.
", "ScraperDescription$alias": "(Optional) A name associated with the scraper.
", "ScraperSummary$alias": "(Optional) A name associated with the scraper.
", "UpdateScraperRequest$alias": "The new alias of the scraper.
" } }, "ScraperArn": { "base": "An ARN identifying a scrape configuration.
", "refs": { "CreateScraperResponse$arn": "The Amazon Resource Name (ARN) of the new scraper.
", "ScraperDescription$arn": "The Amazon Resource Name (ARN) of the scraper. For example, arn:aws:aps:<region>:123456798012:scraper/s-example1-1234-abcd-5678-ef9012abcd34.
The Amazon Resource Name (ARN) of the scraper.
", "UpdateScraperResponse$arn": "The Amazon Resource Name (ARN) of the updated scraper.
" } }, "ScraperDescription": { "base": "The ScraperDescription structure contains the full details about one scraper in your account.
Contains details about the scraper.
" } }, "ScraperFilters": { "base": "A list of scraper filters.
", "refs": { "ListScrapersRequest$filters": "(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.
" } }, "ScraperId": { "base": "A scraper ID.
", "refs": { "CreateScraperResponse$scraperId": "The ID of the new scraper.
", "DeleteScraperRequest$scraperId": "The ID of the scraper to delete.
", "DeleteScraperResponse$scraperId": "The ID of the scraper to delete.
", "DescribeScraperRequest$scraperId": "The ID of the scraper to describe.
", "ScraperDescription$scraperId": "The ID of the scraper. For example, s-example1-1234-abcd-5678-ef9012abcd34.
The ID of the scraper.
", "UpdateScraperRequest$scraperId": "The ID of the scraper to update.
", "UpdateScraperResponse$scraperId": "The ID of the updated scraper.
" } }, "ScraperStatus": { "base": "The ScraperStatus structure contains status information about the scraper.
A structure that displays the current status of the scraper.
", "DeleteScraperResponse$status": "The current status of the scraper.
", "ScraperDescription$status": "A structure that contains the current status of the scraper.
", "ScraperSummary$status": "A structure that contains the current status of the scraper.
", "UpdateScraperResponse$status": "A structure that displays the current status of the scraper.
" } }, "ScraperStatusCode": { "base": "State of a scraper.
", "refs": { "ScraperStatus$statusCode": "The current status of the scraper.
" } }, "ScraperSummary": { "base": "The ScraperSummary structure contains a summary of the details about one scraper in your account.
A list of scraper summaries.
", "refs": { "ListScrapersResponse$scrapers": "A list of ScraperSummary structures giving information about scrapers in the account that match the filters provided.
ID of a VPC security group.
", "refs": { "SecurityGroupIds$member": null } }, "SecurityGroupIds": { "base": "A list of security group IDs specified for VPC configuration.
", "refs": { "EksConfiguration$securityGroupIds": "A list of the security group IDs for the Amazon EKS cluster VPC configuration.
" } }, "ServiceQuotaExceededException": { "base": "Completing the request would cause a service quota to be exceeded.
", "refs": { } }, "Source": { "base": "The source of collected metrics for a scraper.
", "refs": { "CreateScraperRequest$source": "The Amazon EKS cluster from which the scraper will collect metrics.
", "ScraperDescription$source": "The Amazon EKS cluster from which the scraper collects metrics.
", "ScraperSummary$source": "The Amazon EKS cluster from which the scraper collects metrics.
" } }, "StatusReason": { "base": "The reason for the failure, if any.
", "refs": { "ScraperDescription$statusReason": "If there is a failure, the reason for the failure.
", "ScraperSummary$statusReason": "If there is a failure, the reason for the failure.
" } }, "String": { "base": null, "refs": { "AccessDeniedException$message": "Description of the error.
", "AlertManagerDefinitionStatus$statusReason": "If there is a failure, the reason for the failure.
", "ConflictException$message": "Description of the error.
", "ConflictException$resourceId": "Identifier of the resource affected.
", "ConflictException$resourceType": "Type of the resource affected.
", "InternalServerException$message": "Description of the error.
", "ListTagsForResourceRequest$resourceArn": "The ARN of the resource to list tages for. Must be a workspace, scraper, or rule groups namespace resource.
", "LoggingConfigurationStatus$statusReason": "If failed, the reason for the failure.
", "ResourceNotFoundException$message": "Description of the error.
", "ResourceNotFoundException$resourceId": "Identifier of the resource affected.
", "ResourceNotFoundException$resourceType": "Type of the resource affected.
", "RuleGroupsNamespaceStatus$statusReason": "The reason for the failure, if any.
", "ServiceQuotaExceededException$message": "Description of the error.
", "ServiceQuotaExceededException$quotaCode": "Service quotas code of the originating quota.
", "ServiceQuotaExceededException$resourceId": "Identifier of the resource affected.
", "ServiceQuotaExceededException$resourceType": "Type of the resource affected.
", "ServiceQuotaExceededException$serviceCode": "Service quotas code for the originating service.
", "TagResourceRequest$resourceArn": "The ARN of the resource to apply tags to.
", "ThrottlingException$message": "Description of the error.
", "ThrottlingException$quotaCode": "Service quotas code for the originating quota.
", "ThrottlingException$serviceCode": "Service quotas code for the originating service.
", "UntagResourceRequest$resourceArn": "The ARN of the resource from which to remove a tag.
", "ValidationException$message": "Description of the error.
", "ValidationExceptionField$message": "A message describing why the field caused an exception.
", "ValidationExceptionField$name": "The name of the field that caused an exception.
" } }, "SubnetId": { "base": "ID of a VPC subnet.
", "refs": { "SubnetIds$member": null } }, "SubnetIds": { "base": "A list of subnet IDs specified for VPC configuration.
", "refs": { "EksConfiguration$subnetIds": "A list of subnet IDs for the Amazon EKS cluster VPC configuration.
" } }, "TagKey": { "base": null, "refs": { "TagKeys$member": null, "TagMap$key": "The key of the tag. Must not begin with aws:.
The keys of the tags to remove.
" } }, "TagMap": { "base": "A tag associated with a resource.
", "refs": { "CreateRuleGroupsNamespaceRequest$tags": "The list of tag keys and values to associate with the rule groups namespace.
", "CreateRuleGroupsNamespaceResponse$tags": "The list of tag keys and values that are associated with the namespace.
", "CreateScraperRequest$tags": "(Optional) The list of tag keys and values to associate with the scraper.
", "CreateScraperResponse$tags": "The list of tag keys and values that are associated with the scraper.
", "CreateWorkspaceRequest$tags": "The list of tag keys and values to associate with the workspace.
", "CreateWorkspaceResponse$tags": "The list of tag keys and values that are associated with the workspace.
", "ListTagsForResourceResponse$tags": "The list of tag keys and values associated with the resource.
", "PutRuleGroupsNamespaceResponse$tags": "The list of tag keys and values that are associated with the namespace.
", "RuleGroupsNamespaceDescription$tags": "The list of tag keys and values that are associated with the rule groups namespace.
", "RuleGroupsNamespaceSummary$tags": "The list of tag keys and values that are associated with the rule groups namespace.
", "ScraperDescription$tags": "(Optional) The list of tag keys and values associated with the scraper.
", "ScraperSummary$tags": "(Optional) The list of tag keys and values associated with the scraper.
", "TagResourceRequest$tags": "The list of tag keys and values to associate with the resource.
Keys must not begin with aws:.
The list of tag keys and values that are associated with the scraper.
", "WorkspaceDescription$tags": "The list of tag keys and values that are associated with the workspace.
", "WorkspaceSummary$tags": "The list of tag keys and values that are associated with the workspace.
" } }, "TagResourceRequest": { "base": null, "refs": { } }, "TagResourceResponse": { "base": null, "refs": { } }, "TagValue": { "base": null, "refs": { "TagMap$value": "The value of the tag.
" } }, "ThrottlingException": { "base": "The request was denied due to request throttling.
", "refs": { } }, "Timestamp": { "base": null, "refs": { "AlertManagerDefinitionDescription$createdAt": "The date and time that the alert manager definition was created.
", "AlertManagerDefinitionDescription$modifiedAt": "The date and time that the alert manager definition was most recently changed.
", "LoggingConfigurationMetadata$createdAt": "The date and time that the logging configuration was created.
", "LoggingConfigurationMetadata$modifiedAt": "The date and time that the logging configuration was most recently changed.
", "RuleGroupsNamespaceDescription$createdAt": "The date and time that the rule groups namespace was created.
", "RuleGroupsNamespaceDescription$modifiedAt": "The date and time that the rule groups namespace was most recently changed.
", "RuleGroupsNamespaceSummary$createdAt": "The date and time that the rule groups namespace was created.
", "RuleGroupsNamespaceSummary$modifiedAt": "The date and time that the rule groups namespace was most recently changed.
", "ScraperDescription$createdAt": "The date and time that the scraper was created.
", "ScraperDescription$lastModifiedAt": "The date and time that the scraper was last modified.
", "ScraperSummary$createdAt": "The date and time that the scraper was created.
", "ScraperSummary$lastModifiedAt": "The date and time that the scraper was last modified.
", "WorkspaceDescription$createdAt": "The date and time that the workspace was created.
", "WorkspaceSummary$createdAt": "The date and time that the workspace was created.
" } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UntagResourceResponse": { "base": null, "refs": { } }, "UpdateLoggingConfigurationRequest": { "base": "Represents the input of an UpdateLoggingConfiguration operation.
Represents the output of an UpdateLoggingConfiguration operation.
Represents the input of an UpdateWorkspaceAlias operation.
The Prometheus endpoint available for this workspace. For example, https://aps-workspaces.<region>.amazonaws.com/workspaces/ws-example1-1234-abcd-5678-ef90abcd1234/api/v1/.
The input fails to satisfy the constraints specified by an Amazon Web Services service.
", "refs": { } }, "ValidationExceptionField": { "base": "Information about a field passed into a request that resulted in an exception.
", "refs": { "ValidationExceptionFieldList$member": null } }, "ValidationExceptionFieldList": { "base": "A list of fields.
", "refs": { "ValidationException$fieldList": "The field that caused the error, if applicable.
" } }, "ValidationExceptionReason": { "base": "Possible reasons a request failed validation.
", "refs": { "ValidationException$reason": "Reason the request failed validation.
" } }, "WorkspaceAlias": { "base": "A user-assigned workspace alias.
", "refs": { "CreateWorkspaceRequest$alias": "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.
", "ListWorkspacesRequest$alias": "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.
", "UpdateWorkspaceAliasRequest$alias": "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.
", "WorkspaceDescription$alias": "The alias that is assigned to this workspace to help identify it. It does not need to be unique.
", "WorkspaceSummary$alias": "The alias that is assigned to this workspace to help identify it. It does not need to be unique.
" } }, "WorkspaceArn": { "base": "An ARN identifying a Workspace.
", "refs": { "AmpConfiguration$workspaceArn": "ARN of the Amazon Managed Service for Prometheus workspace.
", "CreateWorkspaceResponse$arn": "The ARN for the new workspace.
", "WorkspaceDescription$arn": "The ARN of the workspace. For example, arn:aws:aps:<region>:123456789012:workspace/ws-example1-1234-abcd-5678-ef90abcd1234.
The ARN of the workspace.
" } }, "WorkspaceDescription": { "base": "The full details about one Amazon Managed Service for Prometheus workspace in your account.
", "refs": { "DescribeWorkspaceResponse$workspace": "A structure that contains details about the workspace.
" } }, "WorkspaceId": { "base": "A workspace ID.
", "refs": { "CreateAlertManagerDefinitionRequest$workspaceId": "The ID of the workspace to add the alert manager definition to.
", "CreateLoggingConfigurationRequest$workspaceId": "The ID of the workspace to create the logging configuration for.
", "CreateRuleGroupsNamespaceRequest$workspaceId": "The ID of the workspace to add the rule groups namespace.
", "CreateWorkspaceResponse$workspaceId": "The unique ID for the new workspace.
", "DeleteAlertManagerDefinitionRequest$workspaceId": "The ID of the workspace to delete the alert manager definition from.
", "DeleteLoggingConfigurationRequest$workspaceId": "The ID of the workspace containing the logging configuration to delete.
", "DeleteRuleGroupsNamespaceRequest$workspaceId": "The ID of the workspace containing the rule groups namespace and definition to delete.
", "DeleteWorkspaceRequest$workspaceId": "The ID of the workspace to delete.
", "DescribeAlertManagerDefinitionRequest$workspaceId": "The ID of the workspace to retrieve the alert manager definition from.
", "DescribeLoggingConfigurationRequest$workspaceId": "The ID of the workspace to describe the logging configuration for.
", "DescribeRuleGroupsNamespaceRequest$workspaceId": "The ID of the workspace containing the rule groups namespace.
", "DescribeWorkspaceRequest$workspaceId": "The ID of the workspace to describe.
", "ListRuleGroupsNamespacesRequest$workspaceId": "The ID of the workspace containing the rule groups namespaces.
", "LoggingConfigurationMetadata$workspace": "The ID of the workspace the logging configuration is for.
", "PutAlertManagerDefinitionRequest$workspaceId": "The ID of the workspace to update the alert manager definition in.
", "PutRuleGroupsNamespaceRequest$workspaceId": "The ID of the workspace where you are updating the rule groups namespace.
", "UpdateLoggingConfigurationRequest$workspaceId": "The ID of the workspace to update the logging configuration for.
", "UpdateWorkspaceAliasRequest$workspaceId": "The ID of the workspace to update.
", "WorkspaceDescription$workspaceId": "The unique ID for the workspace. For example, ws-example1-1234-abcd-5678-ef90abcd1234.
The unique ID for the workspace.
" } }, "WorkspaceStatus": { "base": "The status of the workspace.
", "refs": { "CreateWorkspaceResponse$status": "The current status of the new workspace. Immediately after you create the workspace, the status is usually CREATING.
The current status of the workspace.
", "WorkspaceSummary$status": "The current status of the workspace.
" } }, "WorkspaceStatusCode": { "base": "State of a workspace.
", "refs": { "WorkspaceStatus$statusCode": "The current status of the workspace.
" } }, "WorkspaceSummary": { "base": "The information about one Amazon Managed Service for Prometheus workspace in your account.
", "refs": { "WorkspaceSummaryList$member": null } }, "WorkspaceSummaryList": { "base": "A list of workspace summaries.
", "refs": { "ListWorkspacesResponse$workspaces": "An array of WorkspaceSummary structures containing information about the workspaces requested.