Skip to content

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

close#

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

# close method definition

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

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

list_resource_telemetry#

Returns a list of telemetry configurations for AWS 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 ResourceTypeType
  2. See TelemetryTypeType TelemetryStateType
  3. See ListResourceTelemetryOutputTypeDef 
# list_resource_telemetry method usage example with argument unpacking

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

parent.list_resource_telemetry(**kwargs)
  1. See ListResourceTelemetryInputRequestTypeDef

list_resource_telemetry_for_organization#

Returns a list of telemetry configurations for AWS 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 ResourceTypeType
  2. See TelemetryTypeType TelemetryStateType
  3. See ListResourceTelemetryForOrganizationOutputTypeDef 
# list_resource_telemetry_for_organization method usage example with argument unpacking

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

parent.list_resource_telemetry_for_organization(**kwargs)
  1. See ListResourceTelemetryForOrganizationInputRequestTypeDef

start_telemetry_evaluation#

This action begins onboarding onboarding the caller AWS 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_evaluation#

This action begins offboarding the caller AWS 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 AWS account from thef 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

get_paginator#

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