CloudWatchObservabilityAdminService module#
Index > CloudWatchObservabilityAdminService
Auto-generated documentation for CloudWatchObservabilityAdminService type annotations stubs module mypy-boto3-observabilityadmin.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.40.33' mypy-boto3-builder
- Select
boto3-stubs
AWS SDK. - Add
CloudWatchObservabilityAdminService
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and CloudWatchObservabilityAdminService
.
From PyPI with pip#
Install boto3-stubs
for CloudWatchObservabilityAdminService
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[observabilityadmin]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[observabilityadmin]'
# standalone installation
python -m pip install mypy-boto3-observabilityadmin
How to uninstall#
python -m pip uninstall -y mypy-boto3-observabilityadmin
Usage#
Code samples can be found in Examples.
CloudWatchObservabilityAdminServiceClient#
Type annotations and code completion for boto3.client("observabilityadmin")
as CloudWatchObservabilityAdminServiceClient
boto3 documentation
# CloudWatchObservabilityAdminServiceClient usage example
from boto3.session import Session
from mypy_boto3_observabilityadmin.client import CloudWatchObservabilityAdminServiceClient
def get_client() -> CloudWatchObservabilityAdminServiceClient:
return Session().client("observabilityadmin")
Paginators#
Type annotations and code completion for paginators
from boto3.client("observabilityadmin").get_paginator("...")
.
# ListCentralizationRulesForOrganizationPaginator usage example
from boto3.session import Session
from mypy_boto3_observabilityadmin.paginator import ListCentralizationRulesForOrganizationPaginator
def get_list_centralization_rules_for_organization_paginator() -> ListCentralizationRulesForOrganizationPaginator:
return Session().client("observabilityadmin").get_paginator("list_centralization_rules_for_organization"))
- ListCentralizationRulesForOrganizationPaginator
- ListResourceTelemetryForOrganizationPaginator
- ListResourceTelemetryPaginator
- ListTelemetryRulesForOrganizationPaginator
- ListTelemetryRulesPaginator
Literals#
Type annotations for literals used in methods and schema.
# CentralizationFailureReasonType usage example
from mypy_boto3_observabilityadmin.literals import CentralizationFailureReasonType
def get_value() -> CentralizationFailureReasonType:
return "DESTINATION_ACCOUNT_NOT_IN_ORGANIZATION"
- CentralizationFailureReasonType
- DestinationTypeType
- EncryptedLogGroupStrategyType
- EncryptionConflictResolutionStrategyType
- EncryptionStrategyType
- ListCentralizationRulesForOrganizationPaginatorName
- ListResourceTelemetryForOrganizationPaginatorName
- ListResourceTelemetryPaginatorName
- ListTelemetryRulesForOrganizationPaginatorName
- ListTelemetryRulesPaginatorName
- ResourceTypeType
- RuleHealthType
- StatusType
- TelemetryStateType
- TelemetryTypeType
- CloudWatchObservabilityAdminServiceServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
Type definitions#
Type annotations for type definitions used in methods and schema.
- SourceLogsConfigurationTypeDef
- CentralizationRuleSummaryTypeDef
- ResponseMetadataTypeDef
- DeleteCentralizationRuleForOrganizationInputTypeDef
- DeleteTelemetryRuleForOrganizationInputTypeDef
- DeleteTelemetryRuleInputTypeDef
- LogsBackupConfigurationTypeDef
- LogsEncryptionConfigurationTypeDef
- GetCentralizationRuleForOrganizationInputTypeDef
- GetTelemetryRuleForOrganizationInputTypeDef
- GetTelemetryRuleInputTypeDef
- PaginatorConfigTypeDef
- ListCentralizationRulesForOrganizationInputTypeDef
- ListResourceTelemetryForOrganizationInputTypeDef
- TelemetryConfigurationTypeDef
- ListResourceTelemetryInputTypeDef
- ListTagsForResourceInputTypeDef
- ListTelemetryRulesForOrganizationInputTypeDef
- TelemetryRuleSummaryTypeDef
- ListTelemetryRulesInputTypeDef
- TagResourceInputTypeDef
- VPCFlowLogParametersTypeDef
- UntagResourceInputTypeDef
- CentralizationRuleSourceOutputTypeDef
- CentralizationRuleSourceTypeDef
- CreateCentralizationRuleForOrganizationOutputTypeDef
- CreateTelemetryRuleForOrganizationOutputTypeDef
- CreateTelemetryRuleOutputTypeDef
- EmptyResponseMetadataTypeDef
- GetTelemetryEvaluationStatusForOrganizationOutputTypeDef
- GetTelemetryEvaluationStatusOutputTypeDef
- ListCentralizationRulesForOrganizationOutputTypeDef
- ListTagsForResourceOutputTypeDef
- UpdateCentralizationRuleForOrganizationOutputTypeDef
- UpdateTelemetryRuleForOrganizationOutputTypeDef
- UpdateTelemetryRuleOutputTypeDef
- DestinationLogsConfigurationTypeDef
- ListCentralizationRulesForOrganizationInputPaginateTypeDef
- ListResourceTelemetryForOrganizationInputPaginateTypeDef
- ListResourceTelemetryInputPaginateTypeDef
- ListTelemetryRulesForOrganizationInputPaginateTypeDef
- ListTelemetryRulesInputPaginateTypeDef
- ListResourceTelemetryForOrganizationOutputTypeDef
- ListResourceTelemetryOutputTypeDef
- ListTelemetryRulesForOrganizationOutputTypeDef
- ListTelemetryRulesOutputTypeDef
- TelemetryDestinationConfigurationTypeDef
- CentralizationRuleDestinationTypeDef
- TelemetryRuleTypeDef
- CentralizationRuleOutputTypeDef
- CentralizationRuleTypeDef
- CreateTelemetryRuleForOrganizationInputTypeDef
- CreateTelemetryRuleInputTypeDef
- GetTelemetryRuleForOrganizationOutputTypeDef
- GetTelemetryRuleOutputTypeDef
- UpdateTelemetryRuleForOrganizationInputTypeDef
- UpdateTelemetryRuleInputTypeDef
- GetCentralizationRuleForOrganizationOutputTypeDef
- CentralizationRuleUnionTypeDef
- CreateCentralizationRuleForOrganizationInputTypeDef
- UpdateCentralizationRuleForOrganizationInputTypeDef