CloudWatchObservabilityAdminServiceClient#
Index > CloudWatchObservabilityAdminService > CloudWatchObservabilityAdminServiceClient
Auto-generated documentation for CloudWatchObservabilityAdminService type annotations stubs module types-boto3-observabilityadmin.
CloudWatchObservabilityAdminServiceClient#
Type annotations and code completion for boto3.client("observabilityadmin")
.
boto3 documentation
# CloudWatchObservabilityAdminServiceClient usage example
from boto3.session import Session
from types_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 types_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_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)
...
# create_telemetry_rule method usage example with argument unpacking
kwargs: CreateTelemetryRuleInputTypeDef = { # (1)
"RuleName": ...,
"Rule": ...,
}
parent.create_telemetry_rule(**kwargs)
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)
...
# create_telemetry_rule_for_organization method usage example with argument unpacking
kwargs: CreateTelemetryRuleForOrganizationInputTypeDef = { # (1)
"RuleName": ...,
"Rule": ...,
}
parent.create_telemetry_rule_for_organization(**kwargs)
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)
...
# delete_telemetry_rule method usage example with argument unpacking
kwargs: DeleteTelemetryRuleInputTypeDef = { # (1)
"RuleIdentifier": ...,
}
parent.delete_telemetry_rule(**kwargs)
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)
...
# delete_telemetry_rule_for_organization method usage example with argument unpacking
kwargs: DeleteTelemetryRuleForOrganizationInputTypeDef = { # (1)
"RuleIdentifier": ...,
}
parent.delete_telemetry_rule_for_organization(**kwargs)
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)
...
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)
...
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)
...
# get_telemetry_rule method usage example with argument unpacking
kwargs: GetTelemetryRuleInputTypeDef = { # (1)
"RuleIdentifier": ...,
}
parent.get_telemetry_rule(**kwargs)
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)
...
# get_telemetry_rule_for_organization method usage example with argument unpacking
kwargs: GetTelemetryRuleForOrganizationInputTypeDef = { # (1)
"RuleIdentifier": ...,
}
parent.get_telemetry_rule_for_organization(**kwargs)
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)
...
- See
Sequence[ResourceTypeType]
- See
Mapping[TelemetryTypeType, TelemetryStateType]
- See ListResourceTelemetryOutputTypeDef
# list_resource_telemetry method usage example with argument unpacking
kwargs: ListResourceTelemetryInputTypeDef = { # (1)
"ResourceIdentifierPrefix": ...,
}
parent.list_resource_telemetry(**kwargs)
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)
...
- See
Sequence[ResourceTypeType]
- See
Mapping[TelemetryTypeType, TelemetryStateType]
- See ListResourceTelemetryForOrganizationOutputTypeDef
# list_resource_telemetry_for_organization method usage example with argument unpacking
kwargs: ListResourceTelemetryForOrganizationInputTypeDef = { # (1)
"AccountIdentifiers": ...,
}
parent.list_resource_telemetry_for_organization(**kwargs)
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)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceInputTypeDef = { # (1)
"ResourceARN": ...,
}
parent.list_tags_for_resource(**kwargs)
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)
...
# list_telemetry_rules method usage example with argument unpacking
kwargs: ListTelemetryRulesInputTypeDef = { # (1)
"RuleNamePrefix": ...,
}
parent.list_telemetry_rules(**kwargs)
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)
...
# list_telemetry_rules_for_organization method usage example with argument unpacking
kwargs: ListTelemetryRulesForOrganizationInputTypeDef = { # (1)
"RuleNamePrefix": ...,
}
parent.list_telemetry_rules_for_organization(**kwargs)
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)
...
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)
...
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)
...
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)
...
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)
...
# tag_resource method usage example with argument unpacking
kwargs: TagResourceInputTypeDef = { # (1)
"ResourceARN": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
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)
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceInputTypeDef = { # (1)
"ResourceARN": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
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)
...
# update_telemetry_rule method usage example with argument unpacking
kwargs: UpdateTelemetryRuleInputTypeDef = { # (1)
"RuleIdentifier": ...,
"Rule": ...,
}
parent.update_telemetry_rule(**kwargs)
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)
...
# update_telemetry_rule_for_organization method usage example with argument unpacking
kwargs: UpdateTelemetryRuleForOrganizationInputTypeDef = { # (1)
"RuleIdentifier": ...,
"Rule": ...,
}
parent.update_telemetry_rule_for_organization(**kwargs)
get_paginator#
Type annotations and code completion for boto3.client("observabilityadmin").get_paginator
method with overloads.
client.get_paginator("list_resource_telemetry_for_organization")
-> ListResourceTelemetryForOrganizationPaginatorclient.get_paginator("list_resource_telemetry")
-> ListResourceTelemetryPaginatorclient.get_paginator("list_telemetry_rules_for_organization")
-> ListTelemetryRulesForOrganizationPaginatorclient.get_paginator("list_telemetry_rules")
-> ListTelemetryRulesPaginator