CloudWatchObservabilityAdminServiceClient

Index > CloudWatchObservabilityAdminService > CloudWatchObservabilityAdminServiceClient

Auto-generated documentation for CloudWatchObservabilityAdminService type annotations stubs module mypy-boto3-observabilityadmin.

CloudWatchObservabilityAdminServiceClient

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

# CloudWatchObservabilityAdminServiceClient usage example

from boto3.session import Session
from mypy_boto3_observabilityadmin.client import CloudWatchObservabilityAdminServiceClient

def get_observabilityadmin_client() -> CloudWatchObservabilityAdminServiceClient:
    return Session().client("observabilityadmin")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("observabilityadmin").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("observabilityadmin")

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.TooManyRequestsException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_observabilityadmin.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("observabilityadmin").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("observabilityadmin").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_centralization_rule_for_organization

Creates a centralization rule that applies across an Amazon Web Services Organization.

Type annotations and code completion for boto3.client("observabilityadmin").create_centralization_rule_for_organization method. boto3 documentation

# create_centralization_rule_for_organization method definition

def create_centralization_rule_for_organization(
    self,
    *,
    RuleName: str,
    Rule: CentralizationRuleUnionTypeDef,  # (1)
    Tags: Mapping[str, str] = ...,
) -> CreateCentralizationRuleForOrganizationOutputTypeDef:  # (2)
    ...

1. See CentralizationRuleUnionTypeDef
2. See CreateCentralizationRuleForOrganizationOutputTypeDef

# create_centralization_rule_for_organization method usage example with argument unpacking

kwargs: CreateCentralizationRuleForOrganizationInputTypeDef = {  # (1)
    "RuleName": ...,
    "Rule": ...,
}

parent.create_centralization_rule_for_organization(**kwargs)

1. See CreateCentralizationRuleForOrganizationInputTypeDef

create_telemetry_rule

Creates a telemetry rule that defines how telemetry should be configured for Amazon Web Services resources in your account.

Type annotations and code completion for boto3.client("observabilityadmin").create_telemetry_rule method. boto3 documentation

# create_telemetry_rule method definition

def create_telemetry_rule(
    self,
    *,
    RuleName: str,
    Rule: TelemetryRuleTypeDef,  # (1)
    Tags: Mapping[str, str] = ...,
) -> CreateTelemetryRuleOutputTypeDef:  # (2)
    ...

1. See TelemetryRuleTypeDef
2. See CreateTelemetryRuleOutputTypeDef

# create_telemetry_rule method usage example with argument unpacking

kwargs: CreateTelemetryRuleInputTypeDef = {  # (1)
    "RuleName": ...,
    "Rule": ...,
}

parent.create_telemetry_rule(**kwargs)

1. See CreateTelemetryRuleInputTypeDef

create_telemetry_rule_for_organization

Creates a telemetry rule that applies across an Amazon Web Services Organization.

Type annotations and code completion for boto3.client("observabilityadmin").create_telemetry_rule_for_organization method. boto3 documentation

# create_telemetry_rule_for_organization method definition

def create_telemetry_rule_for_organization(
    self,
    *,
    RuleName: str,
    Rule: TelemetryRuleTypeDef,  # (1)
    Tags: Mapping[str, str] = ...,
) -> CreateTelemetryRuleForOrganizationOutputTypeDef:  # (2)
    ...

1. See TelemetryRuleTypeDef
2. See CreateTelemetryRuleForOrganizationOutputTypeDef

# create_telemetry_rule_for_organization method usage example with argument unpacking

kwargs: CreateTelemetryRuleForOrganizationInputTypeDef = {  # (1)
    "RuleName": ...,
    "Rule": ...,
}

parent.create_telemetry_rule_for_organization(**kwargs)

1. See CreateTelemetryRuleForOrganizationInputTypeDef

delete_centralization_rule_for_organization

Deletes an organization-wide centralization rule.

Type annotations and code completion for boto3.client("observabilityadmin").delete_centralization_rule_for_organization method. boto3 documentation

# delete_centralization_rule_for_organization method definition

def delete_centralization_rule_for_organization(
    self,
    *,
    RuleIdentifier: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_centralization_rule_for_organization method usage example with argument unpacking

kwargs: DeleteCentralizationRuleForOrganizationInputTypeDef = {  # (1)
    "RuleIdentifier": ...,
}

parent.delete_centralization_rule_for_organization(**kwargs)

1. See DeleteCentralizationRuleForOrganizationInputTypeDef

delete_telemetry_rule

Deletes a telemetry rule from your account.

Type annotations and code completion for boto3.client("observabilityadmin").delete_telemetry_rule method. boto3 documentation

# delete_telemetry_rule method definition

def delete_telemetry_rule(
    self,
    *,
    RuleIdentifier: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_telemetry_rule method usage example with argument unpacking

kwargs: DeleteTelemetryRuleInputTypeDef = {  # (1)
    "RuleIdentifier": ...,
}

parent.delete_telemetry_rule(**kwargs)

1. See DeleteTelemetryRuleInputTypeDef

delete_telemetry_rule_for_organization

Deletes an organization-wide telemetry rule.

Type annotations and code completion for boto3.client("observabilityadmin").delete_telemetry_rule_for_organization method. boto3 documentation

# delete_telemetry_rule_for_organization method definition

def delete_telemetry_rule_for_organization(
    self,
    *,
    RuleIdentifier: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_telemetry_rule_for_organization method usage example with argument unpacking

kwargs: DeleteTelemetryRuleForOrganizationInputTypeDef = {  # (1)
    "RuleIdentifier": ...,
}

parent.delete_telemetry_rule_for_organization(**kwargs)

1. See DeleteTelemetryRuleForOrganizationInputTypeDef

get_centralization_rule_for_organization

Retrieves the details of a specific organization centralization rule.

Type annotations and code completion for boto3.client("observabilityadmin").get_centralization_rule_for_organization method. boto3 documentation

# get_centralization_rule_for_organization method definition

def get_centralization_rule_for_organization(
    self,
    *,
    RuleIdentifier: str,
) -> GetCentralizationRuleForOrganizationOutputTypeDef:  # (1)
    ...

1. See GetCentralizationRuleForOrganizationOutputTypeDef

# get_centralization_rule_for_organization method usage example with argument unpacking

kwargs: GetCentralizationRuleForOrganizationInputTypeDef = {  # (1)
    "RuleIdentifier": ...,
}

parent.get_centralization_rule_for_organization(**kwargs)

1. See GetCentralizationRuleForOrganizationInputTypeDef

get_telemetry_enrichment_status

Returns the current status of the resource tags for telemetry feature, which enhances telemetry data with additional resource metadata from Amazon Web Services Resource Explorer.

Type annotations and code completion for boto3.client("observabilityadmin").get_telemetry_enrichment_status method. boto3 documentation

# get_telemetry_enrichment_status method definition

def get_telemetry_enrichment_status(
    self,
) -> GetTelemetryEnrichmentStatusOutputTypeDef:  # (1)
    ...

1. See GetTelemetryEnrichmentStatusOutputTypeDef

get_telemetry_evaluation_status

Returns the current onboarding status of the telemetry config feature, including the status of the feature and reason the feature failed to start or stop.

Type annotations and code completion for boto3.client("observabilityadmin").get_telemetry_evaluation_status method. boto3 documentation

# get_telemetry_evaluation_status method definition

def get_telemetry_evaluation_status(
    self,
) -> GetTelemetryEvaluationStatusOutputTypeDef:  # (1)
    ...

1. See GetTelemetryEvaluationStatusOutputTypeDef

get_telemetry_evaluation_status_for_organization

This returns the onboarding status of the telemetry configuration feature for the organization.

Type annotations and code completion for boto3.client("observabilityadmin").get_telemetry_evaluation_status_for_organization method. boto3 documentation

# get_telemetry_evaluation_status_for_organization method definition

def get_telemetry_evaluation_status_for_organization(
    self,
) -> GetTelemetryEvaluationStatusForOrganizationOutputTypeDef:  # (1)
    ...

1. See GetTelemetryEvaluationStatusForOrganizationOutputTypeDef

get_telemetry_rule

Retrieves the details of a specific telemetry rule in your account.

Type annotations and code completion for boto3.client("observabilityadmin").get_telemetry_rule method. boto3 documentation

# get_telemetry_rule method definition

def get_telemetry_rule(
    self,
    *,
    RuleIdentifier: str,
) -> GetTelemetryRuleOutputTypeDef:  # (1)
    ...

1. See GetTelemetryRuleOutputTypeDef

# get_telemetry_rule method usage example with argument unpacking

kwargs: GetTelemetryRuleInputTypeDef = {  # (1)
    "RuleIdentifier": ...,
}

parent.get_telemetry_rule(**kwargs)

1. See GetTelemetryRuleInputTypeDef

get_telemetry_rule_for_organization

Retrieves the details of a specific organization telemetry rule.

Type annotations and code completion for boto3.client("observabilityadmin").get_telemetry_rule_for_organization method. boto3 documentation

# get_telemetry_rule_for_organization method definition

def get_telemetry_rule_for_organization(
    self,
    *,
    RuleIdentifier: str,
) -> GetTelemetryRuleForOrganizationOutputTypeDef:  # (1)
    ...

1. See GetTelemetryRuleForOrganizationOutputTypeDef

# get_telemetry_rule_for_organization method usage example with argument unpacking

kwargs: GetTelemetryRuleForOrganizationInputTypeDef = {  # (1)
    "RuleIdentifier": ...,
}

parent.get_telemetry_rule_for_organization(**kwargs)

1. See GetTelemetryRuleForOrganizationInputTypeDef

list_centralization_rules_for_organization

Lists all centralization rules in your organization.

Type annotations and code completion for boto3.client("observabilityadmin").list_centralization_rules_for_organization method. boto3 documentation

# list_centralization_rules_for_organization method definition

def list_centralization_rules_for_organization(
    self,
    *,
    RuleNamePrefix: str = ...,
    AllRegions: bool = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListCentralizationRulesForOrganizationOutputTypeDef:  # (1)
    ...

1. See ListCentralizationRulesForOrganizationOutputTypeDef

# list_centralization_rules_for_organization method usage example with argument unpacking

kwargs: ListCentralizationRulesForOrganizationInputTypeDef = {  # (1)
    "RuleNamePrefix": ...,
}

parent.list_centralization_rules_for_organization(**kwargs)

1. See ListCentralizationRulesForOrganizationInputTypeDef

list_resource_telemetry

Returns a list of telemetry configurations for Amazon Web Services resources supported by telemetry config.

Type annotations and code completion for boto3.client("observabilityadmin").list_resource_telemetry method. boto3 documentation

# list_resource_telemetry method definition

def list_resource_telemetry(
    self,
    *,
    ResourceIdentifierPrefix: str = ...,
    ResourceTypes: Sequence[ResourceTypeType] = ...,  # (1)
    TelemetryConfigurationState: Mapping[TelemetryTypeType, TelemetryStateType] = ...,  # (2)
    ResourceTags: Mapping[str, str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListResourceTelemetryOutputTypeDef:  # (3)
    ...

1. See Sequence[ResourceTypeType]
2. See Mapping[TelemetryTypeType, TelemetryStateType]
3. See ListResourceTelemetryOutputTypeDef

# list_resource_telemetry method usage example with argument unpacking

kwargs: ListResourceTelemetryInputTypeDef = {  # (1)
    "ResourceIdentifierPrefix": ...,
}

parent.list_resource_telemetry(**kwargs)

1. See ListResourceTelemetryInputTypeDef

list_resource_telemetry_for_organization

Returns a list of telemetry configurations for Amazon Web Services resources supported by telemetry config in the organization.

Type annotations and code completion for boto3.client("observabilityadmin").list_resource_telemetry_for_organization method. boto3 documentation

# list_resource_telemetry_for_organization method definition

def list_resource_telemetry_for_organization(
    self,
    *,
    AccountIdentifiers: Sequence[str] = ...,
    ResourceIdentifierPrefix: str = ...,
    ResourceTypes: Sequence[ResourceTypeType] = ...,  # (1)
    TelemetryConfigurationState: Mapping[TelemetryTypeType, TelemetryStateType] = ...,  # (2)
    ResourceTags: Mapping[str, str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListResourceTelemetryForOrganizationOutputTypeDef:  # (3)
    ...

1. See Sequence[ResourceTypeType]
2. See Mapping[TelemetryTypeType, TelemetryStateType]
3. See ListResourceTelemetryForOrganizationOutputTypeDef

# list_resource_telemetry_for_organization method usage example with argument unpacking

kwargs: ListResourceTelemetryForOrganizationInputTypeDef = {  # (1)
    "AccountIdentifiers": ...,
}

parent.list_resource_telemetry_for_organization(**kwargs)

1. See ListResourceTelemetryForOrganizationInputTypeDef

list_tags_for_resource

Lists all tags attached to the specified telemetry rule resource.

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceARN: str,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...

1. See ListTagsForResourceOutputTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceInputTypeDef = {  # (1)
    "ResourceARN": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceInputTypeDef

list_telemetry_rules

Lists all telemetry rules in your account.

Type annotations and code completion for boto3.client("observabilityadmin").list_telemetry_rules method. boto3 documentation

# list_telemetry_rules method definition

def list_telemetry_rules(
    self,
    *,
    RuleNamePrefix: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListTelemetryRulesOutputTypeDef:  # (1)
    ...

1. See ListTelemetryRulesOutputTypeDef

# list_telemetry_rules method usage example with argument unpacking

kwargs: ListTelemetryRulesInputTypeDef = {  # (1)
    "RuleNamePrefix": ...,
}

parent.list_telemetry_rules(**kwargs)

1. See ListTelemetryRulesInputTypeDef

list_telemetry_rules_for_organization

Lists all telemetry rules in your organization.

Type annotations and code completion for boto3.client("observabilityadmin").list_telemetry_rules_for_organization method. boto3 documentation

# list_telemetry_rules_for_organization method definition

def list_telemetry_rules_for_organization(
    self,
    *,
    RuleNamePrefix: str = ...,
    SourceAccountIds: Sequence[str] = ...,
    SourceOrganizationUnitIds: Sequence[str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListTelemetryRulesForOrganizationOutputTypeDef:  # (1)
    ...

1. See ListTelemetryRulesForOrganizationOutputTypeDef

# list_telemetry_rules_for_organization method usage example with argument unpacking

kwargs: ListTelemetryRulesForOrganizationInputTypeDef = {  # (1)
    "RuleNamePrefix": ...,
}

parent.list_telemetry_rules_for_organization(**kwargs)

1. See ListTelemetryRulesForOrganizationInputTypeDef

start_telemetry_enrichment

Enables the resource tags for telemetry feature for your account, which enhances telemetry data with additional resource metadata from Amazon Web Services Resource Explorer to provide richer context for monitoring and observability.

Type annotations and code completion for boto3.client("observabilityadmin").start_telemetry_enrichment method. boto3 documentation

# start_telemetry_enrichment method definition

def start_telemetry_enrichment(
    self,
) -> StartTelemetryEnrichmentOutputTypeDef:  # (1)
    ...

1. See StartTelemetryEnrichmentOutputTypeDef

start_telemetry_evaluation

This action begins onboarding the caller Amazon Web Services account to the telemetry config feature.

Type annotations and code completion for boto3.client("observabilityadmin").start_telemetry_evaluation method. boto3 documentation

# start_telemetry_evaluation method definition

def start_telemetry_evaluation(
    self,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

start_telemetry_evaluation_for_organization

This actions begins onboarding the organization and all member accounts to the telemetry config feature.

Type annotations and code completion for boto3.client("observabilityadmin").start_telemetry_evaluation_for_organization method. boto3 documentation

# start_telemetry_evaluation_for_organization method definition

def start_telemetry_evaluation_for_organization(
    self,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

stop_telemetry_enrichment

Disables the resource tags for telemetry feature for your account, stopping the enhancement of telemetry data with additional resource metadata.

Type annotations and code completion for boto3.client("observabilityadmin").stop_telemetry_enrichment method. boto3 documentation

# stop_telemetry_enrichment method definition

def stop_telemetry_enrichment(
    self,
) -> StopTelemetryEnrichmentOutputTypeDef:  # (1)
    ...

1. See StopTelemetryEnrichmentOutputTypeDef

stop_telemetry_evaluation

This action begins offboarding the caller Amazon Web Services account from the telemetry config feature.

Type annotations and code completion for boto3.client("observabilityadmin").stop_telemetry_evaluation method. boto3 documentation

# stop_telemetry_evaluation method definition

def stop_telemetry_evaluation(
    self,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

stop_telemetry_evaluation_for_organization

This action offboards the Organization of the caller Amazon Web Services account from the telemetry config feature.

Type annotations and code completion for boto3.client("observabilityadmin").stop_telemetry_evaluation_for_organization method. boto3 documentation

# stop_telemetry_evaluation_for_organization method definition

def stop_telemetry_evaluation_for_organization(
    self,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

tag_resource

Adds or updates tags for a telemetry rule resource.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceARN: str,
    Tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceInputTypeDef = {  # (1)
    "ResourceARN": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceInputTypeDef

untag_resource

Removes tags from a telemetry rule resource.

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceARN: str,
    TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceInputTypeDef = {  # (1)
    "ResourceARN": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceInputTypeDef

update_centralization_rule_for_organization

Updates an existing centralization rule that applies across an Amazon Web Services Organization.

Type annotations and code completion for boto3.client("observabilityadmin").update_centralization_rule_for_organization method. boto3 documentation

# update_centralization_rule_for_organization method definition

def update_centralization_rule_for_organization(
    self,
    *,
    RuleIdentifier: str,
    Rule: CentralizationRuleUnionTypeDef,  # (1)
) -> UpdateCentralizationRuleForOrganizationOutputTypeDef:  # (2)
    ...

1. See CentralizationRuleUnionTypeDef
2. See UpdateCentralizationRuleForOrganizationOutputTypeDef

# update_centralization_rule_for_organization method usage example with argument unpacking

kwargs: UpdateCentralizationRuleForOrganizationInputTypeDef = {  # (1)
    "RuleIdentifier": ...,
    "Rule": ...,
}

parent.update_centralization_rule_for_organization(**kwargs)

1. See UpdateCentralizationRuleForOrganizationInputTypeDef

update_telemetry_rule

Updates an existing telemetry rule in your account.

Type annotations and code completion for boto3.client("observabilityadmin").update_telemetry_rule method. boto3 documentation

# update_telemetry_rule method definition

def update_telemetry_rule(
    self,
    *,
    RuleIdentifier: str,
    Rule: TelemetryRuleTypeDef,  # (1)
) -> UpdateTelemetryRuleOutputTypeDef:  # (2)
    ...

1. See TelemetryRuleTypeDef
2. See UpdateTelemetryRuleOutputTypeDef

# update_telemetry_rule method usage example with argument unpacking

kwargs: UpdateTelemetryRuleInputTypeDef = {  # (1)
    "RuleIdentifier": ...,
    "Rule": ...,
}

parent.update_telemetry_rule(**kwargs)

1. See UpdateTelemetryRuleInputTypeDef

update_telemetry_rule_for_organization

Updates an existing telemetry rule that applies across an Amazon Web Services Organization.

Type annotations and code completion for boto3.client("observabilityadmin").update_telemetry_rule_for_organization method. boto3 documentation

# update_telemetry_rule_for_organization method definition

def update_telemetry_rule_for_organization(
    self,
    *,
    RuleIdentifier: str,
    Rule: TelemetryRuleTypeDef,  # (1)
) -> UpdateTelemetryRuleForOrganizationOutputTypeDef:  # (2)
    ...

1. See TelemetryRuleTypeDef
2. See UpdateTelemetryRuleForOrganizationOutputTypeDef

# update_telemetry_rule_for_organization method usage example with argument unpacking

kwargs: UpdateTelemetryRuleForOrganizationInputTypeDef = {  # (1)
    "RuleIdentifier": ...,
    "Rule": ...,
}

parent.update_telemetry_rule_for_organization(**kwargs)

1. See UpdateTelemetryRuleForOrganizationInputTypeDef

get_paginator

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

• client.get_paginator("list_centralization_rules_for_organization") -> ListCentralizationRulesForOrganizationPaginator
• client.get_paginator("list_resource_telemetry_for_organization") -> ListResourceTelemetryForOrganizationPaginator
• client.get_paginator("list_resource_telemetry") -> ListResourceTelemetryPaginator
• client.get_paginator("list_telemetry_rules_for_organization") -> ListTelemetryRulesForOrganizationPaginator
• client.get_paginator("list_telemetry_rules") -> ListTelemetryRulesPaginator