CloudWatchLogs module#
Index > CloudWatchLogs
Auto-generated documentation for CloudWatchLogs type annotations stubs module mypy-boto3-logs.
How to install#
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 boto3-stubs
for CloudWatchLogs
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[logs]'
# 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[logs]'
# standalone installation
python -m pip install mypy-boto3-logs
How to uninstall#
python -m pip uninstall -y mypy-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 mypy_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("...")
.
# DescribeDestinationsPaginator usage example
from boto3.session import Session
from mypy_boto3_logs.paginator import DescribeDestinationsPaginator
def get_describe_destinations_paginator() -> DescribeDestinationsPaginator:
return Session().client("logs").get_paginator("describe_destinations"))
- DescribeDestinationsPaginator
- DescribeExportTasksPaginator
- DescribeLogGroupsPaginator
- DescribeLogStreamsPaginator
- DescribeMetricFiltersPaginator
- DescribeQueriesPaginator
- DescribeResourcePoliciesPaginator
- DescribeSubscriptionFiltersPaginator
- FilterLogEventsPaginator
Literals#
Type annotations for literals used in methods and schemas.
# DataProtectionStatusType usage example
from mypy_boto3_logs.literals import DataProtectionStatusType
def get_value() -> DataProtectionStatusType:
return "ACTIVATED"
- DataProtectionStatusType
- DescribeDestinationsPaginatorName
- DescribeExportTasksPaginatorName
- DescribeLogGroupsPaginatorName
- DescribeLogStreamsPaginatorName
- DescribeMetricFiltersPaginatorName
- DescribeQueriesPaginatorName
- DescribeResourcePoliciesPaginatorName
- DescribeSubscriptionFiltersPaginatorName
- DistributionType
- ExportTaskStatusCodeType
- FilterLogEventsPaginatorName
- InheritedPropertyType
- OrderByType
- PolicyTypeType
- QueryStatusType
- ScopeType
- StandardUnitType
- CloudWatchLogsServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Typed dictionaries#
Type annotations for typed dictionaries used in methods and schema.
# AccountPolicyTypeDef usage example
from mypy_boto3_logs.type_defs import AccountPolicyTypeDef
def get_value() -> AccountPolicyTypeDef:
return {
"policyName": ...,
}
- AccountPolicyTypeDef
- AssociateKmsKeyRequestRequestTypeDef
- CancelExportTaskRequestRequestTypeDef
- CreateExportTaskRequestRequestTypeDef
- CreateExportTaskResponseTypeDef
- CreateLogGroupRequestRequestTypeDef
- CreateLogStreamRequestRequestTypeDef
- DeleteAccountPolicyRequestRequestTypeDef
- DeleteDataProtectionPolicyRequestRequestTypeDef
- DeleteDestinationRequestRequestTypeDef
- DeleteLogGroupRequestRequestTypeDef
- DeleteLogStreamRequestRequestTypeDef
- DeleteMetricFilterRequestRequestTypeDef
- DeleteQueryDefinitionRequestRequestTypeDef
- DeleteQueryDefinitionResponseTypeDef
- DeleteResourcePolicyRequestRequestTypeDef
- DeleteRetentionPolicyRequestRequestTypeDef
- DeleteSubscriptionFilterRequestRequestTypeDef
- DescribeAccountPoliciesRequestRequestTypeDef
- DescribeDestinationsRequestDescribeDestinationsPaginateTypeDef
- DescribeDestinationsRequestRequestTypeDef
- DestinationTypeDef
- DescribeExportTasksRequestDescribeExportTasksPaginateTypeDef
- DescribeExportTasksRequestRequestTypeDef
- DescribeLogGroupsRequestDescribeLogGroupsPaginateTypeDef
- DescribeLogGroupsRequestRequestTypeDef
- LogGroupTypeDef
- DescribeLogStreamsRequestDescribeLogStreamsPaginateTypeDef
- DescribeLogStreamsRequestRequestTypeDef
- LogStreamTypeDef
- DescribeMetricFiltersRequestDescribeMetricFiltersPaginateTypeDef
- DescribeMetricFiltersRequestRequestTypeDef
- DescribeQueriesRequestDescribeQueriesPaginateTypeDef
- DescribeQueriesRequestRequestTypeDef
- QueryInfoTypeDef
- DescribeQueryDefinitionsRequestRequestTypeDef
- QueryDefinitionTypeDef
- DescribeResourcePoliciesRequestDescribeResourcePoliciesPaginateTypeDef
- DescribeResourcePoliciesRequestRequestTypeDef
- ResourcePolicyTypeDef
- DescribeSubscriptionFiltersRequestDescribeSubscriptionFiltersPaginateTypeDef
- DescribeSubscriptionFiltersRequestRequestTypeDef
- SubscriptionFilterTypeDef
- DisassociateKmsKeyRequestRequestTypeDef
- EmptyResponseMetadataTypeDef
- ExportTaskExecutionInfoTypeDef
- ExportTaskStatusTypeDef
- FilterLogEventsRequestFilterLogEventsPaginateTypeDef
- FilterLogEventsRequestRequestTypeDef
- FilteredLogEventTypeDef
- SearchedLogStreamTypeDef
- GetDataProtectionPolicyRequestRequestTypeDef
- GetDataProtectionPolicyResponseTypeDef
- GetLogEventsRequestRequestTypeDef
- OutputLogEventTypeDef
- GetLogGroupFieldsRequestRequestTypeDef
- LogGroupFieldTypeDef
- GetLogRecordRequestRequestTypeDef
- GetLogRecordResponseTypeDef
- GetQueryResultsRequestRequestTypeDef
- QueryStatisticsTypeDef
- ResultFieldTypeDef
- InputLogEventTypeDef
- ListTagsForResourceRequestRequestTypeDef
- ListTagsForResourceResponseTypeDef
- ListTagsLogGroupRequestRequestTypeDef
- ListTagsLogGroupResponseTypeDef
- MetricFilterMatchRecordTypeDef
- MetricTransformationTypeDef
- PaginatorConfigTypeDef
- PutAccountPolicyRequestRequestTypeDef
- PutDataProtectionPolicyRequestRequestTypeDef
- PutDataProtectionPolicyResponseTypeDef
- PutDestinationPolicyRequestRequestTypeDef
- PutDestinationRequestRequestTypeDef
- RejectedLogEventsInfoTypeDef
- PutQueryDefinitionRequestRequestTypeDef
- PutQueryDefinitionResponseTypeDef
- PutResourcePolicyRequestRequestTypeDef
- PutRetentionPolicyRequestRequestTypeDef
- PutSubscriptionFilterRequestRequestTypeDef
- ResponseMetadataTypeDef
- StartQueryRequestRequestTypeDef
- StartQueryResponseTypeDef
- StopQueryRequestRequestTypeDef
- StopQueryResponseTypeDef
- TagLogGroupRequestRequestTypeDef
- TagResourceRequestRequestTypeDef
- TestMetricFilterRequestRequestTypeDef
- UntagLogGroupRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- DescribeAccountPoliciesResponseTypeDef
- PutAccountPolicyResponseTypeDef
- DescribeDestinationsResponseTypeDef
- PutDestinationResponseTypeDef
- DescribeLogGroupsResponseTypeDef
- DescribeLogStreamsResponseTypeDef
- DescribeQueriesResponseTypeDef
- DescribeQueryDefinitionsResponseTypeDef
- DescribeResourcePoliciesResponseTypeDef
- PutResourcePolicyResponseTypeDef
- DescribeSubscriptionFiltersResponseTypeDef
- ExportTaskTypeDef
- FilterLogEventsResponseTypeDef
- GetLogEventsResponseTypeDef
- GetLogGroupFieldsResponseTypeDef
- GetQueryResultsResponseTypeDef
- PutLogEventsRequestRequestTypeDef
- TestMetricFilterResponseTypeDef
- MetricFilterTypeDef
- PutMetricFilterRequestRequestTypeDef
- PutLogEventsResponseTypeDef
- DescribeExportTasksResponseTypeDef
- DescribeMetricFiltersResponseTypeDef