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

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:
    ...

generate_presigned_url

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:
    ...

create_alert_manager_definition

The CreateAlertManagerDefinition operation creates the alert manager definition in a workspace.

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,
    *,
    data: BlobTypeDef,
    workspaceId: str,
    clientToken: str = ...,
) -> CreateAlertManagerDefinitionResponseTypeDef:  # (1)
    ...

1. See CreateAlertManagerDefinitionResponseTypeDef

# create_alert_manager_definition method usage example with argument unpacking

kwargs: CreateAlertManagerDefinitionRequestTypeDef = {  # (1)
    "data": ...,
    "workspaceId": ...,
}

parent.create_alert_manager_definition(**kwargs)

1. See CreateAlertManagerDefinitionRequestTypeDef

create_logging_configuration

The CreateLoggingConfiguration operation creates a logging configuration for the workspace.

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,
    *,
    logGroupArn: str,
    workspaceId: str,
    clientToken: str = ...,
) -> CreateLoggingConfigurationResponseTypeDef:  # (1)
    ...

1. See CreateLoggingConfigurationResponseTypeDef

# create_logging_configuration method usage example with argument unpacking

kwargs: CreateLoggingConfigurationRequestTypeDef = {  # (1)
    "logGroupArn": ...,
    "workspaceId": ...,
}

parent.create_logging_configuration(**kwargs)

1. See CreateLoggingConfigurationRequestTypeDef

create_rule_groups_namespace

The CreateRuleGroupsNamespace operation creates a rule groups namespace within a workspace.

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,
    *,
    data: BlobTypeDef,
    name: str,
    workspaceId: str,
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateRuleGroupsNamespaceResponseTypeDef:  # (1)
    ...

1. See CreateRuleGroupsNamespaceResponseTypeDef

# create_rule_groups_namespace method usage example with argument unpacking

kwargs: CreateRuleGroupsNamespaceRequestTypeDef = {  # (1)
    "data": ...,
    "name": ...,
    "workspaceId": ...,
}

parent.create_rule_groups_namespace(**kwargs)

1. See CreateRuleGroupsNamespaceRequestTypeDef

create_scraper

The CreateScraper operation creates a scraper to collect metrics.

Type annotations and code completion for boto3.client("amp").create_scraper method. boto3 documentation

# create_scraper method definition

def create_scraper(
    self,
    *,
    destination: DestinationTypeDef,  # (1)
    scrapeConfiguration: ScrapeConfigurationUnionTypeDef,  # (2)
    source: SourceUnionTypeDef,  # (3)
    alias: str = ...,
    clientToken: str = ...,
    roleConfiguration: RoleConfigurationTypeDef = ...,  # (4)
    tags: Mapping[str, str] = ...,
) -> CreateScraperResponseTypeDef:  # (5)
    ...

1. See DestinationTypeDef
2. See ScrapeConfigurationUnionTypeDef
3. See SourceUnionTypeDef
4. See RoleConfigurationTypeDef
5. See CreateScraperResponseTypeDef

# create_scraper method usage example with argument unpacking

kwargs: CreateScraperRequestTypeDef = {  # (1)
    "destination": ...,
    "scrapeConfiguration": ...,
    "source": ...,
}

parent.create_scraper(**kwargs)

1. See CreateScraperRequestTypeDef

create_workspace

Creates a Prometheus 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 = ...,
    kmsKeyArn: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateWorkspaceResponseTypeDef:  # (1)
    ...

1. See CreateWorkspaceResponseTypeDef

# create_workspace method usage example with argument unpacking

kwargs: CreateWorkspaceRequestTypeDef = {  # (1)
    "alias": ...,
}

parent.create_workspace(**kwargs)

1. See CreateWorkspaceRequestTypeDef

delete_alert_manager_definition

Deletes the alert manager definition from a workspace.

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)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_alert_manager_definition method usage example with argument unpacking

kwargs: DeleteAlertManagerDefinitionRequestTypeDef = {  # (1)
    "workspaceId": ...,
}

parent.delete_alert_manager_definition(**kwargs)

1. See DeleteAlertManagerDefinitionRequestTypeDef

delete_logging_configuration

Deletes the logging configuration for a workspace.

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)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_logging_configuration method usage example with argument unpacking

kwargs: DeleteLoggingConfigurationRequestTypeDef = {  # (1)
    "workspaceId": ...,
}

parent.delete_logging_configuration(**kwargs)

1. See DeleteLoggingConfigurationRequestTypeDef

delete_rule_groups_namespace

Deletes one rule groups namespace and its associated rule groups definition.

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,
    *,
    name: str,
    workspaceId: str,
    clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_rule_groups_namespace method usage example with argument unpacking

kwargs: DeleteRuleGroupsNamespaceRequestTypeDef = {  # (1)
    "name": ...,
    "workspaceId": ...,
}

parent.delete_rule_groups_namespace(**kwargs)

1. See DeleteRuleGroupsNamespaceRequestTypeDef

delete_scraper

The DeleteScraper operation deletes one scraper, and stops any metrics collection that the scraper performs.

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)
    ...

1. See DeleteScraperResponseTypeDef

# delete_scraper method usage example with argument unpacking

kwargs: DeleteScraperRequestTypeDef = {  # (1)
    "scraperId": ...,
}

parent.delete_scraper(**kwargs)

1. See DeleteScraperRequestTypeDef

delete_workspace

Deletes an existing 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)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_workspace method usage example with argument unpacking

kwargs: DeleteWorkspaceRequestTypeDef = {  # (1)
    "workspaceId": ...,
}

parent.delete_workspace(**kwargs)

1. See DeleteWorkspaceRequestTypeDef

describe_alert_manager_definition

Retrieves the full information about the alert manager definition for a workspace.

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)
    ...

1. See DescribeAlertManagerDefinitionResponseTypeDef

# describe_alert_manager_definition method usage example with argument unpacking

kwargs: DescribeAlertManagerDefinitionRequestTypeDef = {  # (1)
    "workspaceId": ...,
}

parent.describe_alert_manager_definition(**kwargs)

1. See DescribeAlertManagerDefinitionRequestTypeDef

describe_logging_configuration

Returns complete information about the current logging configuration of the workspace.

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)
    ...

1. See DescribeLoggingConfigurationResponseTypeDef

# describe_logging_configuration method usage example with argument unpacking

kwargs: DescribeLoggingConfigurationRequestTypeDef = {  # (1)
    "workspaceId": ...,
}

parent.describe_logging_configuration(**kwargs)

1. See DescribeLoggingConfigurationRequestTypeDef

describe_rule_groups_namespace

Returns complete information about one 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,
    *,
    name: str,
    workspaceId: str,
) -> DescribeRuleGroupsNamespaceResponseTypeDef:  # (1)
    ...

1. See DescribeRuleGroupsNamespaceResponseTypeDef

# describe_rule_groups_namespace method usage example with argument unpacking

kwargs: DescribeRuleGroupsNamespaceRequestTypeDef = {  # (1)
    "name": ...,
    "workspaceId": ...,
}

parent.describe_rule_groups_namespace(**kwargs)

1. See DescribeRuleGroupsNamespaceRequestTypeDef

describe_scraper

The DescribeScraper operation displays information about 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)
    ...

1. See DescribeScraperResponseTypeDef

# describe_scraper method usage example with argument unpacking

kwargs: DescribeScraperRequestTypeDef = {  # (1)
    "scraperId": ...,
}

parent.describe_scraper(**kwargs)

1. See DescribeScraperRequestTypeDef

describe_workspace

Returns information about an existing 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)
    ...

1. See DescribeWorkspaceResponseTypeDef

# describe_workspace method usage example with argument unpacking

kwargs: DescribeWorkspaceRequestTypeDef = {  # (1)
    "workspaceId": ...,
}

parent.describe_workspace(**kwargs)

1. See DescribeWorkspaceRequestTypeDef

describe_workspace_configuration

Use this operation to return information about the configuration of a workspace.

Type annotations and code completion for boto3.client("amp").describe_workspace_configuration method. boto3 documentation

# describe_workspace_configuration method definition

def describe_workspace_configuration(
    self,
    *,
    workspaceId: str,
) -> DescribeWorkspaceConfigurationResponseTypeDef:  # (1)
    ...

1. See DescribeWorkspaceConfigurationResponseTypeDef

# describe_workspace_configuration method usage example with argument unpacking

kwargs: DescribeWorkspaceConfigurationRequestTypeDef = {  # (1)
    "workspaceId": ...,
}

parent.describe_workspace_configuration(**kwargs)

1. See DescribeWorkspaceConfigurationRequestTypeDef

get_default_scraper_configuration

The GetDefaultScraperConfiguration operation returns the default scraper configuration used when Amazon EKS creates a scraper for you.

Type annotations and code completion for boto3.client("amp").get_default_scraper_configuration method. boto3 documentation

# get_default_scraper_configuration method definition

def get_default_scraper_configuration(
    self,
) -> GetDefaultScraperConfigurationResponseTypeDef:  # (1)
    ...

1. See GetDefaultScraperConfigurationResponseTypeDef

list_rule_groups_namespaces

Returns a list of rule groups namespaces in a workspace.

Type annotations and code completion for boto3.client("amp").list_rule_groups_namespaces method. boto3 documentation

# list_rule_groups_namespaces method definition

def list_rule_groups_namespaces(
    self,
    *,
    workspaceId: str,
    maxResults: int = ...,
    name: str = ...,
    nextToken: str = ...,
) -> ListRuleGroupsNamespacesResponseTypeDef:  # (1)
    ...

1. See ListRuleGroupsNamespacesResponseTypeDef

# list_rule_groups_namespaces method usage example with argument unpacking

kwargs: ListRuleGroupsNamespacesRequestTypeDef = {  # (1)
    "workspaceId": ...,
}

parent.list_rule_groups_namespaces(**kwargs)

1. See ListRuleGroupsNamespacesRequestTypeDef

list_scrapers

The ListScrapers operation lists all of the scrapers in your account.

Type annotations and code completion for boto3.client("amp").list_scrapers method. boto3 documentation

# list_scrapers method definition

def list_scrapers(
    self,
    *,
    filters: Mapping[str, Sequence[str]] = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListScrapersResponseTypeDef:  # (1)
    ...

1. See ListScrapersResponseTypeDef

# list_scrapers method usage example with argument unpacking

kwargs: ListScrapersRequestTypeDef = {  # (1)
    "filters": ...,
}

parent.list_scrapers(**kwargs)

1. See ListScrapersRequestTypeDef

list_tags_for_resource

The ListTagsForResource operation returns the tags that are associated with an Amazon Managed Service for Prometheus resource.

Type annotations and code completion for boto3.client("amp").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

list_workspaces

Lists all of the Amazon Managed Service for Prometheus workspaces in your account.

Type annotations and code completion for boto3.client("amp").list_workspaces method. boto3 documentation

# list_workspaces method definition

def list_workspaces(
    self,
    *,
    alias: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListWorkspacesResponseTypeDef:  # (1)
    ...

1. See ListWorkspacesResponseTypeDef

# list_workspaces method usage example with argument unpacking

kwargs: ListWorkspacesRequestTypeDef = {  # (1)
    "alias": ...,
}

parent.list_workspaces(**kwargs)

1. See ListWorkspacesRequestTypeDef

put_alert_manager_definition

Updates an existing alert manager definition in a workspace.

Type annotations and code completion for boto3.client("amp").put_alert_manager_definition method. boto3 documentation

# put_alert_manager_definition method definition

def put_alert_manager_definition(
    self,
    *,
    data: BlobTypeDef,
    workspaceId: str,
    clientToken: str = ...,
) -> PutAlertManagerDefinitionResponseTypeDef:  # (1)
    ...

1. See PutAlertManagerDefinitionResponseTypeDef

# put_alert_manager_definition method usage example with argument unpacking

kwargs: PutAlertManagerDefinitionRequestTypeDef = {  # (1)
    "data": ...,
    "workspaceId": ...,
}

parent.put_alert_manager_definition(**kwargs)

1. See PutAlertManagerDefinitionRequestTypeDef

put_rule_groups_namespace

Updates an existing rule groups namespace within a workspace.

Type annotations and code completion for boto3.client("amp").put_rule_groups_namespace method. boto3 documentation

# put_rule_groups_namespace method definition

def put_rule_groups_namespace(
    self,
    *,
    data: BlobTypeDef,
    name: str,
    workspaceId: str,
    clientToken: str = ...,
) -> PutRuleGroupsNamespaceResponseTypeDef:  # (1)
    ...

1. See PutRuleGroupsNamespaceResponseTypeDef

# put_rule_groups_namespace method usage example with argument unpacking

kwargs: PutRuleGroupsNamespaceRequestTypeDef = {  # (1)
    "data": ...,
    "name": ...,
    "workspaceId": ...,
}

parent.put_rule_groups_namespace(**kwargs)

1. See PutRuleGroupsNamespaceRequestTypeDef

tag_resource

The TagResource operation associates tags with an Amazon Managed Service for Prometheus resource.

Type annotations and code completion for boto3.client("amp").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

untag_resource

Removes the specified tags from an Amazon Managed Service for Prometheus resource.

Type annotations and code completion for boto3.client("amp").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_logging_configuration

Updates the log group ARN or the workspace ID of the current logging configuration.

Type annotations and code completion for boto3.client("amp").update_logging_configuration method. boto3 documentation

# update_logging_configuration method definition

def update_logging_configuration(
    self,
    *,
    logGroupArn: str,
    workspaceId: str,
    clientToken: str = ...,
) -> UpdateLoggingConfigurationResponseTypeDef:  # (1)
    ...

1. See UpdateLoggingConfigurationResponseTypeDef

# update_logging_configuration method usage example with argument unpacking

kwargs: UpdateLoggingConfigurationRequestTypeDef = {  # (1)
    "logGroupArn": ...,
    "workspaceId": ...,
}

parent.update_logging_configuration(**kwargs)

1. See UpdateLoggingConfigurationRequestTypeDef

update_scraper

Updates an existing scraper.

Type annotations and code completion for boto3.client("amp").update_scraper method. boto3 documentation

# update_scraper method definition

def update_scraper(
    self,
    *,
    scraperId: str,
    alias: str = ...,
    clientToken: str = ...,
    destination: DestinationTypeDef = ...,  # (1)
    roleConfiguration: RoleConfigurationTypeDef = ...,  # (2)
    scrapeConfiguration: ScrapeConfigurationUnionTypeDef = ...,  # (3)
) -> UpdateScraperResponseTypeDef:  # (4)
    ...

1. See DestinationTypeDef
2. See RoleConfigurationTypeDef
3. See ScrapeConfigurationUnionTypeDef
4. See UpdateScraperResponseTypeDef

# update_scraper method usage example with argument unpacking

kwargs: UpdateScraperRequestTypeDef = {  # (1)
    "scraperId": ...,
}

parent.update_scraper(**kwargs)

1. See UpdateScraperRequestTypeDef

update_workspace_alias

Updates the alias of an existing workspace.

Type annotations and code completion for boto3.client("amp").update_workspace_alias method. boto3 documentation

# update_workspace_alias method definition

def update_workspace_alias(
    self,
    *,
    workspaceId: str,
    alias: str = ...,
    clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# update_workspace_alias method usage example with argument unpacking

kwargs: UpdateWorkspaceAliasRequestTypeDef = {  # (1)
    "workspaceId": ...,
}

parent.update_workspace_alias(**kwargs)

1. See UpdateWorkspaceAliasRequestTypeDef

update_workspace_configuration

Use this operation to create or update the label sets, label set limits, and retention period of a workspace.

Type annotations and code completion for boto3.client("amp").update_workspace_configuration method. boto3 documentation

# update_workspace_configuration method definition

def update_workspace_configuration(
    self,
    *,
    workspaceId: str,
    clientToken: str = ...,
    limitsPerLabelSet: Sequence[LimitsPerLabelSetUnionTypeDef] = ...,  # (1)
    retentionPeriodInDays: int = ...,
) -> UpdateWorkspaceConfigurationResponseTypeDef:  # (2)
    ...

1. See Sequence[LimitsPerLabelSetUnionTypeDef]
2. See UpdateWorkspaceConfigurationResponseTypeDef

# update_workspace_configuration method usage example with argument unpacking

kwargs: UpdateWorkspaceConfigurationRequestTypeDef = {  # (1)
    "workspaceId": ...,
}

parent.update_workspace_configuration(**kwargs)

1. See UpdateWorkspaceConfigurationRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("amp").get_paginator method with overloads.

• client.get_paginator("list_rule_groups_namespaces") -> ListRuleGroupsNamespacesPaginator
• client.get_paginator("list_scrapers") -> ListScrapersPaginator
• client.get_paginator("list_workspaces") -> ListWorkspacesPaginator

get_waiter

Type annotations and code completion for boto3.client("amp").get_waiter method with overloads.

• client.get_waiter("scraper_active") -> ScraperActiveWaiter
• client.get_waiter("scraper_deleted") -> ScraperDeletedWaiter
• client.get_waiter("workspace_active") -> WorkspaceActiveWaiter
• client.get_waiter("workspace_deleted") -> WorkspaceDeletedWaiter