Date createdAt
The date and time that the alert manager definition was created.
ByteBuffer data
The actual alert manager definition.
For details about the alert manager definition, see AlertManagedDefinitionData.
Date modifiedAt
The date and time that the alert manager definition was most recently changed.
AlertManagerDefinitionStatus status
A structure that displays the current status of the alert manager definition..
String workspaceArn
ARN of the Amazon Managed Service for Prometheus workspace.
String clientToken
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
ByteBuffer 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.
String workspaceId
The ID of the workspace to add the alert manager definition to.
AlertManagerDefinitionStatus status
A structure that displays the current status of the alert manager definition.
String clientToken
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
String logGroupArn
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.
String workspaceId
The ID of the workspace to create the logging configuration for.
LoggingConfigurationStatus status
A structure that displays the current status of the logging configuration.
String clientToken
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
ByteBuffer 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.
String name
The name for the new rule groups namespace.
Map<K,V> tags
The list of tag keys and values to associate with the rule groups namespace.
String workspaceId
The ID of the workspace to add the rule groups namespace.
String arn
The Amazon Resource Name (ARN) of the new rule groups namespace.
String name
The name of the new rule groups namespace.
RuleGroupsNamespaceStatus status
A structure that returns the current status of the rule groups namespace.
Map<K,V> tags
The list of tag keys and values that are associated with the namespace.
String alias
(optional) a name to associate with the scraper. This is for your use, and does not need to be unique.
String clientToken
(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.
Destination destination
The Amazon Managed Service for Prometheus workspace to send metrics to.
ScrapeConfiguration 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.
Source source
The Amazon EKS cluster from which the scraper will collect metrics.
Map<K,V> tags
(Optional) The list of tag keys and values to associate with the scraper.
String 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.
String clientToken
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
String 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.
Map<K,V> tags
The list of tag keys and values to associate with the workspace.
String arn
The ARN for the new workspace.
String kmsKeyArn
(optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.
WorkspaceStatus status
The current status of the new workspace. Immediately after you create the workspace, the status is usually
CREATING.
Map<K,V> tags
The list of tag keys and values that are associated with the workspace.
String workspaceId
The unique ID for the new workspace.
String clientToken
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
String name
The name of the rule groups namespace to delete.
String workspaceId
The ID of the workspace containing the rule groups namespace and definition to delete.
String scraperId
The ID of the scraper to delete.
ScraperStatus status
The current status of the scraper.
String workspaceId
The ID of the workspace to retrieve the alert manager definition from.
AlertManagerDefinitionDescription alertManagerDefinition
The alert manager definition.
String workspaceId
The ID of the workspace to describe the logging configuration for.
LoggingConfigurationMetadata loggingConfiguration
A structure that displays the information about the logging configuration.
RuleGroupsNamespaceDescription ruleGroupsNamespace
The information about the rule groups namespace.
String scraperId
The ID of the scraper to describe.
ScraperDescription scraper
Contains details about the scraper.
String workspaceId
The ID of the workspace to describe.
WorkspaceDescription workspace
A structure that contains details about the workspace.
AmpConfiguration ampConfiguration
The Amazon Managed Service for Prometheusworkspace to send metrics to.
ByteBuffer configuration
The configuration file. Base 64 encoded. For more information, see Scraper configurationin the Amazon Managed Service for Prometheus User Guide.
Integer retryAfterSeconds
Advice to clients on when the call can be safely retried.
Integer maxResults
The maximum number of results to return. The default is 100.
String 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.
String 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.
String workspaceId
The ID of the workspace containing the rule groups namespaces.
Map<K,V> 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.
Integer maxResults
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.
String nextToken
(Optional) The token for the next set of items to return. (You received this token from a previous call.)
String 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.
List<E> scrapers
A list of ScraperSummary structures giving information about scrapers in the account that match the
filters provided.
String resourceArn
The ARN of the resource to list tages for. Must be a workspace or rule groups namespace resource.
String 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.
Integer maxResults
The maximum number of workspaces to return per request. The default is 100.
String 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 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.
String nextToken
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.
List<E> workspaces
An array of WorkspaceSummary structures containing information about the workspaces requested.
Date createdAt
The date and time that the logging configuration was created.
String logGroupArn
The ARN of the CloudWatch log group to which the vended log data will be published.
Date modifiedAt
The date and time that the logging configuration was most recently changed.
LoggingConfigurationStatus status
The current status of the logging configuration.
String workspace
The ID of the workspace the logging configuration is for.
String clientToken
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
ByteBuffer 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.
String workspaceId
The ID of the workspace to update the alert manager definition in.
AlertManagerDefinitionStatus status
A structure that returns the current status of the alert manager definition.
String clientToken
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
ByteBuffer 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.
String name
The name of the rule groups namespace that you are updating.
String workspaceId
The ID of the workspace where you are updating the rule groups namespace.
String arn
The ARN of the rule groups namespace.
String name
The name of the rule groups namespace that was updated.
RuleGroupsNamespaceStatus status
A structure that includes the current status of the rule groups namespace.
Map<K,V> tags
The list of tag keys and values that are associated with the namespace.
String arn
The ARN of the rule groups namespace.
Date createdAt
The date and time that the rule groups namespace was created.
ByteBuffer data
The rule groups file used in the namespace.
For details about the rule groups namespace structure, see RuleGroupsNamespaceData.
Date modifiedAt
The date and time that the rule groups namespace was most recently changed.
String name
The name of the rule groups namespace.
RuleGroupsNamespaceStatus status
The current status of the rule groups namespace.
Map<K,V> tags
The list of tag keys and values that are associated with the rule groups namespace.
String arn
The ARN of the rule groups namespace.
Date createdAt
The date and time that the rule groups namespace was created.
Date modifiedAt
The date and time that the rule groups namespace was most recently changed.
String name
The name of the rule groups namespace.
RuleGroupsNamespaceStatus status
A structure that displays the current status of the rule groups namespace.
Map<K,V> tags
The list of tag keys and values that are associated with the rule groups namespace.
ByteBuffer configurationBlob
The base 64 encoded scrape configuration file.
String alias
(Optional) A name associated with the scraper.
String arn
The Amazon Resource Name (ARN) of the scraper.
Date createdAt
The date and time that the scraper was created.
Destination destination
The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
Date lastModifiedAt
The date and time that the scraper was last modified.
String roleArn
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.
ScrapeConfiguration scrapeConfiguration
The configuration file in use by the scraper.
String scraperId
The ID of the scraper.
Source source
The Amazon EKS cluster from which the scraper collects metrics.
ScraperStatus status
A structure that contains the current status of the scraper.
String statusReason
If there is a failure, the reason for the failure.
Map<K,V> tags
(Optional) The list of tag keys and values associated with the scraper.
String statusCode
The current status of the scraper.
String alias
(Optional) A name associated with the scraper.
String arn
The Amazon Resource Name (ARN) of the scraper.
Date createdAt
The date and time that the scraper was created.
Destination destination
The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
Date lastModifiedAt
The date and time that the scraper was last modified.
String roleArn
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.
String scraperId
The ID of the scraper.
Source source
The Amazon EKS cluster from which the scraper collects metrics.
ScraperStatus status
A structure that contains the current status of the scraper.
String statusReason
If there is a failure, the reason for the failure.
Map<K,V> tags
(Optional) The list of tag keys and values associated with the scraper.
EksConfiguration eksConfiguration
The Amazon EKS cluster from which a scraper collects metrics.
String clientToken
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
String logGroupArn
The ARN of the CloudWatch log group to which the vended log data will be published.
String workspaceId
The ID of the workspace to update the logging configuration for.
LoggingConfigurationStatus status
A structure that contains the current status of the logging configuration.
String 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.
String clientToken
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
String workspaceId
The ID of the workspace to update.
String alias
The alias that is assigned to this workspace to help identify it. It may not be unique.
String arn
The ARN of the workspace.
Date createdAt
The date and time that the workspace was created.
String kmsKeyArn
(optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.
String prometheusEndpoint
The Prometheus endpoint available for this workspace.
WorkspaceStatus status
The current status of the workspace.
Map<K,V> tags
The list of tag keys and values that are associated with the workspace.
String workspaceId
The unique ID for the workspace.
String statusCode
The current status of the workspace.
String alias
The alias that is assigned to this workspace to help identify it. It may not be unique.
String arn
The ARN of the workspace.
Date createdAt
The date and time that the workspace was created.
String kmsKeyArn
(optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.
WorkspaceStatus status
The current status of the workspace.
Map<K,V> tags
The list of tag keys and values that are associated with the workspace.
String workspaceId
The unique ID for the workspace.
Copyright © 2024. All rights reserved.