PrometheusServiceClient

Index > PrometheusService > PrometheusServiceClient

Auto-generated documentation for PrometheusService type annotations stubs module types-aiobotocore-amp.

PrometheusServiceClient

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

Usage example

from aioboto3.session import Session
from types_aiobotocore_amp.client import PrometheusServiceClient

session = Session()
async with session.client("amp") as client:
    client: PrometheusServiceClient

Exceptions

aioboto3 client exceptions are generated in runtime. This class provides code completion for session.client("amp").exceptions structure.

Usage example

async with session.client("amp") as client:
    try:
        do_something(client)
    except (
            client.AccessDeniedException,
        client.ClientError,
        client.ConflictException,
        client.InternalServerException,
        client.ResourceNotFoundException,
        client.ServiceQuotaExceededException,
        client.ThrottlingException,
        client.ValidationException,
    ) as e:
        print(e)

Type checking example

from types_aiobotocore_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 session.client("amp").can_paginate method. boto3 documentation

Method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

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

Method definition

await def close(
    self,
) -> None:
    ...

create_alert_manager_definition

Create an alert manager definition.

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

Method definition

await def create_alert_manager_definition(
    self,
    *,
    data: Union[str, bytes, IO[Any], StreamingBody],
    workspaceId: str,
    clientToken: str = ...,
) -> CreateAlertManagerDefinitionResponseTypeDef:  # (1)
    ...

See CreateAlertManagerDefinitionResponseTypeDef

Usage example with kwargs

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

parent.create_alert_manager_definition(**kwargs)

See CreateAlertManagerDefinitionRequestRequestTypeDef

create_logging_configuration

Create logging configuration.

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

Method definition

await def create_logging_configuration(
    self,
    *,
    logGroupArn: str,
    workspaceId: str,
    clientToken: str = ...,
) -> CreateLoggingConfigurationResponseTypeDef:  # (1)
    ...

See CreateLoggingConfigurationResponseTypeDef

Usage example with kwargs

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

parent.create_logging_configuration(**kwargs)

See CreateLoggingConfigurationRequestRequestTypeDef

create_rule_groups_namespace

Create a rule group namespace.

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

Method definition

await def create_rule_groups_namespace(
    self,
    *,
    data: Union[str, bytes, IO[Any], StreamingBody],
    name: str,
    workspaceId: str,
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateRuleGroupsNamespaceResponseTypeDef:  # (1)
    ...

See CreateRuleGroupsNamespaceResponseTypeDef

Usage example with kwargs

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

parent.create_rule_groups_namespace(**kwargs)

See CreateRuleGroupsNamespaceRequestRequestTypeDef

create_workspace

Creates a new AMP workspace.

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

Method definition

await def create_workspace(
    self,
    *,
    alias: str = ...,
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateWorkspaceResponseTypeDef:  # (1)
    ...

See CreateWorkspaceResponseTypeDef

Usage example with kwargs

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

parent.create_workspace(**kwargs)

See CreateWorkspaceRequestRequestTypeDef

delete_alert_manager_definition

Deletes an alert manager definition.

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

Method definition

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

See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_alert_manager_definition(**kwargs)

See DeleteAlertManagerDefinitionRequestRequestTypeDef

delete_logging_configuration

Delete logging configuration.

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

Method definition

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

See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_logging_configuration(**kwargs)

See DeleteLoggingConfigurationRequestRequestTypeDef

delete_rule_groups_namespace

Delete a rule groups namespace.

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

Method definition

await def delete_rule_groups_namespace(
    self,
    *,
    name: str,
    workspaceId: str,
    clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_rule_groups_namespace(**kwargs)

See DeleteRuleGroupsNamespaceRequestRequestTypeDef

delete_workspace

Deletes an AMP workspace.

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

Method definition

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

See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_workspace(**kwargs)

See DeleteWorkspaceRequestRequestTypeDef

describe_alert_manager_definition

Describes an alert manager definition.

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

Method definition

await def describe_alert_manager_definition(
    self,
    *,
    workspaceId: str,
) -> DescribeAlertManagerDefinitionResponseTypeDef:  # (1)
    ...

See DescribeAlertManagerDefinitionResponseTypeDef

Usage example with kwargs

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

parent.describe_alert_manager_definition(**kwargs)

See DescribeAlertManagerDefinitionRequestRequestTypeDef

describe_logging_configuration

Describes logging configuration.

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

Method definition

await def describe_logging_configuration(
    self,
    *,
    workspaceId: str,
) -> DescribeLoggingConfigurationResponseTypeDef:  # (1)
    ...

See DescribeLoggingConfigurationResponseTypeDef

Usage example with kwargs

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

parent.describe_logging_configuration(**kwargs)

See DescribeLoggingConfigurationRequestRequestTypeDef

describe_rule_groups_namespace

Describe a rule groups namespace.

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

Method definition

await def describe_rule_groups_namespace(
    self,
    *,
    name: str,
    workspaceId: str,
) -> DescribeRuleGroupsNamespaceResponseTypeDef:  # (1)
    ...

See DescribeRuleGroupsNamespaceResponseTypeDef

Usage example with kwargs

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

parent.describe_rule_groups_namespace(**kwargs)

See DescribeRuleGroupsNamespaceRequestRequestTypeDef

describe_workspace

Describes an existing AMP workspace.

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

Method definition

await def describe_workspace(
    self,
    *,
    workspaceId: str,
) -> DescribeWorkspaceResponseTypeDef:  # (1)
    ...

See DescribeWorkspaceResponseTypeDef

Usage example with kwargs

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

parent.describe_workspace(**kwargs)

See DescribeWorkspaceRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

Method definition

await def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

list_rule_groups_namespaces

Lists rule groups namespaces.

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

Method definition

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

See ListRuleGroupsNamespacesResponseTypeDef

Usage example with kwargs

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

parent.list_rule_groups_namespaces(**kwargs)

See ListRuleGroupsNamespacesRequestRequestTypeDef

list_tags_for_resource

Lists the tags you have assigned to the resource.

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

Method definition

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

See ListTagsForResourceResponseTypeDef

Usage example with kwargs

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

parent.list_tags_for_resource(**kwargs)

See ListTagsForResourceRequestRequestTypeDef

list_workspaces

Lists all AMP workspaces, including workspaces being created or deleted.

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

Method definition

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

See ListWorkspacesResponseTypeDef

Usage example with kwargs

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

parent.list_workspaces(**kwargs)

See ListWorkspacesRequestRequestTypeDef

put_alert_manager_definition

Update an alert manager definition.

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

Method definition

await def put_alert_manager_definition(
    self,
    *,
    data: Union[str, bytes, IO[Any], StreamingBody],
    workspaceId: str,
    clientToken: str = ...,
) -> PutAlertManagerDefinitionResponseTypeDef:  # (1)
    ...

See PutAlertManagerDefinitionResponseTypeDef

Usage example with kwargs

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

parent.put_alert_manager_definition(**kwargs)

See PutAlertManagerDefinitionRequestRequestTypeDef

put_rule_groups_namespace

Update a rule groups namespace.

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

Method definition

await def put_rule_groups_namespace(
    self,
    *,
    data: Union[str, bytes, IO[Any], StreamingBody],
    name: str,
    workspaceId: str,
    clientToken: str = ...,
) -> PutRuleGroupsNamespaceResponseTypeDef:  # (1)
    ...

See PutRuleGroupsNamespaceResponseTypeDef

Usage example with kwargs

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

parent.put_rule_groups_namespace(**kwargs)

See PutRuleGroupsNamespaceRequestRequestTypeDef

tag_resource

Creates tags for the specified resource.

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

Method definition

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

Usage example with kwargs

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

parent.tag_resource(**kwargs)

See TagResourceRequestRequestTypeDef

untag_resource

Deletes tags from the specified resource.

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

Method definition

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

Usage example with kwargs

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

parent.untag_resource(**kwargs)

See UntagResourceRequestRequestTypeDef

update_logging_configuration

Update logging configuration.

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

Method definition

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

See UpdateLoggingConfigurationResponseTypeDef

Usage example with kwargs

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

parent.update_logging_configuration(**kwargs)

See UpdateLoggingConfigurationRequestRequestTypeDef

update_workspace_alias

Updates an AMP workspace alias.

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

Method definition

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

See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.update_workspace_alias(**kwargs)

See UpdateWorkspaceAliasRequestRequestTypeDef

aenter

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

Method definition

await def __aenter__(
    self,
) -> PrometheusServiceClient:
    ...

aexit

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

Method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...

get_paginator

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

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

get_waiter

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

client.get_waiter("workspace_active") -> WorkspaceActiveWaiter
client.get_waiter("workspace_deleted") -> WorkspaceDeletedWaiter