CloudWatchLogs module#
Index > CloudWatchLogs
Auto-generated documentation for CloudWatchLogs type annotations stubs module types-boto3-logs.
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.36.26' mypy-boto3-builder
- Select
boto3
AWS SDK. - Add
CloudWatchLogs
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 CloudWatchLogs
.
From PyPI with pip#
Install types-boto3
for CloudWatchLogs
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[logs]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[logs]'
# standalone installation
python -m pip install types-boto3-logs
How to uninstall#
python -m pip uninstall -y types-boto3-logs
Usage#
Code samples can be found in Examples.
CloudWatchLogsClient#
Type annotations and code completion for boto3.client("logs")
as CloudWatchLogsClient
boto3 documentation
# CloudWatchLogsClient usage example
from boto3.session import Session
from types_boto3_logs.client import CloudWatchLogsClient
def get_client() -> CloudWatchLogsClient:
return Session().client("logs")
Paginators#
Type annotations and code completion for paginators
from boto3.client("logs").get_paginator("...")
.
# DescribeConfigurationTemplatesPaginator usage example
from boto3.session import Session
from types_boto3_logs.paginator import DescribeConfigurationTemplatesPaginator
def get_describe_configuration_templates_paginator() -> DescribeConfigurationTemplatesPaginator:
return Session().client("logs").get_paginator("describe_configuration_templates"))
- DescribeConfigurationTemplatesPaginator
- DescribeDeliveriesPaginator
- DescribeDeliveryDestinationsPaginator
- DescribeDeliverySourcesPaginator
- DescribeDestinationsPaginator
- DescribeExportTasksPaginator
- DescribeLogGroupsPaginator
- DescribeLogStreamsPaginator
- DescribeMetricFiltersPaginator
- DescribeQueriesPaginator
- DescribeResourcePoliciesPaginator
- DescribeSubscriptionFiltersPaginator
- FilterLogEventsPaginator
- ListAnomaliesPaginator
- ListLogAnomalyDetectorsPaginator
- ListLogGroupsForQueryPaginator
Literals#
Type annotations for literals used in methods and schema.
# AnomalyDetectorStatusType usage example
from types_boto3_logs.literals import AnomalyDetectorStatusType
def get_value() -> AnomalyDetectorStatusType:
return "ANALYZING"
- AnomalyDetectorStatusType
- DataProtectionStatusType
- DeliveryDestinationTypeType
- DescribeConfigurationTemplatesPaginatorName
- DescribeDeliveriesPaginatorName
- DescribeDeliveryDestinationsPaginatorName
- DescribeDeliverySourcesPaginatorName
- DescribeDestinationsPaginatorName
- DescribeExportTasksPaginatorName
- DescribeLogGroupsPaginatorName
- DescribeLogStreamsPaginatorName
- DescribeMetricFiltersPaginatorName
- DescribeQueriesPaginatorName
- DescribeResourcePoliciesPaginatorName
- DescribeSubscriptionFiltersPaginatorName
- DistributionType
- EntityRejectionErrorTypeType
- EvaluationFrequencyType
- ExportTaskStatusCodeType
- FilterLogEventsPaginatorName
- FlattenedElementType
- IndexSourceType
- InheritedPropertyType
- IntegrationStatusType
- IntegrationTypeType
- ListAnomaliesPaginatorName
- ListLogAnomalyDetectorsPaginatorName
- ListLogGroupsForQueryPaginatorName
- LogGroupClassType
- OpenSearchResourceStatusTypeType
- OrderByType
- OutputFormatType
- PolicyTypeType
- QueryLanguageType
- QueryStatusType
- ScopeType
- StandardUnitType
- StateType
- SuppressionStateType
- SuppressionTypeType
- SuppressionUnitType
- TypeType
- CloudWatchLogsServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AccountPolicyTypeDef
- AddKeyEntryTypeDef
- AnomalyDetectorTypeDef
- LogEventTypeDef
- PatternTokenTypeDef
- AssociateKmsKeyRequestTypeDef
- CSVOutputTypeDef
- CSVTypeDef
- CancelExportTaskRequestTypeDef
- S3DeliveryConfigurationTypeDef
- RecordFieldTypeDef
- CopyValueEntryTypeDef
- ResponseMetadataTypeDef
- CreateExportTaskRequestTypeDef
- CreateLogAnomalyDetectorRequestTypeDef
- CreateLogGroupRequestTypeDef
- CreateLogStreamRequestTypeDef
- DateTimeConverterOutputTypeDef
- DateTimeConverterTypeDef
- DeleteAccountPolicyRequestTypeDef
- DeleteDataProtectionPolicyRequestTypeDef
- DeleteDeliveryDestinationPolicyRequestTypeDef
- DeleteDeliveryDestinationRequestTypeDef
- DeleteDeliveryRequestTypeDef
- DeleteDeliverySourceRequestTypeDef
- DeleteDestinationRequestTypeDef
- DeleteIndexPolicyRequestTypeDef
- DeleteIntegrationRequestTypeDef
- DeleteKeysOutputTypeDef
- DeleteKeysTypeDef
- DeleteLogAnomalyDetectorRequestTypeDef
- DeleteLogGroupRequestTypeDef
- DeleteLogStreamRequestTypeDef
- DeleteMetricFilterRequestTypeDef
- DeleteQueryDefinitionRequestTypeDef
- DeleteResourcePolicyRequestTypeDef
- DeleteRetentionPolicyRequestTypeDef
- DeleteSubscriptionFilterRequestTypeDef
- DeleteTransformerRequestTypeDef
- DeliveryDestinationConfigurationTypeDef
- DeliverySourceTypeDef
- DescribeAccountPoliciesRequestTypeDef
- PaginatorConfigTypeDef
- DescribeConfigurationTemplatesRequestTypeDef
- DescribeDeliveriesRequestTypeDef
- DescribeDeliveryDestinationsRequestTypeDef
- DescribeDeliverySourcesRequestTypeDef
- DescribeDestinationsRequestTypeDef
- DestinationTypeDef
- DescribeExportTasksRequestTypeDef
- DescribeFieldIndexesRequestTypeDef
- FieldIndexTypeDef
- DescribeIndexPoliciesRequestTypeDef
- IndexPolicyTypeDef
- DescribeLogGroupsRequestTypeDef
- LogGroupTypeDef
- DescribeLogStreamsRequestTypeDef
- LogStreamTypeDef
- DescribeMetricFiltersRequestTypeDef
- DescribeQueriesRequestTypeDef
- QueryInfoTypeDef
- DescribeQueryDefinitionsRequestTypeDef
- QueryDefinitionTypeDef
- DescribeResourcePoliciesRequestTypeDef
- ResourcePolicyTypeDef
- DescribeSubscriptionFiltersRequestTypeDef
- SubscriptionFilterTypeDef
- DisassociateKmsKeyRequestTypeDef
- EntityTypeDef
- ExportTaskExecutionInfoTypeDef
- ExportTaskStatusTypeDef
- FilterLogEventsRequestTypeDef
- FilteredLogEventTypeDef
- SearchedLogStreamTypeDef
- GetDataProtectionPolicyRequestTypeDef
- GetDeliveryDestinationPolicyRequestTypeDef
- PolicyTypeDef
- GetDeliveryDestinationRequestTypeDef
- GetDeliveryRequestTypeDef
- GetDeliverySourceRequestTypeDef
- GetIntegrationRequestTypeDef
- GetLogAnomalyDetectorRequestTypeDef
- GetLogEventsRequestTypeDef
- OutputLogEventTypeDef
- GetLogGroupFieldsRequestTypeDef
- LogGroupFieldTypeDef
- GetLogRecordRequestTypeDef
- GetQueryResultsRequestTypeDef
- QueryStatisticsTypeDef
- ResultFieldTypeDef
- GetTransformerRequestTypeDef
- GrokTypeDef
- InputLogEventTypeDef
- IntegrationSummaryTypeDef
- ListAnomaliesRequestTypeDef
- ListIntegrationsRequestTypeDef
- ListLogAnomalyDetectorsRequestTypeDef
- ListLogGroupsForQueryRequestTypeDef
- ListTagsForResourceRequestTypeDef
- ListTagsLogGroupRequestTypeDef
- ListToMapTypeDef
- LiveTailSessionLogEventTypeDef
- LiveTailSessionMetadataTypeDef
- LiveTailSessionStartTypeDef
- LowerCaseStringOutputTypeDef
- LowerCaseStringTypeDef
- MetricFilterMatchRecordTypeDef
- MetricTransformationOutputTypeDef
- MetricTransformationTypeDef
- MoveKeyEntryTypeDef
- OpenSearchResourceStatusTypeDef
- OpenSearchResourceConfigTypeDef
- ParseCloudfrontTypeDef
- ParseJSONTypeDef
- ParseKeyValueTypeDef
- ParsePostgresTypeDef
- ParseRoute53TypeDef
- ParseVPCTypeDef
- ParseWAFTypeDef
- TrimStringOutputTypeDef
- UpperCaseStringOutputTypeDef
- PutAccountPolicyRequestTypeDef
- PutDataProtectionPolicyRequestTypeDef
- PutDeliveryDestinationPolicyRequestTypeDef
- PutDeliverySourceRequestTypeDef
- PutDestinationPolicyRequestTypeDef
- PutDestinationRequestTypeDef
- PutIndexPolicyRequestTypeDef
- RejectedEntityInfoTypeDef
- RejectedLogEventsInfoTypeDef
- PutQueryDefinitionRequestTypeDef
- PutResourcePolicyRequestTypeDef
- PutRetentionPolicyRequestTypeDef
- PutSubscriptionFilterRequestTypeDef
- RenameKeyEntryTypeDef
- SessionStreamingExceptionTypeDef
- SessionTimeoutExceptionTypeDef
- SplitStringEntryTypeDef
- StartLiveTailRequestTypeDef
- StartQueryRequestTypeDef
- StopQueryRequestTypeDef
- SubstituteStringEntryTypeDef
- SuppressionPeriodTypeDef
- TagLogGroupRequestTypeDef
- TagResourceRequestTypeDef
- TestMetricFilterRequestTypeDef
- TransformedLogRecordTypeDef
- TrimStringTypeDef
- TypeConverterEntryTypeDef
- UntagLogGroupRequestTypeDef
- UntagResourceRequestTypeDef
- UpdateLogAnomalyDetectorRequestTypeDef
- UpperCaseStringTypeDef
- AddKeysOutputTypeDef
- AddKeysTypeDef
- AnomalyTypeDef
- CSVUnionTypeDef
- ConfigurationTemplateDeliveryConfigValuesTypeDef
- CreateDeliveryRequestTypeDef
- DeliveryTypeDef
- UpdateDeliveryConfigurationRequestTypeDef
- CopyValueOutputTypeDef
- CopyValueTypeDef
- CreateExportTaskResponseTypeDef
- CreateLogAnomalyDetectorResponseTypeDef
- DeleteQueryDefinitionResponseTypeDef
- DescribeAccountPoliciesResponseTypeDef
- EmptyResponseMetadataTypeDef
- GetDataProtectionPolicyResponseTypeDef
- GetLogAnomalyDetectorResponseTypeDef
- GetLogRecordResponseTypeDef
- ListLogAnomalyDetectorsResponseTypeDef
- ListLogGroupsForQueryResponseTypeDef
- ListTagsForResourceResponseTypeDef
- ListTagsLogGroupResponseTypeDef
- PutAccountPolicyResponseTypeDef
- PutDataProtectionPolicyResponseTypeDef
- PutIntegrationResponseTypeDef
- PutQueryDefinitionResponseTypeDef
- StartQueryResponseTypeDef
- StopQueryResponseTypeDef
- DateTimeConverterUnionTypeDef
- DeleteKeysUnionTypeDef
- DeliveryDestinationTypeDef
- PutDeliveryDestinationRequestTypeDef
- DescribeDeliverySourcesResponseTypeDef
- GetDeliverySourceResponseTypeDef
- PutDeliverySourceResponseTypeDef
- DescribeConfigurationTemplatesRequestPaginateTypeDef
- DescribeDeliveriesRequestPaginateTypeDef
- DescribeDeliveryDestinationsRequestPaginateTypeDef
- DescribeDeliverySourcesRequestPaginateTypeDef
- DescribeDestinationsRequestPaginateTypeDef
- DescribeExportTasksRequestPaginateTypeDef
- DescribeLogGroupsRequestPaginateTypeDef
- DescribeLogStreamsRequestPaginateTypeDef
- DescribeMetricFiltersRequestPaginateTypeDef
- DescribeQueriesRequestPaginateTypeDef
- DescribeResourcePoliciesRequestPaginateTypeDef
- DescribeSubscriptionFiltersRequestPaginateTypeDef
- FilterLogEventsRequestPaginateTypeDef
- ListAnomaliesRequestPaginateTypeDef
- ListLogAnomalyDetectorsRequestPaginateTypeDef
- ListLogGroupsForQueryRequestPaginateTypeDef
- DescribeDestinationsResponseTypeDef
- PutDestinationResponseTypeDef
- DescribeFieldIndexesResponseTypeDef
- DescribeIndexPoliciesResponseTypeDef
- PutIndexPolicyResponseTypeDef
- DescribeLogGroupsResponseTypeDef
- DescribeLogStreamsResponseTypeDef
- DescribeQueriesResponseTypeDef
- DescribeQueryDefinitionsResponseTypeDef
- DescribeResourcePoliciesResponseTypeDef
- PutResourcePolicyResponseTypeDef
- DescribeSubscriptionFiltersResponseTypeDef
- ExportTaskTypeDef
- FilterLogEventsResponseTypeDef
- GetDeliveryDestinationPolicyResponseTypeDef
- PutDeliveryDestinationPolicyResponseTypeDef
- GetLogEventsResponseTypeDef
- GetLogGroupFieldsResponseTypeDef
- GetQueryResultsResponseTypeDef
- PutLogEventsRequestTypeDef
- ListIntegrationsResponseTypeDef
- LiveTailSessionUpdateTypeDef
- LowerCaseStringUnionTypeDef
- TestMetricFilterResponseTypeDef
- MetricFilterTypeDef
- MetricTransformationUnionTypeDef
- MoveKeysOutputTypeDef
- MoveKeysTypeDef
- OpenSearchApplicationTypeDef
- OpenSearchCollectionTypeDef
- OpenSearchDataAccessPolicyTypeDef
- OpenSearchDataSourceTypeDef
- OpenSearchEncryptionPolicyTypeDef
- OpenSearchLifecyclePolicyTypeDef
- OpenSearchNetworkPolicyTypeDef
- OpenSearchWorkspaceTypeDef
- ResourceConfigTypeDef
- PutLogEventsResponseTypeDef
- RenameKeysOutputTypeDef
- RenameKeysTypeDef
- SplitStringOutputTypeDef
- SplitStringTypeDef
- SubstituteStringOutputTypeDef
- SubstituteStringTypeDef
- UpdateAnomalyRequestTypeDef
- TestTransformerResponseTypeDef
- TrimStringUnionTypeDef
- TypeConverterOutputTypeDef
- TypeConverterTypeDef
- UpperCaseStringUnionTypeDef
- AddKeysUnionTypeDef
- ListAnomaliesResponseTypeDef
- ConfigurationTemplateTypeDef
- CreateDeliveryResponseTypeDef
- DescribeDeliveriesResponseTypeDef
- GetDeliveryResponseTypeDef
- CopyValueUnionTypeDef
- DescribeDeliveryDestinationsResponseTypeDef
- GetDeliveryDestinationResponseTypeDef
- PutDeliveryDestinationResponseTypeDef
- DescribeExportTasksResponseTypeDef
- StartLiveTailResponseStreamTypeDef
- DescribeMetricFiltersResponseTypeDef
- PutMetricFilterRequestTypeDef
- MoveKeysUnionTypeDef
- OpenSearchIntegrationDetailsTypeDef
- PutIntegrationRequestTypeDef
- RenameKeysUnionTypeDef
- SplitStringUnionTypeDef
- SubstituteStringUnionTypeDef
- ProcessorOutputTypeDef
- TypeConverterUnionTypeDef
- DescribeConfigurationTemplatesResponseTypeDef
- StartLiveTailResponseTypeDef
- IntegrationDetailsTypeDef
- GetTransformerResponseTypeDef
- ProcessorTypeDef
- GetIntegrationResponseTypeDef
- ProcessorUnionTypeDef
- PutTransformerRequestTypeDef
- TestTransformerRequestTypeDef