PrometheusServiceClient#
Index > PrometheusService > PrometheusServiceClient
Auto-generated documentation for PrometheusService type annotations stubs module mypy-boto3-amp.
PrometheusServiceClient#
Type annotations and code completion for boto3.client("amp")
.
boto3 documentation
# PrometheusServiceClient usage example
from boto3.session import Session
from mypy_boto3_amp.client import PrometheusServiceClient
def get_amp_client() -> PrometheusServiceClient:
return Session().client("amp")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("amp").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("amp")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.InternalServerException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.ThrottlingException,
client.exceptions.ValidationException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_amp.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("amp").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("amp").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_alert_manager_definition#
Create an alert manager definition.
Type annotations and code completion for boto3.client("amp").create_alert_manager_definition
method.
boto3 documentation
# create_alert_manager_definition method definition
def create_alert_manager_definition(
self,
*,
workspaceId: str,
data: Union[str, bytes, IO[Any], StreamingBody],
clientToken: str = ...,
) -> CreateAlertManagerDefinitionResponseTypeDef: # (1)
...
# create_alert_manager_definition method usage example with argument unpacking
kwargs: CreateAlertManagerDefinitionRequestRequestTypeDef = { # (1)
"workspaceId": ...,
"data": ...,
}
parent.create_alert_manager_definition(**kwargs)
create_logging_configuration#
Create logging configuration.
Type annotations and code completion for boto3.client("amp").create_logging_configuration
method.
boto3 documentation
# create_logging_configuration method definition
def create_logging_configuration(
self,
*,
workspaceId: str,
logGroupArn: str,
clientToken: str = ...,
) -> CreateLoggingConfigurationResponseTypeDef: # (1)
...
# create_logging_configuration method usage example with argument unpacking
kwargs: CreateLoggingConfigurationRequestRequestTypeDef = { # (1)
"workspaceId": ...,
"logGroupArn": ...,
}
parent.create_logging_configuration(**kwargs)
create_rule_groups_namespace#
Create a rule group namespace.
Type annotations and code completion for boto3.client("amp").create_rule_groups_namespace
method.
boto3 documentation
# create_rule_groups_namespace method definition
def create_rule_groups_namespace(
self,
*,
workspaceId: str,
name: str,
data: Union[str, bytes, IO[Any], StreamingBody],
clientToken: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateRuleGroupsNamespaceResponseTypeDef: # (1)
...
# create_rule_groups_namespace method usage example with argument unpacking
kwargs: CreateRuleGroupsNamespaceRequestRequestTypeDef = { # (1)
"workspaceId": ...,
"name": ...,
"data": ...,
}
parent.create_rule_groups_namespace(**kwargs)
create_scraper#
Create a scraper.
Type annotations and code completion for boto3.client("amp").create_scraper
method.
boto3 documentation
# create_scraper method definition
def create_scraper(
self,
*,
scrapeConfiguration: ScrapeConfigurationTypeDef, # (1)
source: SourceTypeDef, # (2)
destination: DestinationTypeDef, # (3)
alias: str = ...,
clientToken: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateScraperResponseTypeDef: # (4)
...
- See ScrapeConfigurationTypeDef
- See SourceTypeDef
- See DestinationTypeDef
- See CreateScraperResponseTypeDef
# create_scraper method usage example with argument unpacking
kwargs: CreateScraperRequestRequestTypeDef = { # (1)
"scrapeConfiguration": ...,
"source": ...,
"destination": ...,
}
parent.create_scraper(**kwargs)
create_workspace#
Creates a new AMP workspace.
Type annotations and code completion for boto3.client("amp").create_workspace
method.
boto3 documentation
# create_workspace method definition
def create_workspace(
self,
*,
alias: str = ...,
clientToken: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateWorkspaceResponseTypeDef: # (1)
...
# create_workspace method usage example with argument unpacking
kwargs: CreateWorkspaceRequestRequestTypeDef = { # (1)
"alias": ...,
}
parent.create_workspace(**kwargs)
delete_alert_manager_definition#
Deletes an alert manager definition.
Type annotations and code completion for boto3.client("amp").delete_alert_manager_definition
method.
boto3 documentation
# delete_alert_manager_definition method definition
def delete_alert_manager_definition(
self,
*,
workspaceId: str,
clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_alert_manager_definition method usage example with argument unpacking
kwargs: DeleteAlertManagerDefinitionRequestRequestTypeDef = { # (1)
"workspaceId": ...,
}
parent.delete_alert_manager_definition(**kwargs)
delete_logging_configuration#
Delete logging configuration.
Type annotations and code completion for boto3.client("amp").delete_logging_configuration
method.
boto3 documentation
# delete_logging_configuration method definition
def delete_logging_configuration(
self,
*,
workspaceId: str,
clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_logging_configuration method usage example with argument unpacking
kwargs: DeleteLoggingConfigurationRequestRequestTypeDef = { # (1)
"workspaceId": ...,
}
parent.delete_logging_configuration(**kwargs)
delete_rule_groups_namespace#
Delete a rule groups namespace.
Type annotations and code completion for boto3.client("amp").delete_rule_groups_namespace
method.
boto3 documentation
# delete_rule_groups_namespace method definition
def delete_rule_groups_namespace(
self,
*,
workspaceId: str,
name: str,
clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_rule_groups_namespace method usage example with argument unpacking
kwargs: DeleteRuleGroupsNamespaceRequestRequestTypeDef = { # (1)
"workspaceId": ...,
"name": ...,
}
parent.delete_rule_groups_namespace(**kwargs)
delete_scraper#
Deletes a scraper.
Type annotations and code completion for boto3.client("amp").delete_scraper
method.
boto3 documentation
# delete_scraper method definition
def delete_scraper(
self,
*,
scraperId: str,
clientToken: str = ...,
) -> DeleteScraperResponseTypeDef: # (1)
...
# delete_scraper method usage example with argument unpacking
kwargs: DeleteScraperRequestRequestTypeDef = { # (1)
"scraperId": ...,
}
parent.delete_scraper(**kwargs)
delete_workspace#
Deletes an AMP workspace.
Type annotations and code completion for boto3.client("amp").delete_workspace
method.
boto3 documentation
# delete_workspace method definition
def delete_workspace(
self,
*,
workspaceId: str,
clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_workspace method usage example with argument unpacking
kwargs: DeleteWorkspaceRequestRequestTypeDef = { # (1)
"workspaceId": ...,
}
parent.delete_workspace(**kwargs)
describe_alert_manager_definition#
Describes an alert manager definition.
Type annotations and code completion for boto3.client("amp").describe_alert_manager_definition
method.
boto3 documentation
# describe_alert_manager_definition method definition
def describe_alert_manager_definition(
self,
*,
workspaceId: str,
) -> DescribeAlertManagerDefinitionResponseTypeDef: # (1)
...
# describe_alert_manager_definition method usage example with argument unpacking
kwargs: DescribeAlertManagerDefinitionRequestRequestTypeDef = { # (1)
"workspaceId": ...,
}
parent.describe_alert_manager_definition(**kwargs)
describe_logging_configuration#
Describes logging configuration.
Type annotations and code completion for boto3.client("amp").describe_logging_configuration
method.
boto3 documentation
# describe_logging_configuration method definition
def describe_logging_configuration(
self,
*,
workspaceId: str,
) -> DescribeLoggingConfigurationResponseTypeDef: # (1)
...
# describe_logging_configuration method usage example with argument unpacking
kwargs: DescribeLoggingConfigurationRequestRequestTypeDef = { # (1)
"workspaceId": ...,
}
parent.describe_logging_configuration(**kwargs)
describe_rule_groups_namespace#
Describe a rule groups namespace.
Type annotations and code completion for boto3.client("amp").describe_rule_groups_namespace
method.
boto3 documentation
# describe_rule_groups_namespace method definition
def describe_rule_groups_namespace(
self,
*,
workspaceId: str,
name: str,
) -> DescribeRuleGroupsNamespaceResponseTypeDef: # (1)
...
# describe_rule_groups_namespace method usage example with argument unpacking
kwargs: DescribeRuleGroupsNamespaceRequestRequestTypeDef = { # (1)
"workspaceId": ...,
"name": ...,
}
parent.describe_rule_groups_namespace(**kwargs)
describe_scraper#
Describe an existing scraper.
Type annotations and code completion for boto3.client("amp").describe_scraper
method.
boto3 documentation
# describe_scraper method definition
def describe_scraper(
self,
*,
scraperId: str,
) -> DescribeScraperResponseTypeDef: # (1)
...
# describe_scraper method usage example with argument unpacking
kwargs: DescribeScraperRequestRequestTypeDef = { # (1)
"scraperId": ...,
}
parent.describe_scraper(**kwargs)
describe_workspace#
Describes an existing AMP workspace.
Type annotations and code completion for boto3.client("amp").describe_workspace
method.
boto3 documentation
# describe_workspace method definition
def describe_workspace(
self,
*,
workspaceId: str,
) -> DescribeWorkspaceResponseTypeDef: # (1)
...
# describe_workspace method usage example with argument unpacking
kwargs: DescribeWorkspaceRequestRequestTypeDef = { # (1)
"workspaceId": ...,
}
parent.describe_workspace(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("amp").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_default_scraper_configuration#
Gets a default configuration.
Type annotations and code completion for boto3.client("amp").get_default_scraper_configuration
method.