Interface AmpClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface AmpClient extends AwsClient
Service client for accessing Amazon Prometheus Service. This can be created using the staticbuilder()method.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.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static AmpClientBuilderbuilder()Create a builder that can be used to configure and create aAmpClient.static AmpClientcreate()Create aAmpClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateAlertManagerDefinitionResponsecreateAlertManagerDefinition(Consumer<CreateAlertManagerDefinitionRequest.Builder> createAlertManagerDefinitionRequest)TheCreateAlertManagerDefinitionoperation creates the alert manager definition in a workspace.default CreateAlertManagerDefinitionResponsecreateAlertManagerDefinition(CreateAlertManagerDefinitionRequest createAlertManagerDefinitionRequest)TheCreateAlertManagerDefinitionoperation creates the alert manager definition in a workspace.default CreateLoggingConfigurationResponsecreateLoggingConfiguration(Consumer<CreateLoggingConfigurationRequest.Builder> createLoggingConfigurationRequest)TheCreateLoggingConfigurationoperation creates a logging configuration for the workspace.default CreateLoggingConfigurationResponsecreateLoggingConfiguration(CreateLoggingConfigurationRequest createLoggingConfigurationRequest)TheCreateLoggingConfigurationoperation creates a logging configuration for the workspace.default CreateRuleGroupsNamespaceResponsecreateRuleGroupsNamespace(Consumer<CreateRuleGroupsNamespaceRequest.Builder> createRuleGroupsNamespaceRequest)TheCreateRuleGroupsNamespaceoperation creates a rule groups namespace within a workspace.default CreateRuleGroupsNamespaceResponsecreateRuleGroupsNamespace(CreateRuleGroupsNamespaceRequest createRuleGroupsNamespaceRequest)TheCreateRuleGroupsNamespaceoperation creates a rule groups namespace within a workspace.default CreateScraperResponsecreateScraper(Consumer<CreateScraperRequest.Builder> createScraperRequest)TheCreateScraperoperation creates a scraper to collect metrics.default CreateScraperResponsecreateScraper(CreateScraperRequest createScraperRequest)TheCreateScraperoperation creates a scraper to collect metrics.default CreateWorkspaceResponsecreateWorkspace(Consumer<CreateWorkspaceRequest.Builder> createWorkspaceRequest)Creates a Prometheus workspace.default CreateWorkspaceResponsecreateWorkspace(CreateWorkspaceRequest createWorkspaceRequest)Creates a Prometheus workspace.default DeleteAlertManagerDefinitionResponsedeleteAlertManagerDefinition(Consumer<DeleteAlertManagerDefinitionRequest.Builder> deleteAlertManagerDefinitionRequest)Deletes the alert manager definition from a workspace.default DeleteAlertManagerDefinitionResponsedeleteAlertManagerDefinition(DeleteAlertManagerDefinitionRequest deleteAlertManagerDefinitionRequest)Deletes the alert manager definition from a workspace.default DeleteLoggingConfigurationResponsedeleteLoggingConfiguration(Consumer<DeleteLoggingConfigurationRequest.Builder> deleteLoggingConfigurationRequest)Deletes the logging configuration for a workspace.default DeleteLoggingConfigurationResponsedeleteLoggingConfiguration(DeleteLoggingConfigurationRequest deleteLoggingConfigurationRequest)Deletes the logging configuration for a workspace.default DeleteRuleGroupsNamespaceResponsedeleteRuleGroupsNamespace(Consumer<DeleteRuleGroupsNamespaceRequest.Builder> deleteRuleGroupsNamespaceRequest)Deletes one rule groups namespace and its associated rule groups definition.default DeleteRuleGroupsNamespaceResponsedeleteRuleGroupsNamespace(DeleteRuleGroupsNamespaceRequest deleteRuleGroupsNamespaceRequest)Deletes one rule groups namespace and its associated rule groups definition.default DeleteScraperResponsedeleteScraper(Consumer<DeleteScraperRequest.Builder> deleteScraperRequest)TheDeleteScraperoperation deletes one scraper, and stops any metrics collection that the scraper performs.default DeleteScraperResponsedeleteScraper(DeleteScraperRequest deleteScraperRequest)TheDeleteScraperoperation deletes one scraper, and stops any metrics collection that the scraper performs.default DeleteWorkspaceResponsedeleteWorkspace(Consumer<DeleteWorkspaceRequest.Builder> deleteWorkspaceRequest)Deletes an existing workspace.default DeleteWorkspaceResponsedeleteWorkspace(DeleteWorkspaceRequest deleteWorkspaceRequest)Deletes an existing workspace.default DescribeAlertManagerDefinitionResponsedescribeAlertManagerDefinition(Consumer<DescribeAlertManagerDefinitionRequest.Builder> describeAlertManagerDefinitionRequest)Retrieves the full information about the alert manager definition for a workspace.default DescribeAlertManagerDefinitionResponsedescribeAlertManagerDefinition(DescribeAlertManagerDefinitionRequest describeAlertManagerDefinitionRequest)Retrieves the full information about the alert manager definition for a workspace.default DescribeLoggingConfigurationResponsedescribeLoggingConfiguration(Consumer<DescribeLoggingConfigurationRequest.Builder> describeLoggingConfigurationRequest)Returns complete information about the current logging configuration of the workspace.default DescribeLoggingConfigurationResponsedescribeLoggingConfiguration(DescribeLoggingConfigurationRequest describeLoggingConfigurationRequest)Returns complete information about the current logging configuration of the workspace.default DescribeRuleGroupsNamespaceResponsedescribeRuleGroupsNamespace(Consumer<DescribeRuleGroupsNamespaceRequest.Builder> describeRuleGroupsNamespaceRequest)Returns complete information about one rule groups namespace.default DescribeRuleGroupsNamespaceResponsedescribeRuleGroupsNamespace(DescribeRuleGroupsNamespaceRequest describeRuleGroupsNamespaceRequest)Returns complete information about one rule groups namespace.default DescribeScraperResponsedescribeScraper(Consumer<DescribeScraperRequest.Builder> describeScraperRequest)TheDescribeScraperoperation displays information about an existing scraper.default DescribeScraperResponsedescribeScraper(DescribeScraperRequest describeScraperRequest)TheDescribeScraperoperation displays information about an existing scraper.default DescribeWorkspaceResponsedescribeWorkspace(Consumer<DescribeWorkspaceRequest.Builder> describeWorkspaceRequest)Returns information about an existing workspace.default DescribeWorkspaceResponsedescribeWorkspace(DescribeWorkspaceRequest describeWorkspaceRequest)Returns information about an existing workspace.default GetDefaultScraperConfigurationResponsegetDefaultScraperConfiguration(Consumer<GetDefaultScraperConfigurationRequest.Builder> getDefaultScraperConfigurationRequest)TheGetDefaultScraperConfigurationoperation returns the default scraper configuration used when Amazon EKS creates a scraper for you.default GetDefaultScraperConfigurationResponsegetDefaultScraperConfiguration(GetDefaultScraperConfigurationRequest getDefaultScraperConfigurationRequest)TheGetDefaultScraperConfigurationoperation returns the default scraper configuration used when Amazon EKS creates a scraper for you.default ListRuleGroupsNamespacesResponselistRuleGroupsNamespaces(Consumer<ListRuleGroupsNamespacesRequest.Builder> listRuleGroupsNamespacesRequest)Returns a list of rule groups namespaces in a workspace.default ListRuleGroupsNamespacesResponselistRuleGroupsNamespaces(ListRuleGroupsNamespacesRequest listRuleGroupsNamespacesRequest)Returns a list of rule groups namespaces in a workspace.default ListRuleGroupsNamespacesIterablelistRuleGroupsNamespacesPaginator(Consumer<ListRuleGroupsNamespacesRequest.Builder> listRuleGroupsNamespacesRequest)This is a variant oflistRuleGroupsNamespaces(software.amazon.awssdk.services.amp.model.ListRuleGroupsNamespacesRequest)operation.default ListRuleGroupsNamespacesIterablelistRuleGroupsNamespacesPaginator(ListRuleGroupsNamespacesRequest listRuleGroupsNamespacesRequest)This is a variant oflistRuleGroupsNamespaces(software.amazon.awssdk.services.amp.model.ListRuleGroupsNamespacesRequest)operation.default ListScrapersResponselistScrapers(Consumer<ListScrapersRequest.Builder> listScrapersRequest)TheListScrapersoperation lists all of the scrapers in your account.default ListScrapersResponselistScrapers(ListScrapersRequest listScrapersRequest)TheListScrapersoperation lists all of the scrapers in your account.default ListScrapersIterablelistScrapersPaginator(Consumer<ListScrapersRequest.Builder> listScrapersRequest)This is a variant oflistScrapers(software.amazon.awssdk.services.amp.model.ListScrapersRequest)operation.default ListScrapersIterablelistScrapersPaginator(ListScrapersRequest listScrapersRequest)This is a variant oflistScrapers(software.amazon.awssdk.services.amp.model.ListScrapersRequest)operation.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)TheListTagsForResourceoperation returns the tags that are associated with an Amazon Managed Service for Prometheus resource.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)TheListTagsForResourceoperation returns the tags that are associated with an Amazon Managed Service for Prometheus resource.default ListWorkspacesResponselistWorkspaces(Consumer<ListWorkspacesRequest.Builder> listWorkspacesRequest)Lists all of the Amazon Managed Service for Prometheus workspaces in your account.default ListWorkspacesResponselistWorkspaces(ListWorkspacesRequest listWorkspacesRequest)Lists all of the Amazon Managed Service for Prometheus workspaces in your account.default ListWorkspacesIterablelistWorkspacesPaginator(Consumer<ListWorkspacesRequest.Builder> listWorkspacesRequest)This is a variant oflistWorkspaces(software.amazon.awssdk.services.amp.model.ListWorkspacesRequest)operation.default ListWorkspacesIterablelistWorkspacesPaginator(ListWorkspacesRequest listWorkspacesRequest)This is a variant oflistWorkspaces(software.amazon.awssdk.services.amp.model.ListWorkspacesRequest)operation.default PutAlertManagerDefinitionResponseputAlertManagerDefinition(Consumer<PutAlertManagerDefinitionRequest.Builder> putAlertManagerDefinitionRequest)Updates an existing alert manager definition in a workspace.default PutAlertManagerDefinitionResponseputAlertManagerDefinition(PutAlertManagerDefinitionRequest putAlertManagerDefinitionRequest)Updates an existing alert manager definition in a workspace.default PutRuleGroupsNamespaceResponseputRuleGroupsNamespace(Consumer<PutRuleGroupsNamespaceRequest.Builder> putRuleGroupsNamespaceRequest)Updates an existing rule groups namespace within a workspace.default PutRuleGroupsNamespaceResponseputRuleGroupsNamespace(PutRuleGroupsNamespaceRequest putRuleGroupsNamespaceRequest)Updates an existing rule groups namespace within a workspace.default AmpServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)TheTagResourceoperation associates tags with an Amazon Managed Service for Prometheus resource.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest)TheTagResourceoperation associates tags with an Amazon Managed Service for Prometheus resource.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)Removes the specified tags from an Amazon Managed Service for Prometheus resource.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest)Removes the specified tags from an Amazon Managed Service for Prometheus resource.default UpdateLoggingConfigurationResponseupdateLoggingConfiguration(Consumer<UpdateLoggingConfigurationRequest.Builder> updateLoggingConfigurationRequest)Updates the log group ARN or the workspace ID of the current logging configuration.default UpdateLoggingConfigurationResponseupdateLoggingConfiguration(UpdateLoggingConfigurationRequest updateLoggingConfigurationRequest)Updates the log group ARN or the workspace ID of the current logging configuration.default UpdateScraperResponseupdateScraper(Consumer<UpdateScraperRequest.Builder> updateScraperRequest)Updates an existing scraper.default UpdateScraperResponseupdateScraper(UpdateScraperRequest updateScraperRequest)Updates an existing scraper.default UpdateWorkspaceAliasResponseupdateWorkspaceAlias(Consumer<UpdateWorkspaceAliasRequest.Builder> updateWorkspaceAliasRequest)Updates the alias of an existing workspace.default UpdateWorkspaceAliasResponseupdateWorkspaceAlias(UpdateWorkspaceAliasRequest updateWorkspaceAliasRequest)Updates the alias of an existing workspace.default AmpWaiterwaiter()Create an instance ofAmpWaiterusing this client.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
createAlertManagerDefinition
default CreateAlertManagerDefinitionResponse createAlertManagerDefinition(CreateAlertManagerDefinitionRequest createAlertManagerDefinitionRequest) throws ThrottlingException, ConflictException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, AmpException
The
CreateAlertManagerDefinitionoperation 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, usePutAlertManagerDefinition.- Parameters:
createAlertManagerDefinitionRequest- Represents the input of aCreateAlertManagerDefinitionoperation.- Returns:
- Result of the CreateAlertManagerDefinition operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ConflictException- The request would cause an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.ServiceQuotaExceededException- Completing the request would cause a service quota to be exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAlertManagerDefinition
default CreateAlertManagerDefinitionResponse createAlertManagerDefinition(Consumer<CreateAlertManagerDefinitionRequest.Builder> createAlertManagerDefinitionRequest) throws ThrottlingException, ConflictException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, AmpException
The
CreateAlertManagerDefinitionoperation 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, usePutAlertManagerDefinition.
This is a convenience which creates an instance of the
CreateAlertManagerDefinitionRequest.Builderavoiding the need to create one manually viaCreateAlertManagerDefinitionRequest.builder()- Parameters:
createAlertManagerDefinitionRequest- AConsumerthat will call methods onCreateAlertManagerDefinitionRequest.Builderto create a request. Represents the input of aCreateAlertManagerDefinitionoperation.- Returns:
- Result of the CreateAlertManagerDefinition operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ConflictException- The request would cause an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.ServiceQuotaExceededException- Completing the request would cause a service quota to be exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createLoggingConfiguration
default CreateLoggingConfigurationResponse createLoggingConfiguration(CreateLoggingConfigurationRequest createLoggingConfigurationRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
The
CreateLoggingConfigurationoperation creates a logging configuration for the workspace. Use this operation to set the CloudWatch log group to which the logs will be published to.- Parameters:
createLoggingConfigurationRequest- Represents the input of aCreateLoggingConfigurationoperation.- Returns:
- Result of the CreateLoggingConfiguration operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createLoggingConfiguration
default CreateLoggingConfigurationResponse createLoggingConfiguration(Consumer<CreateLoggingConfigurationRequest.Builder> createLoggingConfigurationRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
The
CreateLoggingConfigurationoperation creates a logging configuration for the workspace. Use this operation to set the CloudWatch log group to which the logs will be published to.
This is a convenience which creates an instance of the
CreateLoggingConfigurationRequest.Builderavoiding the need to create one manually viaCreateLoggingConfigurationRequest.builder()- Parameters:
createLoggingConfigurationRequest- AConsumerthat will call methods onCreateLoggingConfigurationRequest.Builderto create a request. Represents the input of aCreateLoggingConfigurationoperation.- Returns:
- Result of the CreateLoggingConfiguration operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createRuleGroupsNamespace
default CreateRuleGroupsNamespaceResponse createRuleGroupsNamespace(CreateRuleGroupsNamespaceRequest createRuleGroupsNamespaceRequest) throws ThrottlingException, ConflictException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, AmpException
The
CreateRuleGroupsNamespaceoperation 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.- Parameters:
createRuleGroupsNamespaceRequest- Represents the input of aCreateRuleGroupsNamespaceoperation.- Returns:
- Result of the CreateRuleGroupsNamespace operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ConflictException- The request would cause an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.ServiceQuotaExceededException- Completing the request would cause a service quota to be exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createRuleGroupsNamespace
default CreateRuleGroupsNamespaceResponse createRuleGroupsNamespace(Consumer<CreateRuleGroupsNamespaceRequest.Builder> createRuleGroupsNamespaceRequest) throws ThrottlingException, ConflictException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, AmpException
The
CreateRuleGroupsNamespaceoperation 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.
This is a convenience which creates an instance of the
CreateRuleGroupsNamespaceRequest.Builderavoiding the need to create one manually viaCreateRuleGroupsNamespaceRequest.builder()- Parameters:
createRuleGroupsNamespaceRequest- AConsumerthat will call methods onCreateRuleGroupsNamespaceRequest.Builderto create a request. Represents the input of aCreateRuleGroupsNamespaceoperation.- Returns:
- Result of the CreateRuleGroupsNamespace operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ConflictException- The request would cause an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.ServiceQuotaExceededException- Completing the request would cause a service quota to be exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createScraper
default CreateScraperResponse createScraper(CreateScraperRequest createScraperRequest) throws ThrottlingException, ConflictException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, AmpException
The
CreateScraperoperation 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
scrapeConfigurationparameter 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.
- Parameters:
createScraperRequest- Represents the input of aCreateScraperoperation.- Returns:
- Result of the CreateScraper operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ConflictException- The request would cause an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.ServiceQuotaExceededException- Completing the request would cause a service quota to be exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createScraper
default CreateScraperResponse createScraper(Consumer<CreateScraperRequest.Builder> createScraperRequest) throws ThrottlingException, ConflictException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, AmpException
The
CreateScraperoperation 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
scrapeConfigurationparameter 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.
This is a convenience which creates an instance of the
CreateScraperRequest.Builderavoiding the need to create one manually viaCreateScraperRequest.builder()- Parameters:
createScraperRequest- AConsumerthat will call methods onCreateScraperRequest.Builderto create a request. Represents the input of aCreateScraperoperation.- Returns:
- Result of the CreateScraper operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ConflictException- The request would cause an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.ServiceQuotaExceededException- Completing the request would cause a service quota to be exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createWorkspace
default CreateWorkspaceResponse createWorkspace(CreateWorkspaceRequest createWorkspaceRequest) throws ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, AmpException
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.
- Parameters:
createWorkspaceRequest- Represents the input of aCreateWorkspaceoperation.- Returns:
- Result of the CreateWorkspace operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ConflictException- The request would cause an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.ServiceQuotaExceededException- Completing the request would cause a service quota to be exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createWorkspace
default CreateWorkspaceResponse createWorkspace(Consumer<CreateWorkspaceRequest.Builder> createWorkspaceRequest) throws ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, AmpException
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.
This is a convenience which creates an instance of the
CreateWorkspaceRequest.Builderavoiding the need to create one manually viaCreateWorkspaceRequest.builder()- Parameters:
createWorkspaceRequest- AConsumerthat will call methods onCreateWorkspaceRequest.Builderto create a request. Represents the input of aCreateWorkspaceoperation.- Returns:
- Result of the CreateWorkspace operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ConflictException- The request would cause an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.ServiceQuotaExceededException- Completing the request would cause a service quota to be exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAlertManagerDefinition
default DeleteAlertManagerDefinitionResponse deleteAlertManagerDefinition(DeleteAlertManagerDefinitionRequest deleteAlertManagerDefinitionRequest) throws ThrottlingException, ConflictException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
Deletes the alert manager definition from a workspace.
- Parameters:
deleteAlertManagerDefinitionRequest- Represents the input of aDeleteAlertManagerDefinitionoperation.- Returns:
- Result of the DeleteAlertManagerDefinition operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ConflictException- The request would cause an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAlertManagerDefinition
default DeleteAlertManagerDefinitionResponse deleteAlertManagerDefinition(Consumer<DeleteAlertManagerDefinitionRequest.Builder> deleteAlertManagerDefinitionRequest) throws ThrottlingException, ConflictException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
Deletes the alert manager definition from a workspace.
This is a convenience which creates an instance of the
DeleteAlertManagerDefinitionRequest.Builderavoiding the need to create one manually viaDeleteAlertManagerDefinitionRequest.builder()- Parameters:
deleteAlertManagerDefinitionRequest- AConsumerthat will call methods onDeleteAlertManagerDefinitionRequest.Builderto create a request. Represents the input of aDeleteAlertManagerDefinitionoperation.- Returns:
- Result of the DeleteAlertManagerDefinition operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ConflictException- The request would cause an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteLoggingConfiguration
default DeleteLoggingConfigurationResponse deleteLoggingConfiguration(DeleteLoggingConfigurationRequest deleteLoggingConfigurationRequest) throws ConflictException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
Deletes the logging configuration for a workspace.
- Parameters:
deleteLoggingConfigurationRequest- Represents the input of aDeleteLoggingConfigurationoperation.- Returns:
- Result of the DeleteLoggingConfiguration operation returned by the service.
- Throws:
ConflictException- The request would cause an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteLoggingConfiguration
default DeleteLoggingConfigurationResponse deleteLoggingConfiguration(Consumer<DeleteLoggingConfigurationRequest.Builder> deleteLoggingConfigurationRequest) throws ConflictException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
Deletes the logging configuration for a workspace.
This is a convenience which creates an instance of the
DeleteLoggingConfigurationRequest.Builderavoiding the need to create one manually viaDeleteLoggingConfigurationRequest.builder()- Parameters:
deleteLoggingConfigurationRequest- AConsumerthat will call methods onDeleteLoggingConfigurationRequest.Builderto create a request. Represents the input of aDeleteLoggingConfigurationoperation.- Returns:
- Result of the DeleteLoggingConfiguration operation returned by the service.
- Throws:
ConflictException- The request would cause an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRuleGroupsNamespace
default DeleteRuleGroupsNamespaceResponse deleteRuleGroupsNamespace(DeleteRuleGroupsNamespaceRequest deleteRuleGroupsNamespaceRequest) throws ThrottlingException, ConflictException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
Deletes one rule groups namespace and its associated rule groups definition.
- Parameters:
deleteRuleGroupsNamespaceRequest- Represents the input of aDeleteRuleGroupsNamespaceoperation.- Returns:
- Result of the DeleteRuleGroupsNamespace operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ConflictException- The request would cause an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRuleGroupsNamespace
default DeleteRuleGroupsNamespaceResponse deleteRuleGroupsNamespace(Consumer<DeleteRuleGroupsNamespaceRequest.Builder> deleteRuleGroupsNamespaceRequest) throws ThrottlingException, ConflictException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
Deletes one rule groups namespace and its associated rule groups definition.
This is a convenience which creates an instance of the
DeleteRuleGroupsNamespaceRequest.Builderavoiding the need to create one manually viaDeleteRuleGroupsNamespaceRequest.builder()- Parameters:
deleteRuleGroupsNamespaceRequest- AConsumerthat will call methods onDeleteRuleGroupsNamespaceRequest.Builderto create a request. Represents the input of aDeleteRuleGroupsNamespaceoperation.- Returns:
- Result of the DeleteRuleGroupsNamespace operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ConflictException- The request would cause an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteScraper
default DeleteScraperResponse deleteScraper(DeleteScraperRequest deleteScraperRequest) throws ThrottlingException, ConflictException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
The
DeleteScraperoperation deletes one scraper, and stops any metrics collection that the scraper performs.- Parameters:
deleteScraperRequest- Represents the input of aDeleteScraperoperation.- Returns:
- Result of the DeleteScraper operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ConflictException- The request would cause an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteScraper
default DeleteScraperResponse deleteScraper(Consumer<DeleteScraperRequest.Builder> deleteScraperRequest) throws ThrottlingException, ConflictException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
The
DeleteScraperoperation deletes one scraper, and stops any metrics collection that the scraper performs.
This is a convenience which creates an instance of the
DeleteScraperRequest.Builderavoiding the need to create one manually viaDeleteScraperRequest.builder()- Parameters:
deleteScraperRequest- AConsumerthat will call methods onDeleteScraperRequest.Builderto create a request. Represents the input of aDeleteScraperoperation.- Returns:
- Result of the DeleteScraper operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ConflictException- The request would cause an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWorkspace
default DeleteWorkspaceResponse deleteWorkspace(DeleteWorkspaceRequest deleteWorkspaceRequest) throws ThrottlingException, ConflictException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
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.
- Parameters:
deleteWorkspaceRequest- Represents the input of aDeleteWorkspaceoperation.- Returns:
- Result of the DeleteWorkspace operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ConflictException- The request would cause an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWorkspace
default DeleteWorkspaceResponse deleteWorkspace(Consumer<DeleteWorkspaceRequest.Builder> deleteWorkspaceRequest) throws ThrottlingException, ConflictException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
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.
This is a convenience which creates an instance of the
DeleteWorkspaceRequest.Builderavoiding the need to create one manually viaDeleteWorkspaceRequest.builder()- Parameters:
deleteWorkspaceRequest- AConsumerthat will call methods onDeleteWorkspaceRequest.Builderto create a request. Represents the input of aDeleteWorkspaceoperation.- Returns:
- Result of the DeleteWorkspace operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ConflictException- The request would cause an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeAlertManagerDefinition
default DescribeAlertManagerDefinitionResponse describeAlertManagerDefinition(DescribeAlertManagerDefinitionRequest describeAlertManagerDefinitionRequest) throws ThrottlingException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
Retrieves the full information about the alert manager definition for a workspace.
- Parameters:
describeAlertManagerDefinitionRequest- Represents the input of aDescribeAlertManagerDefinitionoperation.- Returns:
- Result of the DescribeAlertManagerDefinition operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeAlertManagerDefinition
default DescribeAlertManagerDefinitionResponse describeAlertManagerDefinition(Consumer<DescribeAlertManagerDefinitionRequest.Builder> describeAlertManagerDefinitionRequest) throws ThrottlingException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
Retrieves the full information about the alert manager definition for a workspace.
This is a convenience which creates an instance of the
DescribeAlertManagerDefinitionRequest.Builderavoiding the need to create one manually viaDescribeAlertManagerDefinitionRequest.builder()- Parameters:
describeAlertManagerDefinitionRequest- AConsumerthat will call methods onDescribeAlertManagerDefinitionRequest.Builderto create a request. Represents the input of aDescribeAlertManagerDefinitionoperation.- Returns:
- Result of the DescribeAlertManagerDefinition operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeLoggingConfiguration
default DescribeLoggingConfigurationResponse describeLoggingConfiguration(DescribeLoggingConfigurationRequest describeLoggingConfigurationRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
Returns complete information about the current logging configuration of the workspace.
- Parameters:
describeLoggingConfigurationRequest- Represents the input of aDescribeLoggingConfigurationoperation.- Returns:
- Result of the DescribeLoggingConfiguration operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeLoggingConfiguration
default DescribeLoggingConfigurationResponse describeLoggingConfiguration(Consumer<DescribeLoggingConfigurationRequest.Builder> describeLoggingConfigurationRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
Returns complete information about the current logging configuration of the workspace.
This is a convenience which creates an instance of the
DescribeLoggingConfigurationRequest.Builderavoiding the need to create one manually viaDescribeLoggingConfigurationRequest.builder()- Parameters:
describeLoggingConfigurationRequest- AConsumerthat will call methods onDescribeLoggingConfigurationRequest.Builderto create a request. Represents the input of aDescribeLoggingConfigurationoperation.- Returns:
- Result of the DescribeLoggingConfiguration operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeRuleGroupsNamespace
default DescribeRuleGroupsNamespaceResponse describeRuleGroupsNamespace(DescribeRuleGroupsNamespaceRequest describeRuleGroupsNamespaceRequest) throws ThrottlingException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
Returns complete information about one rule groups namespace. To retrieve a list of rule groups namespaces, use
ListRuleGroupsNamespaces.- Parameters:
describeRuleGroupsNamespaceRequest- Represents the input of aDescribeRuleGroupsNamespaceoperation.- Returns:
- Result of the DescribeRuleGroupsNamespace operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeRuleGroupsNamespace
default DescribeRuleGroupsNamespaceResponse describeRuleGroupsNamespace(Consumer<DescribeRuleGroupsNamespaceRequest.Builder> describeRuleGroupsNamespaceRequest) throws ThrottlingException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
Returns complete information about one rule groups namespace. To retrieve a list of rule groups namespaces, use
ListRuleGroupsNamespaces.
This is a convenience which creates an instance of the
DescribeRuleGroupsNamespaceRequest.Builderavoiding the need to create one manually viaDescribeRuleGroupsNamespaceRequest.builder()- Parameters:
describeRuleGroupsNamespaceRequest- AConsumerthat will call methods onDescribeRuleGroupsNamespaceRequest.Builderto create a request. Represents the input of aDescribeRuleGroupsNamespaceoperation.- Returns:
- Result of the DescribeRuleGroupsNamespace operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeScraper
default DescribeScraperResponse describeScraper(DescribeScraperRequest describeScraperRequest) throws ThrottlingException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
The
DescribeScraperoperation displays information about an existing scraper.- Parameters:
describeScraperRequest- Represents the input of aDescribeScraperoperation.- Returns:
- Result of the DescribeScraper operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeScraper
default DescribeScraperResponse describeScraper(Consumer<DescribeScraperRequest.Builder> describeScraperRequest) throws ThrottlingException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
The
DescribeScraperoperation displays information about an existing scraper.
This is a convenience which creates an instance of the
DescribeScraperRequest.Builderavoiding the need to create one manually viaDescribeScraperRequest.builder()- Parameters:
describeScraperRequest- AConsumerthat will call methods onDescribeScraperRequest.Builderto create a request. Represents the input of aDescribeScraperoperation.- Returns:
- Result of the DescribeScraper operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeWorkspace
default DescribeWorkspaceResponse describeWorkspace(DescribeWorkspaceRequest describeWorkspaceRequest) throws ThrottlingException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
Returns information about an existing workspace.
- Parameters:
describeWorkspaceRequest- Represents the input of aDescribeWorkspaceoperation.- Returns:
- Result of the DescribeWorkspace operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeWorkspace
default DescribeWorkspaceResponse describeWorkspace(Consumer<DescribeWorkspaceRequest.Builder> describeWorkspaceRequest) throws ThrottlingException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
Returns information about an existing workspace.
This is a convenience which creates an instance of the
DescribeWorkspaceRequest.Builderavoiding the need to create one manually viaDescribeWorkspaceRequest.builder()- Parameters:
describeWorkspaceRequest- AConsumerthat will call methods onDescribeWorkspaceRequest.Builderto create a request. Represents the input of aDescribeWorkspaceoperation.- Returns:
- Result of the DescribeWorkspace operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getDefaultScraperConfiguration
default GetDefaultScraperConfigurationResponse getDefaultScraperConfiguration(GetDefaultScraperConfigurationRequest getDefaultScraperConfigurationRequest) throws ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
The
GetDefaultScraperConfigurationoperation returns the default scraper configuration used when Amazon EKS creates a scraper for you.- Parameters:
getDefaultScraperConfigurationRequest- Represents the input of aGetDefaultScraperConfigurationoperation.- Returns:
- Result of the GetDefaultScraperConfiguration operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getDefaultScraperConfiguration
default GetDefaultScraperConfigurationResponse getDefaultScraperConfiguration(Consumer<GetDefaultScraperConfigurationRequest.Builder> getDefaultScraperConfigurationRequest) throws ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
The
GetDefaultScraperConfigurationoperation returns the default scraper configuration used when Amazon EKS creates a scraper for you.
This is a convenience which creates an instance of the
GetDefaultScraperConfigurationRequest.Builderavoiding the need to create one manually viaGetDefaultScraperConfigurationRequest.builder()- Parameters:
getDefaultScraperConfigurationRequest- AConsumerthat will call methods onGetDefaultScraperConfigurationRequest.Builderto create a request. Represents the input of aGetDefaultScraperConfigurationoperation.- Returns:
- Result of the GetDefaultScraperConfiguration operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listRuleGroupsNamespaces
default ListRuleGroupsNamespacesResponse listRuleGroupsNamespaces(ListRuleGroupsNamespacesRequest listRuleGroupsNamespacesRequest) throws ThrottlingException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
Returns a list of rule groups namespaces in a workspace.
- Parameters:
listRuleGroupsNamespacesRequest- Represents the input of aListRuleGroupsNamespacesoperation.- Returns:
- Result of the ListRuleGroupsNamespaces operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listRuleGroupsNamespaces
default ListRuleGroupsNamespacesResponse listRuleGroupsNamespaces(Consumer<ListRuleGroupsNamespacesRequest.Builder> listRuleGroupsNamespacesRequest) throws ThrottlingException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
Returns a list of rule groups namespaces in a workspace.
This is a convenience which creates an instance of the
ListRuleGroupsNamespacesRequest.Builderavoiding the need to create one manually viaListRuleGroupsNamespacesRequest.builder()- Parameters:
listRuleGroupsNamespacesRequest- AConsumerthat will call methods onListRuleGroupsNamespacesRequest.Builderto create a request. Represents the input of aListRuleGroupsNamespacesoperation.- Returns:
- Result of the ListRuleGroupsNamespaces operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listRuleGroupsNamespacesPaginator
default ListRuleGroupsNamespacesIterable listRuleGroupsNamespacesPaginator(ListRuleGroupsNamespacesRequest listRuleGroupsNamespacesRequest) throws ThrottlingException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
This is a variant of
listRuleGroupsNamespaces(software.amazon.awssdk.services.amp.model.ListRuleGroupsNamespacesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.amp.paginators.ListRuleGroupsNamespacesIterable responses = client.listRuleGroupsNamespacesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.amp.paginators.ListRuleGroupsNamespacesIterable responses = client .listRuleGroupsNamespacesPaginator(request); for (software.amazon.awssdk.services.amp.model.ListRuleGroupsNamespacesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.amp.paginators.ListRuleGroupsNamespacesIterable responses = client.listRuleGroupsNamespacesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRuleGroupsNamespaces(software.amazon.awssdk.services.amp.model.ListRuleGroupsNamespacesRequest)operation.- Parameters:
listRuleGroupsNamespacesRequest- Represents the input of aListRuleGroupsNamespacesoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listRuleGroupsNamespacesPaginator
default ListRuleGroupsNamespacesIterable listRuleGroupsNamespacesPaginator(Consumer<ListRuleGroupsNamespacesRequest.Builder> listRuleGroupsNamespacesRequest) throws ThrottlingException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
This is a variant of
listRuleGroupsNamespaces(software.amazon.awssdk.services.amp.model.ListRuleGroupsNamespacesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.amp.paginators.ListRuleGroupsNamespacesIterable responses = client.listRuleGroupsNamespacesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.amp.paginators.ListRuleGroupsNamespacesIterable responses = client .listRuleGroupsNamespacesPaginator(request); for (software.amazon.awssdk.services.amp.model.ListRuleGroupsNamespacesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.amp.paginators.ListRuleGroupsNamespacesIterable responses = client.listRuleGroupsNamespacesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRuleGroupsNamespaces(software.amazon.awssdk.services.amp.model.ListRuleGroupsNamespacesRequest)operation.
This is a convenience which creates an instance of the
ListRuleGroupsNamespacesRequest.Builderavoiding the need to create one manually viaListRuleGroupsNamespacesRequest.builder()- Parameters:
listRuleGroupsNamespacesRequest- AConsumerthat will call methods onListRuleGroupsNamespacesRequest.Builderto create a request. Represents the input of aListRuleGroupsNamespacesoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listScrapers
default ListScrapersResponse listScrapers(ListScrapersRequest listScrapersRequest) throws ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
The
ListScrapersoperation lists all of the scrapers in your account. This includes scrapers being created or deleted. You can optionally filter the returned list.- Parameters:
listScrapersRequest- Represents the input of aListScrapersoperation.- Returns:
- Result of the ListScrapers operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listScrapers
default ListScrapersResponse listScrapers(Consumer<ListScrapersRequest.Builder> listScrapersRequest) throws ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
The
ListScrapersoperation lists all of the scrapers in your account. This includes scrapers being created or deleted. You can optionally filter the returned list.
This is a convenience which creates an instance of the
ListScrapersRequest.Builderavoiding the need to create one manually viaListScrapersRequest.builder()- Parameters:
listScrapersRequest- AConsumerthat will call methods onListScrapersRequest.Builderto create a request. Represents the input of aListScrapersoperation.- Returns:
- Result of the ListScrapers operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listScrapersPaginator
default ListScrapersIterable listScrapersPaginator(ListScrapersRequest listScrapersRequest) throws ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
This is a variant of
listScrapers(software.amazon.awssdk.services.amp.model.ListScrapersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.amp.paginators.ListScrapersIterable responses = client.listScrapersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.amp.paginators.ListScrapersIterable responses = client.listScrapersPaginator(request); for (software.amazon.awssdk.services.amp.model.ListScrapersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.amp.paginators.ListScrapersIterable responses = client.listScrapersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listScrapers(software.amazon.awssdk.services.amp.model.ListScrapersRequest)operation.- Parameters:
listScrapersRequest- Represents the input of aListScrapersoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listScrapersPaginator
default ListScrapersIterable listScrapersPaginator(Consumer<ListScrapersRequest.Builder> listScrapersRequest) throws ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
This is a variant of
listScrapers(software.amazon.awssdk.services.amp.model.ListScrapersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.amp.paginators.ListScrapersIterable responses = client.listScrapersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.amp.paginators.ListScrapersIterable responses = client.listScrapersPaginator(request); for (software.amazon.awssdk.services.amp.model.ListScrapersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.amp.paginators.ListScrapersIterable responses = client.listScrapersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listScrapers(software.amazon.awssdk.services.amp.model.ListScrapersRequest)operation.
This is a convenience which creates an instance of the
ListScrapersRequest.Builderavoiding the need to create one manually viaListScrapersRequest.builder()- Parameters:
listScrapersRequest- AConsumerthat will call methods onListScrapersRequest.Builderto create a request. Represents the input of aListScrapersoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ThrottlingException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
The
ListTagsForResourceoperation 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.- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ThrottlingException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
The
ListTagsForResourceoperation 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.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkspaces
default ListWorkspacesResponse listWorkspaces(ListWorkspacesRequest listWorkspacesRequest) throws ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
Lists all of the Amazon Managed Service for Prometheus workspaces in your account. This includes workspaces being created or deleted.
- Parameters:
listWorkspacesRequest- Represents the input of aListWorkspacesoperation.- Returns:
- Result of the ListWorkspaces operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkspaces
default ListWorkspacesResponse listWorkspaces(Consumer<ListWorkspacesRequest.Builder> listWorkspacesRequest) throws ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
Lists all of the Amazon Managed Service for Prometheus workspaces in your account. This includes workspaces being created or deleted.
This is a convenience which creates an instance of the
ListWorkspacesRequest.Builderavoiding the need to create one manually viaListWorkspacesRequest.builder()- Parameters:
listWorkspacesRequest- AConsumerthat will call methods onListWorkspacesRequest.Builderto create a request. Represents the input of aListWorkspacesoperation.- Returns:
- Result of the ListWorkspaces operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkspacesPaginator
default ListWorkspacesIterable listWorkspacesPaginator(ListWorkspacesRequest listWorkspacesRequest) throws ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
This is a variant of
listWorkspaces(software.amazon.awssdk.services.amp.model.ListWorkspacesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.amp.paginators.ListWorkspacesIterable responses = client.listWorkspacesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.amp.paginators.ListWorkspacesIterable responses = client.listWorkspacesPaginator(request); for (software.amazon.awssdk.services.amp.model.ListWorkspacesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.amp.paginators.ListWorkspacesIterable responses = client.listWorkspacesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkspaces(software.amazon.awssdk.services.amp.model.ListWorkspacesRequest)operation.- Parameters:
listWorkspacesRequest- Represents the input of aListWorkspacesoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkspacesPaginator
default ListWorkspacesIterable listWorkspacesPaginator(Consumer<ListWorkspacesRequest.Builder> listWorkspacesRequest) throws ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
This is a variant of
listWorkspaces(software.amazon.awssdk.services.amp.model.ListWorkspacesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.amp.paginators.ListWorkspacesIterable responses = client.listWorkspacesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.amp.paginators.ListWorkspacesIterable responses = client.listWorkspacesPaginator(request); for (software.amazon.awssdk.services.amp.model.ListWorkspacesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.amp.paginators.ListWorkspacesIterable responses = client.listWorkspacesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkspaces(software.amazon.awssdk.services.amp.model.ListWorkspacesRequest)operation.
This is a convenience which creates an instance of the
ListWorkspacesRequest.Builderavoiding the need to create one manually viaListWorkspacesRequest.builder()- Parameters:
listWorkspacesRequest- AConsumerthat will call methods onListWorkspacesRequest.Builderto create a request. Represents the input of aListWorkspacesoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putAlertManagerDefinition
default PutAlertManagerDefinitionResponse putAlertManagerDefinition(PutAlertManagerDefinitionRequest putAlertManagerDefinitionRequest) throws ThrottlingException, ConflictException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, AmpException
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.- Parameters:
putAlertManagerDefinitionRequest- Represents the input of aPutAlertManagerDefinitionoperation.- Returns:
- Result of the PutAlertManagerDefinition operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ConflictException- The request would cause an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.ServiceQuotaExceededException- Completing the request would cause a service quota to be exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putAlertManagerDefinition
default PutAlertManagerDefinitionResponse putAlertManagerDefinition(Consumer<PutAlertManagerDefinitionRequest.Builder> putAlertManagerDefinitionRequest) throws ThrottlingException, ConflictException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, AmpException
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.
This is a convenience which creates an instance of the
PutAlertManagerDefinitionRequest.Builderavoiding the need to create one manually viaPutAlertManagerDefinitionRequest.builder()- Parameters:
putAlertManagerDefinitionRequest- AConsumerthat will call methods onPutAlertManagerDefinitionRequest.Builderto create a request. Represents the input of aPutAlertManagerDefinitionoperation.- Returns:
- Result of the PutAlertManagerDefinition operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ConflictException- The request would cause an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.ServiceQuotaExceededException- Completing the request would cause a service quota to be exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putRuleGroupsNamespace
default PutRuleGroupsNamespaceResponse putRuleGroupsNamespace(PutRuleGroupsNamespaceRequest putRuleGroupsNamespaceRequest) throws ThrottlingException, ConflictException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, AmpException
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.- Parameters:
putRuleGroupsNamespaceRequest- Represents the input of aPutRuleGroupsNamespaceoperation.- Returns:
- Result of the PutRuleGroupsNamespace operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ConflictException- The request would cause an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.ServiceQuotaExceededException- Completing the request would cause a service quota to be exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putRuleGroupsNamespace
default PutRuleGroupsNamespaceResponse putRuleGroupsNamespace(Consumer<PutRuleGroupsNamespaceRequest.Builder> putRuleGroupsNamespaceRequest) throws ThrottlingException, ConflictException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, AmpException
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.
This is a convenience which creates an instance of the
PutRuleGroupsNamespaceRequest.Builderavoiding the need to create one manually viaPutRuleGroupsNamespaceRequest.builder()- Parameters:
putRuleGroupsNamespaceRequest- AConsumerthat will call methods onPutRuleGroupsNamespaceRequest.Builderto create a request. Represents the input of aPutRuleGroupsNamespaceoperation.- Returns:
- Result of the PutRuleGroupsNamespace operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ConflictException- The request would cause an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.ServiceQuotaExceededException- Completing the request would cause a service quota to be exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ThrottlingException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
The
TagResourceoperation 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.- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ThrottlingException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
The
TagResourceoperation 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.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ThrottlingException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
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.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ThrottlingException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
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.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateLoggingConfiguration
default UpdateLoggingConfigurationResponse updateLoggingConfiguration(UpdateLoggingConfigurationRequest updateLoggingConfigurationRequest) throws ConflictException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
Updates the log group ARN or the workspace ID of the current logging configuration.
- Parameters:
updateLoggingConfigurationRequest- Represents the input of anUpdateLoggingConfigurationoperation.- Returns:
- Result of the UpdateLoggingConfiguration operation returned by the service.
- Throws:
ConflictException- The request would cause an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateLoggingConfiguration
default UpdateLoggingConfigurationResponse updateLoggingConfiguration(Consumer<UpdateLoggingConfigurationRequest.Builder> updateLoggingConfigurationRequest) throws ConflictException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, AmpException
Updates the log group ARN or the workspace ID of the current logging configuration.
This is a convenience which creates an instance of the
UpdateLoggingConfigurationRequest.Builderavoiding the need to create one manually viaUpdateLoggingConfigurationRequest.builder()- Parameters:
updateLoggingConfigurationRequest- AConsumerthat will call methods onUpdateLoggingConfigurationRequest.Builderto create a request. Represents the input of anUpdateLoggingConfigurationoperation.- Returns:
- Result of the UpdateLoggingConfiguration operation returned by the service.
- Throws:
ConflictException- The request would cause an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateScraper
default UpdateScraperResponse updateScraper(UpdateScraperRequest updateScraperRequest) throws ThrottlingException, ConflictException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, AmpException
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.
- Parameters:
updateScraperRequest-- Returns:
- Result of the UpdateScraper operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ConflictException- The request would cause an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.ServiceQuotaExceededException- Completing the request would cause a service quota to be exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateScraper
default UpdateScraperResponse updateScraper(Consumer<UpdateScraperRequest.Builder> updateScraperRequest) throws ThrottlingException, ConflictException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, AmpException
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.
This is a convenience which creates an instance of the
UpdateScraperRequest.Builderavoiding the need to create one manually viaUpdateScraperRequest.builder()- Parameters:
updateScraperRequest- AConsumerthat will call methods onUpdateScraperRequest.Builderto create a request.- Returns:
- Result of the UpdateScraper operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ConflictException- The request would cause an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.ServiceQuotaExceededException- Completing the request would cause a service quota to be exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateWorkspaceAlias
default UpdateWorkspaceAliasResponse updateWorkspaceAlias(UpdateWorkspaceAliasRequest updateWorkspaceAliasRequest) throws ThrottlingException, ConflictException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, AmpException
Updates the alias of an existing workspace.
- Parameters:
updateWorkspaceAliasRequest- Represents the input of anUpdateWorkspaceAliasoperation.- Returns:
- Result of the UpdateWorkspaceAlias operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ConflictException- The request would cause an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.ServiceQuotaExceededException- Completing the request would cause a service quota to be exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateWorkspaceAlias
default UpdateWorkspaceAliasResponse updateWorkspaceAlias(Consumer<UpdateWorkspaceAliasRequest.Builder> updateWorkspaceAliasRequest) throws ThrottlingException, ConflictException, ValidationException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, AmpException
Updates the alias of an existing workspace.
This is a convenience which creates an instance of the
UpdateWorkspaceAliasRequest.Builderavoiding the need to create one manually viaUpdateWorkspaceAliasRequest.builder()- Parameters:
updateWorkspaceAliasRequest- AConsumerthat will call methods onUpdateWorkspaceAliasRequest.Builderto create a request. Represents the input of anUpdateWorkspaceAliasoperation.- Returns:
- Result of the UpdateWorkspaceAlias operation returned by the service.
- Throws:
ThrottlingException- The request was denied due to request throttling.ConflictException- The request would cause an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- The request references a resources that doesn't exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An unexpected error occurred during the processing of the request.ServiceQuotaExceededException- Completing the request would cause a service quota to be exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmpException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
waiter
default AmpWaiter waiter()
Create an instance ofAmpWaiterusing this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
AmpWaiter
-
create
static AmpClient create()
Create aAmpClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static AmpClientBuilder builder()
Create a builder that can be used to configure and create aAmpClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default AmpServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-