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. 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.
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.
", "idempotent": true }, "DeleteAlertManagerDefinition": { "name": "DeleteAlertManagerDefinition", "http": { "method": "DELETE", "requestUri": "/workspaces/{workspaceId}/alertmanager/definition", "responseCode": 202 }, "input": { "shape": "DeleteAlertManagerDefinitionRequest" }, "errors": [ { "shape": "ThrottlingException" }, { "shape": "ConflictException" }, { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "InternalServerException" } ], "documentation": "Deletes the alert manager definition from a workspace.
", "idempotent": true }, "DeleteLoggingConfiguration": { "name": "DeleteLoggingConfiguration", "http": { "method": "DELETE", "requestUri": "/workspaces/{workspaceId}/logging", "responseCode": 202 }, "input": { "shape": "DeleteLoggingConfigurationRequest" }, "errors": [ { "shape": "ConflictException" }, { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "InternalServerException" } ], "documentation": "Deletes the logging configuration for a workspace.
", "idempotent": true }, "DeleteRuleGroupsNamespace": { "name": "DeleteRuleGroupsNamespace", "http": { "method": "DELETE", "requestUri": "/workspaces/{workspaceId}/rulegroupsnamespaces/{name}", "responseCode": 202 }, "input": { "shape": "DeleteRuleGroupsNamespaceRequest" }, "errors": [ { "shape": "ThrottlingException" }, { "shape": "ConflictException" }, { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "InternalServerException" } ], "documentation": "Deletes one rule groups namespace and its associated rule groups definition.
", "idempotent": true }, "DeleteScraper": { "name": "DeleteScraper", "http": { "method": "DELETE", "requestUri": "/scrapers/{scraperId}", "responseCode": 202 }, "input": { "shape": "DeleteScraperRequest" }, "output": { "shape": "DeleteScraperResponse" }, "errors": [ { "shape": "ThrottlingException" }, { "shape": "ConflictException" }, { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "InternalServerException" } ], "documentation": "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": { "name": "DescribeLoggingConfiguration", "http": { "method": "GET", "requestUri": "/workspaces/{workspaceId}/logging", "responseCode": 200 }, "input": { "shape": "DescribeLoggingConfigurationRequest" }, "output": { "shape": "DescribeLoggingConfigurationResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "InternalServerException" } ], "documentation": "Returns complete information about the current logging configuration of the workspace.
" }, "DescribeRuleGroupsNamespace": { "name": "DescribeRuleGroupsNamespace", "http": { "method": "GET", "requestUri": "/workspaces/{workspaceId}/rulegroupsnamespaces/{name}", "responseCode": 200 }, "input": { "shape": "DescribeRuleGroupsNamespaceRequest" }, "output": { "shape": "DescribeRuleGroupsNamespaceResponse" }, "errors": [ { "shape": "ThrottlingException" }, { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "InternalServerException" } ], "documentation": "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": { "name": "GetDefaultScraperConfiguration", "http": { "method": "GET", "requestUri": "/scraperconfiguration", "responseCode": 200 }, "input": { "shape": "GetDefaultScraperConfigurationRequest" }, "output": { "shape": "GetDefaultScraperConfigurationResponse" }, "errors": [ { "shape": "ThrottlingException" }, { "shape": "AccessDeniedException" }, { "shape": "InternalServerException" } ], "documentation": "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": { "name": "ListScrapers", "http": { "method": "GET", "requestUri": "/scrapers", "responseCode": 200 }, "input": { "shape": "ListScrapersRequest" }, "output": { "shape": "ListScrapersResponse" }, "errors": [ { "shape": "ThrottlingException" }, { "shape": "ValidationException" }, { "shape": "AccessDeniedException" }, { "shape": "InternalServerException" } ], "documentation": "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 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": { "name": "PutAlertManagerDefinition", "http": { "method": "PUT", "requestUri": "/workspaces/{workspaceId}/alertmanager/definition", "responseCode": 202 }, "input": { "shape": "PutAlertManagerDefinitionRequest" }, "output": { "shape": "PutAlertManagerDefinitionResponse" }, "errors": [ { "shape": "ThrottlingException" }, { "shape": "ConflictException" }, { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "InternalServerException" }, { "shape": "ServiceQuotaExceededException" } ], "documentation": "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 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.
" }, "UntagResource": { "name": "UntagResource", "http": { "method": "DELETE", "requestUri": "/tags/{resourceArn}", "responseCode": 200 }, "input": { "shape": "UntagResourceRequest" }, "output": { "shape": "UntagResourceResponse" }, "errors": [ { "shape": "ThrottlingException" }, { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "InternalServerException" } ], "documentation": "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.
", "idempotent": true }, "UpdateLoggingConfiguration": { "name": "UpdateLoggingConfiguration", "http": { "method": "PUT", "requestUri": "/workspaces/{workspaceId}/logging", "responseCode": 202 }, "input": { "shape": "UpdateLoggingConfigurationRequest" }, "output": { "shape": "UpdateLoggingConfigurationResponse" }, "errors": [ { "shape": "ConflictException" }, { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "InternalServerException" } ], "documentation": "Updates the log group ARN or the workspace ID of the current logging configuration.
", "idempotent": true }, "UpdateWorkspaceAlias": { "name": "UpdateWorkspaceAlias", "http": { "method": "POST", "requestUri": "/workspaces/{workspaceId}/alias", "responseCode": 204 }, "input": { "shape": "UpdateWorkspaceAliasRequest" }, "errors": [ { "shape": "ThrottlingException" }, { "shape": "ConflictException" }, { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "InternalServerException" }, { "shape": "ServiceQuotaExceededException" } ], "documentation": "Updates the alias of an existing workspace.
", "idempotent": true } }, "shapes": { "AlertManagerDefinitionData": { "type": "blob", "documentation": "The base-64 encoded blob that is alert manager definition.
For details about the alert manager definition, see AlertManagedDefinitionData.
" }, "AlertManagerDefinitionDescription": { "type": "structure", "required": [ "createdAt", "data", "modifiedAt", "status" ], "members": { "createdAt": { "shape": "Timestamp", "documentation": "The date and time that the alert manager definition was created.
" }, "data": { "shape": "AlertManagerDefinitionData", "documentation": "The actual alert manager definition.
For details about the alert manager definition, see AlertManagedDefinitionData.
" }, "modifiedAt": { "shape": "Timestamp", "documentation": "The date and time that the alert manager definition was most recently changed.
" }, "status": { "shape": "AlertManagerDefinitionStatus", "documentation": "A structure that displays the current status of the alert manager definition..
" } }, "documentation": "The details of an alert manager definition.
" }, "AlertManagerDefinitionStatus": { "type": "structure", "required": [ "statusCode" ], "members": { "statusCode": { "shape": "AlertManagerDefinitionStatusCode", "documentation": "The current status of the alert manager.
" }, "statusReason": { "shape": "String", "documentation": "If there is a failure, the reason for the failure.
" } }, "documentation": "The status of the alert manager.
" }, "AlertManagerDefinitionStatusCode": { "type": "string", "documentation": "State of an AlertManagerDefinition.
ARN of the Amazon Managed Service for Prometheus workspace.
" } }, "documentation": "The AmpConfiguration structure defines the Amazon Managed Service for Prometheus instance a scraper should send metrics to.
The ARN of an EKS cluster.
", "pattern": "^arn:aws[-a-z]*:eks:[-a-z0-9]+:[0-9]{12}:cluster/.+$" }, "CreateAlertManagerDefinitionRequest": { "type": "structure", "required": [ "data", "workspaceId" ], "members": { "clientToken": { "shape": "IdempotencyToken", "documentation": "A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "idempotencyToken": true }, "data": { "shape": "AlertManagerDefinitionData", "documentation": "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.
" }, "workspaceId": { "shape": "WorkspaceId", "documentation": "The ID of the workspace to add the alert manager definition to.
", "location": "uri", "locationName": "workspaceId" } }, "documentation": "Represents the input of a CreateAlertManagerDefinition operation.
A structure that displays the current status of the alert manager definition.
" } }, "documentation": "Represents the output of a CreateAlertManagerDefinition operation.
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "idempotencyToken": true }, "logGroupArn": { "shape": "LogGroupArn", "documentation": "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.
" }, "workspaceId": { "shape": "WorkspaceId", "documentation": "The ID of the workspace to create the logging configuration for.
", "location": "uri", "locationName": "workspaceId" } }, "documentation": "Represents the input of a CreateLoggingConfiguration operation.
A structure that displays the current status of the logging configuration.
" } }, "documentation": "Represents the output of a CreateLoggingConfiguration operation.
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "idempotencyToken": true }, "data": { "shape": "RuleGroupsNamespaceData", "documentation": "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.
" }, "name": { "shape": "RuleGroupsNamespaceName", "documentation": "The name for the new rule groups namespace.
" }, "tags": { "shape": "TagMap", "documentation": "The list of tag keys and values to associate with the rule groups namespace.
" }, "workspaceId": { "shape": "WorkspaceId", "documentation": "The ID of the workspace to add the rule groups namespace.
", "location": "uri", "locationName": "workspaceId" } }, "documentation": "Represents the input of a CreateRuleGroupsNamespace operation.
The Amazon Resource Name (ARN) of the new rule groups namespace.
" }, "name": { "shape": "RuleGroupsNamespaceName", "documentation": "The name of the new rule groups namespace.
" }, "status": { "shape": "RuleGroupsNamespaceStatus", "documentation": "A structure that returns the current status of the rule groups namespace.
" }, "tags": { "shape": "TagMap", "documentation": "The list of tag keys and values that are associated with the namespace.
" } }, "documentation": "Represents the output of a CreateRuleGroupsNamespace operation.
(optional) a name to associate with the scraper. This is for your use, and does not need to be unique.
" }, "clientToken": { "shape": "IdempotencyToken", "documentation": "(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.
", "idempotencyToken": true }, "destination": { "shape": "Destination", "documentation": "The Amazon Managed Service for Prometheus workspace to send metrics to.
" }, "scrapeConfiguration": { "shape": "ScrapeConfiguration", "documentation": "The configuration file to use in the new scraper. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User Guide.
" }, "source": { "shape": "Source", "documentation": "The Amazon EKS cluster from which the scraper will collect metrics.
" }, "tags": { "shape": "TagMap", "documentation": "(Optional) The list of tag keys and values to associate with the scraper.
" } }, "documentation": "Represents the input of a CreateScraper operation.
The Amazon Resource Name (ARN) of the new scraper.
" }, "scraperId": { "shape": "ScraperId", "documentation": "The ID of the new scraper.
" }, "status": { "shape": "ScraperStatus", "documentation": "A structure that displays the current status of the scraper.
" }, "tags": { "shape": "TagMap", "documentation": "The list of tag keys and values that are associated with the scraper.
" } }, "documentation": "Represents the output of a CreateScraper 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.
" }, "clientToken": { "shape": "IdempotencyToken", "documentation": "A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "idempotencyToken": true }, "kmsKeyArn": { "shape": "KmsKeyArn", "documentation": "(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.
" }, "tags": { "shape": "TagMap", "documentation": "The list of tag keys and values to associate with the workspace.
" } }, "documentation": "Represents the input of a CreateWorkspace operation.
The ARN for the new workspace.
" }, "kmsKeyArn": { "shape": "KmsKeyArn", "documentation": "(optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.
" }, "status": { "shape": "WorkspaceStatus", "documentation": "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.
" }, "workspaceId": { "shape": "WorkspaceId", "documentation": "The unique ID for the new workspace.
" } }, "documentation": "Represents the output of a CreateWorkspace operation.
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "idempotencyToken": true, "location": "querystring", "locationName": "clientToken" }, "workspaceId": { "shape": "WorkspaceId", "documentation": "The ID of the workspace to delete the alert manager definition from.
", "location": "uri", "locationName": "workspaceId" } }, "documentation": "Represents the input of a DeleteAlertManagerDefinition operation.
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "idempotencyToken": true, "location": "querystring", "locationName": "clientToken" }, "workspaceId": { "shape": "WorkspaceId", "documentation": "The ID of the workspace containing the logging configuration to delete.
", "location": "uri", "locationName": "workspaceId" } }, "documentation": "Represents the input of a DeleteLoggingConfiguration operation.
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "idempotencyToken": true, "location": "querystring", "locationName": "clientToken" }, "name": { "shape": "RuleGroupsNamespaceName", "documentation": "The name of the rule groups namespace to delete.
", "location": "uri", "locationName": "name" }, "workspaceId": { "shape": "WorkspaceId", "documentation": "The ID of the workspace containing the rule groups namespace and definition to delete.
", "location": "uri", "locationName": "workspaceId" } }, "documentation": "Represents the input of a DeleteRuleGroupsNamespace operation.
(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.
", "idempotencyToken": true, "location": "querystring", "locationName": "clientToken" }, "scraperId": { "shape": "ScraperId", "documentation": "The ID of the scraper to delete.
", "location": "uri", "locationName": "scraperId" } }, "documentation": "Represents the input of a DeleteScraper operation.
The ID of the scraper to delete.
" }, "status": { "shape": "ScraperStatus", "documentation": "The current status of the scraper.
" } }, "documentation": "Represents the output of a DeleteScraper operation.
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "idempotencyToken": true, "location": "querystring", "locationName": "clientToken" }, "workspaceId": { "shape": "WorkspaceId", "documentation": "The ID of the workspace to delete.
", "location": "uri", "locationName": "workspaceId" } }, "documentation": "Represents the input of a DeleteWorkspace operation.
The ID of the workspace to retrieve the alert manager definition from.
", "location": "uri", "locationName": "workspaceId" } }, "documentation": "Represents the input of a DescribeAlertManagerDefinition operation.
The alert manager definition.
" } }, "documentation": "Represents the output of a DescribeAlertManagerDefinition operation.
The ID of the workspace to describe the logging configuration for.
", "location": "uri", "locationName": "workspaceId" } }, "documentation": "Represents the input of a DescribeLoggingConfiguration operation.
A structure that displays the information about the logging configuration.
" } }, "documentation": "Represents the output of a DescribeLoggingConfiguration operation.
The name of the rule groups namespace that you want information for.
", "location": "uri", "locationName": "name" }, "workspaceId": { "shape": "WorkspaceId", "documentation": "The ID of the workspace containing the rule groups namespace.
", "location": "uri", "locationName": "workspaceId" } }, "documentation": "Represents the input of a DescribeRuleGroupsNamespace operation.
The information about the rule groups namespace.
" } }, "documentation": "Represents the output of a DescribeRuleGroupsNamespace operation.
The ID of the scraper to describe.
", "location": "uri", "locationName": "scraperId" } }, "documentation": "Represents the input of a DescribeScraper operation.
Contains details about the scraper.
" } }, "documentation": "Represents the output of a DescribeScraper operation.
The ID of the workspace to describe.
", "location": "uri", "locationName": "workspaceId" } }, "documentation": "Represents the input of a DescribeWorkspace operation.
A structure that contains details about the workspace.
" } }, "documentation": "Represents the output of a DescribeWorkspace operation.
The Amazon Managed Service for Prometheusworkspace to send metrics to.
" } }, "documentation": "Where to send the metrics from a scraper.
", "union": true }, "EksConfiguration": { "type": "structure", "required": [ "clusterArn", "subnetIds" ], "members": { "clusterArn": { "shape": "ClusterArn", "documentation": "ARN of the Amazon EKS cluster.
" }, "securityGroupIds": { "shape": "SecurityGroupIds", "documentation": "A list of the security group IDs for the Amazon EKS cluster VPC configuration.
" }, "subnetIds": { "shape": "SubnetIds", "documentation": "A list of subnet IDs for the Amazon EKS cluster VPC configuration.
" } }, "documentation": "The EksConfiguration structure describes the connection to the Amazon EKS cluster from which a scraper collects metrics.
The name of the key by which to filter.
", "max": 256, "min": 1 }, "FilterValue": { "type": "string", "documentation": "The value for a given key by which to filter.
", "max": 256, "min": 1 }, "FilterValues": { "type": "list", "member": { "shape": "FilterValue" }, "documentation": "A list of scraper filter values.
", "max": 20, "min": 1 }, "GetDefaultScraperConfigurationRequest": { "type": "structure", "members": {}, "documentation": "Represents the input of a GetDefaultScraperConfiguration operation.
The configuration file. Base 64 encoded. For more information, see Scraper configurationin the Amazon Managed Service for Prometheus User Guide.
" } }, "documentation": "Represents the output of a GetDefaultScraperConfiguration operation.
An ARN identifying an IAM role used by the scraper.
" }, "IdempotencyToken": { "type": "string", "documentation": "An identifier used to ensure the idempotency of a write request.
", "max": 64, "min": 1, "pattern": "^[!-~]+$" }, "KmsKeyArn": { "type": "string", "documentation": "A KMS Key ARN.
", "max": 2048, "min": 20, "pattern": "^arn:aws:kms:[a-z0-9\\-]+:\\d+:key/[a-f0-9\\-]+$" }, "ListRuleGroupsNamespacesRequest": { "type": "structure", "required": [ "workspaceId" ], "members": { "maxResults": { "shape": "ListRuleGroupsNamespacesRequestMaxResultsInteger", "documentation": "The maximum number of results to return. The default is 100.
", "location": "querystring", "locationName": "maxResults" }, "name": { "shape": "RuleGroupsNamespaceName", "documentation": "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.
", "location": "querystring", "locationName": "name" }, "nextToken": { "shape": "PaginationToken", "documentation": "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 ID of the workspace containing the rule groups namespaces.
", "location": "uri", "locationName": "workspaceId" } }, "documentation": "Represents the input of a ListRuleGroupsNamespaces operation.
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.
The returned list of rule groups namespaces.
" } }, "documentation": "Represents the output of a ListRuleGroupsNamespaces 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.
", "location": "querystring" }, "maxResults": { "shape": "ListScrapersRequestMaxResultsInteger", "documentation": "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.
", "location": "querystring", "locationName": "maxResults" }, "nextToken": { "shape": "PaginationToken", "documentation": "(Optional) The token for the next set of items to return. (You received this token from a previous call.)
", "location": "querystring", "locationName": "nextToken" } }, "documentation": "Represents the input of a ListScrapers operation.
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.
A list of ScraperSummary structures giving information about scrapers in the account that match the filters provided.
Represents the output of a ListScrapers operation.
The ARN of the resource to list tages for. Must be a workspace or rule groups namespace resource.
", "location": "uri", "locationName": "resourceArn" } } }, "ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "shape": "TagMap", "documentation": "The list of tag keys and values associated with the resource.
" } } }, "ListWorkspacesRequest": { "type": "structure", "members": { "alias": { "shape": "WorkspaceAlias", "documentation": "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.
", "location": "querystring", "locationName": "alias" }, "maxResults": { "shape": "ListWorkspacesRequestMaxResultsInteger", "documentation": "The maximum number of workspaces to return per request. The default is 100.
", "location": "querystring", "locationName": "maxResults" }, "nextToken": { "shape": "PaginationToken", "documentation": "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.
Represents the input of a ListWorkspaces operation.
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.
An array of WorkspaceSummary structures containing information about the workspaces requested.
Represents the output of a ListWorkspaces operation.
The date and time that the logging configuration was created.
" }, "logGroupArn": { "shape": "LogGroupArn", "documentation": "The ARN of the CloudWatch log group to which the vended log data will be published.
" }, "modifiedAt": { "shape": "Timestamp", "documentation": "The date and time that the logging configuration was most recently changed.
" }, "status": { "shape": "LoggingConfigurationStatus", "documentation": "The current status of the logging configuration.
" }, "workspace": { "shape": "WorkspaceId", "documentation": "The ID of the workspace the logging configuration is for.
" } }, "documentation": "Contains information about the logging configuration.
" }, "LoggingConfigurationStatus": { "type": "structure", "required": [ "statusCode" ], "members": { "statusCode": { "shape": "LoggingConfigurationStatusCode", "documentation": "The current status of the logging configuration.
" }, "statusReason": { "shape": "String", "documentation": "If failed, the reason for the failure.
" } }, "documentation": "The status of the logging configuration.
" }, "LoggingConfigurationStatusCode": { "type": "string", "documentation": "State of a logging configuration.
", "enum": [ "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED" ] }, "PaginationToken": { "type": "string", "documentation": "A token used to access the next page in a paginated result set.
", "max": 1000, "min": 0 }, "PutAlertManagerDefinitionRequest": { "type": "structure", "required": [ "data", "workspaceId" ], "members": { "clientToken": { "shape": "IdempotencyToken", "documentation": "A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "idempotencyToken": true }, "data": { "shape": "AlertManagerDefinitionData", "documentation": "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.
" }, "workspaceId": { "shape": "WorkspaceId", "documentation": "The ID of the workspace to update the alert manager definition in.
", "location": "uri", "locationName": "workspaceId" } }, "documentation": "Represents the input of a PutAlertManagerDefinition operation.
A structure that returns the current status of the alert manager definition.
" } }, "documentation": "Represents the output of a PutAlertManagerDefinition operation.
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "idempotencyToken": true }, "data": { "shape": "RuleGroupsNamespaceData", "documentation": "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.
" }, "name": { "shape": "RuleGroupsNamespaceName", "documentation": "The name of the rule groups namespace that you are updating.
", "location": "uri", "locationName": "name" }, "workspaceId": { "shape": "WorkspaceId", "documentation": "The ID of the workspace where you are updating the rule groups namespace.
", "location": "uri", "locationName": "workspaceId" } }, "documentation": "Represents the input of a PutRuleGroupsNamespace operation.
The ARN of the rule groups namespace.
" }, "name": { "shape": "RuleGroupsNamespaceName", "documentation": "The name of the rule groups namespace that was updated.
" }, "status": { "shape": "RuleGroupsNamespaceStatus", "documentation": "A structure that includes the current status of the rule groups namespace.
" }, "tags": { "shape": "TagMap", "documentation": "The list of tag keys and values that are associated with the namespace.
" } }, "documentation": "Represents the output of a PutRuleGroupsNamespace operation.
An ARN identifying a rule groups namespace.
" }, "RuleGroupsNamespaceData": { "type": "blob", "documentation": "The rule groups namespace data.
" }, "RuleGroupsNamespaceDescription": { "type": "structure", "required": [ "arn", "createdAt", "data", "modifiedAt", "name", "status" ], "members": { "arn": { "shape": "RuleGroupsNamespaceArn", "documentation": "The ARN of the rule groups namespace.
" }, "createdAt": { "shape": "Timestamp", "documentation": "The date and time that the rule groups namespace was created.
" }, "data": { "shape": "RuleGroupsNamespaceData", "documentation": "The rule groups file used in the namespace.
For details about the rule groups namespace structure, see RuleGroupsNamespaceData.
" }, "modifiedAt": { "shape": "Timestamp", "documentation": "The date and time that the rule groups namespace was most recently changed.
" }, "name": { "shape": "RuleGroupsNamespaceName", "documentation": "The name of the rule groups namespace.
" }, "status": { "shape": "RuleGroupsNamespaceStatus", "documentation": "The current status of the rule groups namespace.
" }, "tags": { "shape": "TagMap", "documentation": "The list of tag keys and values that are associated with the rule groups namespace.
" } }, "documentation": "The details about one rule groups namespace.
" }, "RuleGroupsNamespaceName": { "type": "string", "documentation": "The name of the namespace that the rule group belong to.
", "max": 64, "min": 1, "pattern": "[0-9A-Za-z][-.0-9A-Z_a-z]*" }, "RuleGroupsNamespaceStatus": { "type": "structure", "required": [ "statusCode" ], "members": { "statusCode": { "shape": "RuleGroupsNamespaceStatusCode", "documentation": "The current status of the namespace.
" }, "statusReason": { "shape": "String", "documentation": "The reason for the failure, if any.
" } }, "documentation": "The status information about a rule groups namespace.
" }, "RuleGroupsNamespaceStatusCode": { "type": "string", "documentation": "State of a namespace.
", "enum": [ "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED" ] }, "RuleGroupsNamespaceSummary": { "type": "structure", "required": [ "arn", "createdAt", "modifiedAt", "name", "status" ], "members": { "arn": { "shape": "RuleGroupsNamespaceArn", "documentation": "The ARN of the rule groups namespace.
" }, "createdAt": { "shape": "Timestamp", "documentation": "The date and time that the rule groups namespace was created.
" }, "modifiedAt": { "shape": "Timestamp", "documentation": "The date and time that the rule groups namespace was most recently changed.
" }, "name": { "shape": "RuleGroupsNamespaceName", "documentation": "The name of the rule groups namespace.
" }, "status": { "shape": "RuleGroupsNamespaceStatus", "documentation": "A structure that displays the current status of the rule groups namespace.
" }, "tags": { "shape": "TagMap", "documentation": "The list of tag keys and values that are associated with the rule groups namespace.
" } }, "documentation": "The high-level information about a rule groups namespace. To retrieve more information, use DescribeRuleGroupsNamespace.
A list of rule groups namespace summary.
" }, "ScrapeConfiguration": { "type": "structure", "members": { "configurationBlob": { "shape": "Blob", "documentation": "The base 64 encoded scrape configuration file.
" } }, "documentation": "A scrape configuration for a scraper, base 64 encoded. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User Guide.
", "union": true }, "ScraperAlias": { "type": "string", "documentation": "A user-assigned scraper alias.
", "max": 100, "min": 1, "pattern": "^[0-9A-Za-z][-.0-9A-Z_a-z]*$" }, "ScraperArn": { "type": "string", "documentation": "An ARN identifying a scrape configuration.
" }, "ScraperDescription": { "type": "structure", "required": [ "arn", "createdAt", "destination", "lastModifiedAt", "roleArn", "scrapeConfiguration", "scraperId", "source", "status" ], "members": { "alias": { "shape": "ScraperAlias", "documentation": "(Optional) A name associated with the scraper.
" }, "arn": { "shape": "ScraperArn", "documentation": "The Amazon Resource Name (ARN) of the scraper.
" }, "createdAt": { "shape": "Timestamp", "documentation": "The date and time that the scraper was created.
" }, "destination": { "shape": "Destination", "documentation": "The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
" }, "lastModifiedAt": { "shape": "Timestamp", "documentation": "The date and time that the scraper was last modified.
" }, "roleArn": { "shape": "IamRoleArn", "documentation": "The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.
" }, "scrapeConfiguration": { "shape": "ScrapeConfiguration", "documentation": "The configuration file in use by the scraper.
" }, "scraperId": { "shape": "ScraperId", "documentation": "The ID of the scraper.
" }, "source": { "shape": "Source", "documentation": "The Amazon EKS cluster from which the scraper collects metrics.
" }, "status": { "shape": "ScraperStatus", "documentation": "A structure that contains the current status of the scraper.
" }, "statusReason": { "shape": "StatusReason", "documentation": "If there is a failure, the reason for the failure.
" }, "tags": { "shape": "TagMap", "documentation": "(Optional) The list of tag keys and values associated with the scraper.
" } }, "documentation": "The ScraperDescription structure contains the full details about one scraper in your account.
The name of the key to filter by. Currently supported filter keys are status, sourceArn, destinationArn, and alias.
The values of the given key by which to filter.
" }, "documentation": "A list of scraper filters.
", "max": 4, "min": 1 }, "ScraperId": { "type": "string", "documentation": "A scraper ID.
", "max": 64, "min": 1, "pattern": "^[0-9A-Za-z][-.0-9A-Z_a-z]*$" }, "ScraperStatus": { "type": "structure", "required": [ "statusCode" ], "members": { "statusCode": { "shape": "ScraperStatusCode", "documentation": "The current status of the scraper.
" } }, "documentation": "The ScraperStatus structure contains status information about the scraper.
State of a scraper.
", "enum": [ "CREATING", "ACTIVE", "DELETING", "CREATION_FAILED", "DELETION_FAILED" ] }, "ScraperSummary": { "type": "structure", "required": [ "arn", "createdAt", "destination", "lastModifiedAt", "roleArn", "scraperId", "source", "status" ], "members": { "alias": { "shape": "ScraperAlias", "documentation": "(Optional) A name associated with the scraper.
" }, "arn": { "shape": "ScraperArn", "documentation": "The Amazon Resource Name (ARN) of the scraper.
" }, "createdAt": { "shape": "Timestamp", "documentation": "The date and time that the scraper was created.
" }, "destination": { "shape": "Destination", "documentation": "The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
" }, "lastModifiedAt": { "shape": "Timestamp", "documentation": "The date and time that the scraper was last modified.
" }, "roleArn": { "shape": "IamRoleArn", "documentation": "The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.
" }, "scraperId": { "shape": "ScraperId", "documentation": "The ID of the scraper.
" }, "source": { "shape": "Source", "documentation": "The Amazon EKS cluster from which the scraper collects metrics.
" }, "status": { "shape": "ScraperStatus", "documentation": "A structure that contains the current status of the scraper.
" }, "statusReason": { "shape": "StatusReason", "documentation": "If there is a failure, the reason for the failure.
" }, "tags": { "shape": "TagMap", "documentation": "(Optional) The list of tag keys and values associated with the scraper.
" } }, "documentation": "The ScraperSummary structure contains a summary of the details about one scraper in your account.
A list of scraper summaries.
" }, "SecurityGroupId": { "type": "string", "documentation": "ID of a VPC security group.
", "max": 255, "min": 0, "pattern": "^sg-[0-9a-z]+$" }, "SecurityGroupIds": { "type": "list", "member": { "shape": "SecurityGroupId" }, "documentation": "A list of security group IDs specified for VPC configuration.
", "max": 5, "min": 1 }, "Source": { "type": "structure", "members": { "eksConfiguration": { "shape": "EksConfiguration", "documentation": "The Amazon EKS cluster from which a scraper collects metrics.
" } }, "documentation": "The source of collected metrics for a scraper.
", "union": true }, "StatusReason": { "type": "string", "documentation": "The reason for the failure, if any.
", "max": 256, "min": 1 }, "String": { "type": "string" }, "SubnetId": { "type": "string", "documentation": "ID of a VPC subnet.
", "max": 255, "min": 0, "pattern": "^subnet-[0-9a-z]+$" }, "SubnetIds": { "type": "list", "member": { "shape": "SubnetId" }, "documentation": "A list of subnet IDs specified for VPC configuration.
", "max": 5, "min": 1 }, "TagKey": { "type": "string", "max": 128, "min": 1, "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "TagKeys": { "type": "list", "member": { "shape": "TagKey" } }, "TagMap": { "type": "map", "key": { "shape": "TagKey", "documentation": "The key of the tag. May not begin with aws:.
The value of the tag.
" }, "documentation": "The list of tags assigned to the resource.
", "max": 50, "min": 0 }, "TagResourceRequest": { "type": "structure", "required": [ "resourceArn", "tags" ], "members": { "resourceArn": { "shape": "String", "documentation": "The ARN of the workspace or rule groups namespace to apply tags to.
", "location": "uri", "locationName": "resourceArn" }, "tags": { "shape": "TagMap", "documentation": "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.
", "location": "uri", "locationName": "resourceArn" }, "tagKeys": { "shape": "TagKeys", "documentation": "The keys of the tags to remove.
", "location": "querystring", "locationName": "tagKeys" } } }, "UntagResourceResponse": { "type": "structure", "members": {} }, "UpdateLoggingConfigurationRequest": { "type": "structure", "required": [ "logGroupArn", "workspaceId" ], "members": { "clientToken": { "shape": "IdempotencyToken", "documentation": "A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "idempotencyToken": true }, "logGroupArn": { "shape": "LogGroupArn", "documentation": "The ARN of the CloudWatch log group to which the vended log data will be published.
" }, "workspaceId": { "shape": "WorkspaceId", "documentation": "The ID of the workspace to update the logging configuration for.
", "location": "uri", "locationName": "workspaceId" } }, "documentation": "Represents the input of an UpdateLoggingConfiguration operation.
A structure that contains the current status of the logging configuration.
" } }, "documentation": "Represents the output of an UpdateLoggingConfiguration operation.
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.
" }, "clientToken": { "shape": "IdempotencyToken", "documentation": "A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "idempotencyToken": true }, "workspaceId": { "shape": "WorkspaceId", "documentation": "The ID of the workspace to update.
", "location": "uri", "locationName": "workspaceId" } }, "documentation": "Represents the input of an UpdateWorkspaceAlias operation.
A user-assigned workspace alias.
", "max": 100, "min": 1 }, "WorkspaceArn": { "type": "string", "documentation": "An ARN identifying a Workspace.
", "pattern": "^arn:aws[-a-z]*:aps:[-a-z0-9]+:[0-9]{12}:workspace/.+$" }, "WorkspaceDescription": { "type": "structure", "required": [ "arn", "createdAt", "status", "workspaceId" ], "members": { "alias": { "shape": "WorkspaceAlias", "documentation": "The alias that is assigned to this workspace to help identify it. It may not be unique.
" }, "arn": { "shape": "WorkspaceArn", "documentation": "The ARN of the workspace.
" }, "createdAt": { "shape": "Timestamp", "documentation": "The date and time that the workspace was created.
" }, "kmsKeyArn": { "shape": "KmsKeyArn", "documentation": "(optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.
" }, "prometheusEndpoint": { "shape": "Uri", "documentation": "The Prometheus endpoint available for this workspace.
" }, "status": { "shape": "WorkspaceStatus", "documentation": "The current status of the workspace.
" }, "tags": { "shape": "TagMap", "documentation": "The list of tag keys and values that are associated with the workspace.
" }, "workspaceId": { "shape": "WorkspaceId", "documentation": "The unique ID for the workspace.
" } }, "documentation": "The full details about one Amazon Managed Service for Prometheus workspace in your account.
" }, "WorkspaceId": { "type": "string", "documentation": "A workspace ID.
", "max": 64, "min": 1, "pattern": "[0-9A-Za-z][-.0-9A-Z_a-z]*" }, "WorkspaceStatus": { "type": "structure", "required": [ "statusCode" ], "members": { "statusCode": { "shape": "WorkspaceStatusCode", "documentation": "The current status of the workspace.
" } }, "documentation": "The status of the workspace.
" }, "WorkspaceStatusCode": { "type": "string", "documentation": "State of a workspace.
", "enum": [ "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED" ] }, "WorkspaceSummary": { "type": "structure", "required": [ "arn", "createdAt", "status", "workspaceId" ], "members": { "alias": { "shape": "WorkspaceAlias", "documentation": "The alias that is assigned to this workspace to help identify it. It may not be unique.
" }, "arn": { "shape": "WorkspaceArn", "documentation": "The ARN of the workspace.
" }, "createdAt": { "shape": "Timestamp", "documentation": "The date and time that the workspace was created.
" }, "kmsKeyArn": { "shape": "KmsKeyArn", "documentation": "(optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.
" }, "status": { "shape": "WorkspaceStatus", "documentation": "The current status of the workspace.
" }, "tags": { "shape": "TagMap", "documentation": "The list of tag keys and values that are associated with the workspace.
" }, "workspaceId": { "shape": "WorkspaceId", "documentation": "The unique ID for the workspace.
" } }, "documentation": "The information about one Amazon Managed Service for Prometheus workspace in your account.
" }, "WorkspaceSummaryList": { "type": "list", "member": { "shape": "WorkspaceSummary" }, "documentation": "A list of workspace summaries.
" } }, "documentation": "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.