CloudWatchOmni module#
Index > CloudWatchOmni
Auto-generated documentation for CloudWatchOmni type annotations stubs module mypy-boto3-cloudwatchomni.
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.43.100' mypy-boto3-builder - Select
boto3-stubsAWS SDK. - Add
CloudWatchOmniservice. - 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 CloudWatchOmni.
From PyPI with pip#
Install boto3-stubs for CloudWatchOmni service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[cloudwatchomni]'
# 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[cloudwatchomni]'
# standalone installation
python -m pip install mypy-boto3-cloudwatchomni
How to uninstall#
python -m pip uninstall -y mypy-boto3-cloudwatchomni
Usage#
Code samples can be found in Examples.
CloudWatchOmniClient#
Type annotations and code completion for boto3.client("cloudwatchomni") as CloudWatchOmniClient
boto3 documentation
# CloudWatchOmniClient usage example
from boto3.session import Session
from mypy_boto3_cloudwatchomni.client import CloudWatchOmniClient
def get_client() -> CloudWatchOmniClient:
return Session().client("cloudwatchomni")
Paginators#
Type annotations and code completion for paginators
from boto3.client("cloudwatchomni").get_paginator("...").
# GetContextGraphPaginator usage example
from boto3.session import Session
from mypy_boto3_cloudwatchomni.paginator import GetContextGraphPaginator
def get_get_context_graph_paginator() -> GetContextGraphPaginator:
return Session().client("cloudwatchomni").get_paginator("get_context_graph"))
- GetContextGraphPaginator
- GetTelemetryQueryResultsPaginator
- ListAccessGrantsPaginator
- ListAccessProfilesPaginator
- ListAlertsPaginator
- ListDomainAccessGrantsForOrganizationPaginator
- ListDomainsPaginator
- ListIntegrationsPaginator
- ListOmniDashboardsPaginator
- ListSpacesForOrganizationPaginator
- ListSpacesPaginator
- ListTelemetryFieldsPaginator
- ListTelemetryQuerySessionsPaginator
- ListViewsPaginator
- SearchPrincipalsPaginator
Literals#
Type annotations for literals used in methods and schema.
# AccessGrantPermissionType usage example
from mypy_boto3_cloudwatchomni.literals import AccessGrantPermissionType
def get_value() -> AccessGrantPermissionType:
return "CUSTOM"
- AccessGrantPermissionType
- AccessGrantPrincipalTypeType
- AccessGrantTypeType
- AccessProfileTypeType
- AlertSortFieldType
- AlertSortOrderType
- AlertStateType
- AssumeStatusType
- AuthTypeType
- ComparatorType
- DomainStatusType
- EdgeTypeType
- EncryptionStrategyType
- GetContextGraphPaginatorName
- GetTelemetryQueryResultsPaginatorName
- IdentityProviderType
- IntegrationStatusType
- IntegrationTypeType
- ListAccessGrantsPaginatorName
- ListAccessProfilesPaginatorName
- ListAlertsPaginatorName
- ListDomainAccessGrantsForOrganizationPaginatorName
- ListDomainsPaginatorName
- ListIntegrationsPaginatorName
- ListOmniDashboardsPaginatorName
- ListSpacesForOrganizationPaginatorName
- ListSpacesPaginatorName
- ListTelemetryFieldsPaginatorName
- ListTelemetryQuerySessionsPaginatorName
- ListViewsPaginatorName
- NodeCategoryType
- NodeTypeType
- NotificationStatusType
- NotificationTargetTypeType
- OrganizationCredentialTypeType
- OrganizationGrantPermissionType
- OrganizationGrantPrincipalTypeType
- PrincipalTypeType
- QueryLanguageType
- QueryStatusType
- RowScopeOperatorType
- ScopeType
- SearchPrincipalsPaginatorName
- SignalType
- SignalTypeType
- SourceType
- SpaceStatusType
- TelemetryTypeType
- ThresholdModeType
- ViewTypeType
- CloudWatchOmniServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AccessGrantPrincipalAttributeTypeDef
- AccessProfileSummaryTypeDef
- AccessProfileTypeDef
- AlertConditionTypeDef
- AlertEvaluationTypeDef
- AlertFilterCriteriaTypeDef
- AlertRuleQueryTypeDef
- AlertStateDataTypeDef
- ContributorSummaryTypeDef
- ApiKeyCredentialTypeDef
- AwsCredentialsTypeDef
- ResponseMetadataTypeDef
- CreateAccessProfileInputTypeDef
- IntegrationTypeDef
- CreateOmniDashboardInputTypeDef
- OmniDashboardTypeDef
- CreateOneTimeDeepLinkCodeInputTypeDef
- EncryptionConfigurationTypeDef
- CreateViewRequestTypeDef
- DeleteAccessGrantInputTypeDef
- DeleteAccessProfileInputTypeDef
- DeleteAlertInputTypeDef
- DeleteDomainAccessGrantForOrganizationInputTypeDef
- DeleteDomainForOrganizationInputTypeDef
- DeleteDomainInputTypeDef
- IntegrationIdentifierTypeDef
- DeleteOmniDashboardInputTypeDef
- DeleteSpaceInputTypeDef
- DeleteViewRequestTypeDef
- DomainSummaryTypeDef
- KeyFilterTypeDef
- EdgeTrafficStatsTypeDef
- FieldPaginatorTypeDef
- FieldTypeDef
- GetAccessGrantInputTypeDef
- GetAccessProfileInputTypeDef
- GetAlertInputTypeDef
- PaginatorConfigTypeDef
- TimestampTypeDef
- GetDomainAccessGrantForOrganizationInputTypeDef
- GetDomainForOrganizationInputTypeDef
- GetDomainInputTypeDef
- GetOmniDashboardInputTypeDef
- SpaceCredentialRequestContextTypeDef
- GetSpaceInputTypeDef
- GetTelemetryQueryResultsRequestTypeDef
- GetViewRequestTypeDef
- IdentityCenterConfigurationTypeDef
- OAuthClientCredentialTypeDef
- OAuthCodeCredentialTypeDef
- ListAccessGrantsInputTypeDef
- ListAccessProfilesInputTypeDef
- ListDomainAccessGrantsForOrganizationInputTypeDef
- ListDomainsInputTypeDef
- ListIntegrationsInputTypeDef
- ListOmniDashboardsInputTypeDef
- OmniDashboardSummaryTypeDef
- ListSpacesForOrganizationInputTypeDef
- SpaceSummaryTypeDef
- ListSpacesInputTypeDef
- ListTelemetryQuerySessionsRequestTypeDef
- SessionSummaryTypeDef
- ListViewsRequestTypeDef
- ViewSummaryTypeDef
- LogMetadataTypeDef
- NodeSemanticsTypeDef
- TraceMetadataTypeDef
- MetricSemanticsTypeDef
- NoDataTypeDef
- NodePropertiesTypeDef
- NotificationTargetOutputTypeDef
- NotificationTriggerOutputTypeDef
- NotificationTargetTypeDef
- NotificationTriggerTypeDef
- PartialResultsTypeDef
- PrincipalSearchResultTypeDef
- PutIntelligenceConfigurationInputTypeDef
- RowScopeOutputTypeDef
- RowScopeTypeDef
- SearchPrincipalsInputTypeDef
- StartTelemetryQueryRequestTypeDef
- StartTelemetryQuerySessionRequestTypeDef
- StopTelemetryQueryRequestTypeDef
- StopTelemetryQuerySessionRequestTypeDef
- UpdateAccessProfileInputTypeDef
- UpdateOmniDashboardInputTypeDef
- UpdateViewRequestTypeDef
- AccessGrantPrincipalOutputTypeDef
- AccessGrantPrincipalTypeDef
- OrganizationAccessGrantPrincipalOutputTypeDef
- OrganizationAccessGrantPrincipalTypeDef
- ListAlertsInputTypeDef
- AlertStateInfoTypeDef
- CreateAccessProfileOutputTypeDef
- CreateOneTimeDeepLinkCodeOutputTypeDef
- CreateViewResponseTypeDef
- GetAccessProfileOutputTypeDef
- GetIntelligenceConfigurationOutputTypeDef
- GetSpaceCredentialsForOrganizationOutputTypeDef
- GetViewResponseTypeDef
- ListAccessProfilesOutputTypeDef
- PutIntelligenceConfigurationOutputTypeDef
- StartTelemetryQueryResponseTypeDef
- StartTelemetryQuerySessionResponseTypeDef
- UpdateAccessProfileOutputTypeDef
- UpdateViewResponseTypeDef
- CreateIntegrationOutputTypeDef
- GetIntegrationOutputTypeDef
- ListIntegrationsOutputTypeDef
- UpdateIntegrationOutputTypeDef
- CreateOmniDashboardOutputTypeDef
- GetOmniDashboardOutputTypeDef
- UpdateOmniDashboardOutputTypeDef
- CreateSpaceInputTypeDef
- SpaceTypeDef
- UpdateSpaceInputTypeDef
- DeleteIntegrationInputTypeDef
- GetIntegrationInputTypeDef
- ListDomainsOutputTypeDef
- EdgeFiltersTypeDef
- NodeFiltersTypeDef
- EdgePropertiesTypeDef
- ListTelemetryFieldsResponsePaginatorTypeDef
- ListTelemetryFieldsResponseTypeDef
- GetTelemetryQueryResultsRequestPaginateTypeDef
- ListAccessGrantsInputPaginateTypeDef
- ListAccessProfilesInputPaginateTypeDef
- ListAlertsInputPaginateTypeDef
- ListDomainAccessGrantsForOrganizationInputPaginateTypeDef
- ListDomainsInputPaginateTypeDef
- ListIntegrationsInputPaginateTypeDef
- ListOmniDashboardsInputPaginateTypeDef
- ListSpacesForOrganizationInputPaginateTypeDef
- ListSpacesInputPaginateTypeDef
- ListTelemetryQuerySessionsRequestPaginateTypeDef
- ListViewsRequestPaginateTypeDef
- SearchPrincipalsInputPaginateTypeDef
- ListTelemetryFieldsRequestPaginateTypeDef
- ListTelemetryFieldsRequestTypeDef
- GetSpaceCredentialsForOrganizationInputTypeDef
- IdentityProviderConfigurationTypeDef
- IntegrationCredentialTypeDef
- ListOmniDashboardsOutputTypeDef
- ListSpacesForOrganizationOutputTypeDef
- ListSpacesOutputTypeDef
- ListTelemetryQuerySessionsResponseTypeDef
- ListViewsResponseTypeDef
- MetricMetadataTypeDef
- TelemetryRuleTypeDef
- NotificationRuleOutputTypeDef
- NotificationTargetUnionTypeDef
- NotificationTriggerUnionTypeDef
- QueryStatisticsTypeDef
- SearchPrincipalsOutputTypeDef
- ResourceScopeOutputTypeDef
- RowScopeUnionTypeDef
- AccessGrantSummaryTypeDef
- AccessGrantPrincipalUnionTypeDef
- OrganizationAccessGrantSummaryTypeDef
- OrganizationAccessGrantTypeDef
- OrganizationAccessGrantPrincipalUnionTypeDef
- AlertSummaryTypeDef
- CreateSpaceOutputTypeDef
- GetSpaceOutputTypeDef
- UpdateSpaceOutputTypeDef
- GetContextGraphInputPaginateTypeDef
- GetContextGraphInputTypeDef
- CreateDomainForOrganizationInputTypeDef
- CreateDomainInputTypeDef
- DomainTypeDef
- OrganizationDomainTypeDef
- UpdateDomainForOrganizationInputTypeDef
- UpdateDomainInputTypeDef
- CreateIntegrationInputTypeDef
- UpdateIntegrationInputTypeDef
- MetadataTypeDef
- RuleTypeDef
- NotificationRuleTypeDef
- GetTelemetryQueryResultsResponseTypeDef
- ScopedActionsOutputTypeDef
- ResourceScopeTypeDef
- ListAccessGrantsOutputTypeDef
- ListDomainAccessGrantsForOrganizationOutputTypeDef
- CreateDomainAccessGrantForOrganizationOutputTypeDef
- GetDomainAccessGrantForOrganizationOutputTypeDef
- CreateDomainAccessGrantForOrganizationInputTypeDef
- ListAlertsOutputTypeDef
- CreateDomainOutputTypeDef
- GetDomainOutputTypeDef
- UpdateDomainOutputTypeDef
- CreateDomainForOrganizationOutputTypeDef
- GetDomainForOrganizationOutputTypeDef
- UpdateDomainForOrganizationOutputTypeDef
- EdgeTypeDef
- AlertTypeDef
- NotificationRuleUnionTypeDef
- AccessGrantTypeDef
- ResourceScopeUnionTypeDef
- NodeTypeDef
- CreateAlertOutputTypeDef
- GetAlertOutputTypeDef
- CreateAlertInputTypeDef
- UpdateAlertInputTypeDef
- CreateAccessGrantOutputTypeDef
- GetAccessGrantOutputTypeDef
- ScopedActionsTypeDef
- GetContextGraphOutputTypeDef
- ScopedActionsUnionTypeDef
- CreateAccessGrantInputTypeDef