rboto-cloudwatch-logs

rboto is an independent project maintained by Ferrumio. It is not affiliated with, sponsored by, or endorsed by Amazon Web Services (AWS).

Preview (Alpha). rboto is under active development. APIs may change between releases.

rboto provides an async-only, typed Python client for Amazon CloudWatch Logs, powered by Rust. This package contains CloudWatchLogsClient and 118 operations.

Installation

Requires Python 3.12 or newer and a native wheel for your Python version and platform.

python -m pip install "rboto[cloudwatch-logs]"

You can also install rboto-cloudwatch-logs directly; it installs the matching rboto package. Only the selected service is installed.

These are the package names to use when a release is available on your package index. If your index has no release yet, follow the source installation instructions.

Usage

Configure credentials through your environment, shared profile, or workload role. The example uses us-east-1; select a region where your service and resources are available. Resource names, identifiers, input files, and model IDs in the example are placeholders to replace with your own.

import asyncio

from rboto import CloudWatchLogsClient


async def main() -> None:
    client = CloudWatchLogsClient(region="us-east-1")
    response = await client.describe_log_groups(log_group_name_prefix="/aws/lambda/", limit=10)
    for group in response.log_groups or []:
        print(group.log_group_name)


if __name__ == "__main__":
    asyncio.run(main())

In an application with an event loop, call await main() instead of asyncio.run(main()). Reuse the client across calls. Constructing a client does not send a request.

API conventions

• Import the client with from rboto import CloudWatchLogsClient.

• Every operation is asynchronous: use await client.method(...).

• Operation arguments are keyword-only and use the Python names listed below.

• Structured inputs use typed dictionaries and tagged unions from rboto_cloudwatch_logs.types.

• Regular responses expose typed attributes; response.to_dict() converts them to a dictionary.

• Event-stream responses may be typed dictionaries containing async iterators. Follow the declared return type; consume event streams with async for.

• Byte streams are consumed asynchronously. await stream.read() buffers the complete body; iterate the stream when processing a large response.

• Direct operation calls return one page.

• Use async for page in client.paginators.method(...) for supported paginated operations. Paginators accept the same typed arguments as the corresponding client method.

• Catch modeled exceptions from rboto_cloudwatch_logs.exceptions. Their error_code, message, and operation_name identify service failures.

Clients also accept profile, endpoint_url, or shared Session settings. See configuration, errors, and streaming.

Operations

This is the complete operation catalog for this generated package. “Required arguments” lists arguments without defaults in the Python signature. Service-side conditions may require additional arguments. Each method links to its complete signature, including optional arguments. Nested input definitions are in rboto_cloudwatch_logs.types; native response definitions are in the package's _native.pyi.

Method	Required arguments	Return type
associate_kms_key	kms_key_id: str	None
associate_source_to_s3_table_integration	integration_arn: str, data_source: DataSource	AssociateSourceToS3TableIntegrationOutput
cancel_export_task	task_id: str	None
cancel_import_task	import_id: str	CancelImportTaskOutput
create_delivery	delivery_source_name: str, delivery_destination_arn: str	CreateDeliveryOutput
create_export_task	log_group_name: str, from_: int, to: int, destination: str	CreateExportTaskOutput
create_import_task	import_source_arn: str, import_role_arn: str	CreateImportTaskOutput
create_log_anomaly_detector	log_group_arn_list: Sequence[str]	CreateLogAnomalyDetectorOutput
create_log_group	log_group_name: str	None
create_log_stream	log_group_name: str, log_stream_name: str	None
create_lookup_table	lookup_table_name: str	CreateLookupTableOutput
create_scheduled_query	name: str, query_language: QueryLanguage, query_string: str, schedule_expression: str, execution_role_arn: str	CreateScheduledQueryOutput
delete_account_policy	policy_name: str, policy_type: PolicyType	None
delete_data_protection_policy	log_group_identifier: str	None
delete_delivery	id: str	None
delete_delivery_destination	name: str	None
delete_delivery_destination_policy	delivery_destination_name: str	None
delete_delivery_source	name: str	None
delete_destination	destination_name: str	None
delete_index_policy	log_group_identifier: str	DeleteIndexPolicyOutput
delete_integration	integration_name: str	DeleteIntegrationOutput
delete_log_anomaly_detector	anomaly_detector_arn: str	None
delete_log_group	log_group_name: str	None
delete_log_stream	log_group_name: str, log_stream_name: str	None
delete_lookup_table	lookup_table_arn: str	None
delete_metric_filter	log_group_name: str, filter_name: str	None
delete_query_definition	query_definition_id: str	DeleteQueryDefinitionOutput
delete_resource_policy	None	None
delete_retention_policy	log_group_name: str	None
delete_scheduled_query	identifier: str	DeleteScheduledQueryOutput
delete_subscription_filter	log_group_name: str, filter_name: str	None
delete_syslog_configuration	log_group_identifier: str	None
delete_transformer	log_group_identifier: str	None
describe_account_policies	policy_type: PolicyType	DescribeAccountPoliciesOutput
describe_configuration_templates	None	DescribeConfigurationTemplatesOutput
describe_deliveries	None	DescribeDeliveriesOutput
describe_delivery_destinations	None	DescribeDeliveryDestinationsOutput
describe_delivery_sources	None	DescribeDeliverySourcesOutput
describe_destinations	None	DescribeDestinationsOutput
describe_export_tasks	None	DescribeExportTasksOutput
describe_field_indexes	log_group_identifiers: Sequence[str]	DescribeFieldIndexesOutput
describe_import_task_batches	import_id: str	DescribeImportTaskBatchesOutput
describe_import_tasks	None	DescribeImportTasksOutput
describe_index_policies	log_group_identifiers: Sequence[str]	DescribeIndexPoliciesOutput
describe_log_groups	None	DescribeLogGroupsOutput
describe_log_streams	None	DescribeLogStreamsOutput
describe_lookup_tables	None	DescribeLookupTablesOutput
describe_metric_filters	None	DescribeMetricFiltersOutput
describe_queries	None	DescribeQueriesOutput
describe_query_definitions	None	DescribeQueryDefinitionsOutput
describe_resource_policies	None	DescribeResourcePoliciesOutput
describe_subscription_filters	log_group_name: str	DescribeSubscriptionFiltersOutput
disassociate_kms_key	None	None
disassociate_source_from_s3_table_integration	identifier: str	DisassociateSourceFromS3TableIntegrationOutput
filter_log_events	None	FilterLogEventsOutput
get_data_protection_policy	log_group_identifier: str	GetDataProtectionPolicyOutput
get_delivery	id: str	GetDeliveryOutput
get_delivery_destination	name: str	GetDeliveryDestinationOutput
get_delivery_destination_policy	delivery_destination_name: str	GetDeliveryDestinationPolicyOutput
get_delivery_source	name: str	GetDeliverySourceOutput
get_integration	integration_name: str	GetIntegrationOutput
get_log_anomaly_detector	anomaly_detector_arn: str	GetLogAnomalyDetectorOutput
get_log_events	log_stream_name: str	GetLogEventsOutput
get_log_fields	data_source_name: str, data_source_type: str	GetLogFieldsOutput
get_log_group_fields	None	GetLogGroupFieldsOutput
get_log_object	log_object_pointer: str	GetLogObjectOutput
get_log_record	log_record_pointer: str	GetLogRecordOutput
get_lookup_table	lookup_table_arn: str	GetLookupTableOutput
get_query_results	query_id: str	GetQueryResultsOutput
get_scheduled_query	identifier: str	GetScheduledQueryOutput
get_scheduled_query_history	identifier: str, start_time: int, end_time: int	GetScheduledQueryHistoryOutput
get_storage_tier_policy	None	GetStorageTierPolicyOutput
get_transformer	log_group_identifier: str	GetTransformerOutput
list_aggregate_log_group_summaries	group_by: ListAggregateLogGroupSummariesGroupBy	ListAggregateLogGroupSummariesOutput
list_anomalies	None	ListAnomaliesOutput
list_integrations	None	ListIntegrationsOutput
list_log_anomaly_detectors	None	ListLogAnomalyDetectorsOutput
list_log_groups	None	ListLogGroupsOutput
list_log_groups_for_query	query_id: str	ListLogGroupsForQueryOutput
list_scheduled_queries	None	ListScheduledQueriesOutput
list_sources_for_s3_table_integration	integration_arn: str	ListSourcesForS3TableIntegrationOutput
list_syslog_configurations	None	ListSyslogConfigurationsOutput
list_tags_for_resource	resource_arn: str	ListTagsForResourceOutput
list_tags_log_group	log_group_name: str	ListTagsLogGroupOutput
put_account_policy	policy_name: str, policy_document: str, policy_type: PolicyType	PutAccountPolicyOutput
put_bearer_token_authentication	log_group_identifier: str, bearer_token_authentication_enabled: bool	None
put_data_protection_policy	log_group_identifier: str, policy_document: str	PutDataProtectionPolicyOutput
put_delivery_destination	name: str	PutDeliveryDestinationOutput
put_delivery_destination_policy	delivery_destination_name: str, delivery_destination_policy: str	PutDeliveryDestinationPolicyOutput
put_delivery_source	name: str, resource_arn: str, log_type: str	PutDeliverySourceOutput
put_destination	destination_name: str, target_arn: str, role_arn: str	PutDestinationOutput
put_destination_policy	destination_name: str, access_policy: str	None
put_index_policy	log_group_identifier: str, policy_document: str	PutIndexPolicyOutput
put_integration	integration_name: str, resource_config: ResourceConfig, integration_type: IntegrationType	PutIntegrationOutput
put_log_events	log_group_name: str, log_stream_name: str, log_events: Sequence[InputLogEvent]	PutLogEventsOutput
put_log_group_deletion_protection	log_group_identifier: str, deletion_protection_enabled: bool	None
put_metric_filter	log_group_name: str, filter_name: str, filter_pattern: str, metric_transformations: Sequence[MetricTransformation]	None
put_query_definition	name: str, query_string: str	PutQueryDefinitionOutput
put_resource_policy	None	PutResourcePolicyOutput
put_retention_policy	log_group_name: str, retention_in_days: int	None
put_storage_tier_policy	storage_tier: StorageTier	PutStorageTierPolicyOutput
put_subscription_filter	log_group_name: str, filter_name: str, filter_pattern: str, destination_arn: str	None
put_syslog_configuration	log_group_identifier: str	None
put_transformer	log_group_identifier: str, transformer_config: Sequence[Processor]	None
start_live_tail	log_group_identifiers: Sequence[str]	StartLiveTailOutput
start_query	start_time: int, end_time: int, query_string: str	StartQueryOutput
stop_query	query_id: str	StopQueryOutput
tag_log_group	log_group_name: str, tags: dict[str, str]	None
tag_resource	resource_arn: str, tags: dict[str, str]	None
test_metric_filter	filter_pattern: str, log_event_messages: Sequence[str]	TestMetricFilterOutput
test_transformer	transformer_config: Sequence[Processor], log_event_messages: Sequence[str]	TestTransformerOutput
untag_log_group	log_group_name: str, tags: Sequence[str]	None
untag_resource	resource_arn: str, tag_keys: Sequence[str]	None
update_anomaly	anomaly_detector_arn: str	None
update_delivery_configuration	id: str	UpdateDeliveryConfigurationOutput
update_log_anomaly_detector	anomaly_detector_arn: str, enabled: bool	None
update_lookup_table	lookup_table_arn: str	UpdateLookupTableOutput
update_scheduled_query	identifier: str, query_language: QueryLanguage, query_string: str, schedule_expression: str, execution_role_arn: str	UpdateScheduledQueryOutput

Complete signatures

associate_kms_key

async def associate_kms_key(
    *,
    kms_key_id: str,
    log_group_name: str | None = None,
    resource_identifier: str | None = None,
) -> None: ...

associate_source_to_s3_table_integration

async def associate_source_to_s3_table_integration(
    *,
    integration_arn: str,
    data_source: DataSource,
) -> AssociateSourceToS3TableIntegrationOutput: ...

cancel_export_task

async def cancel_export_task(
    *,
    task_id: str,
) -> None: ...

cancel_import_task

async def cancel_import_task(
    *,
    import_id: str,
) -> CancelImportTaskOutput: ...

create_delivery

async def create_delivery(
    *,
    delivery_source_name: str,
    delivery_destination_arn: str,
    record_fields: Sequence[str] | None = None,
    field_delimiter: str | None = None,
    s3_delivery_configuration: S3DeliveryConfiguration | None = None,
    tags: dict[str, str] | None = None,
) -> CreateDeliveryOutput: ...

create_export_task

async def create_export_task(
    *,
    log_group_name: str,
    from_: int,
    to: int,
    destination: str,
    task_name: str | None = None,
    log_stream_name_prefix: str | None = None,
    destination_prefix: str | None = None,
) -> CreateExportTaskOutput: ...

create_import_task

async def create_import_task(
    *,
    import_source_arn: str,
    import_role_arn: str,
    import_filter: ImportFilter | None = None,
) -> CreateImportTaskOutput: ...

create_log_anomaly_detector

async def create_log_anomaly_detector(
    *,
    log_group_arn_list: Sequence[str],
    detector_name: str | None = None,
    evaluation_frequency: EvaluationFrequency | None = None,
    filter_pattern: str | None = None,
    kms_key_id: str | None = None,
    anomaly_visibility_time: int | None = None,
    tags: dict[str, str] | None = None,
) -> CreateLogAnomalyDetectorOutput: ...

create_log_group

async def create_log_group(
    *,
    log_group_name: str,
    kms_key_id: str | None = None,
    tags: dict[str, str] | None = None,
    log_group_class: LogGroupClass | None = None,
    deletion_protection_enabled: bool | None = None,
) -> None: ...

create_log_stream

async def create_log_stream(
    *,
    log_group_name: str,
    log_stream_name: str,
) -> None: ...

create_lookup_table

async def create_lookup_table(
    *,
    lookup_table_name: str,
    description: str | None = None,
    table_body: str | None = None,
    query_id: str | None = None,
    kms_key_id: str | None = None,
    tags: dict[str, str] | None = None,
) -> CreateLookupTableOutput: ...

create_scheduled_query

async def create_scheduled_query(
    *,
    name: str,
    query_language: QueryLanguage,
    query_string: str,
    schedule_expression: str,
    execution_role_arn: str,
    description: str | None = None,
    log_group_identifiers: Sequence[str] | None = None,
    timezone: str | None = None,
    start_time_offset: int | None = None,
    end_time_offset: int | None = None,
    destination_configuration: DestinationConfiguration | None = None,
    schedule_start_time: int | None = None,
    schedule_end_time: int | None = None,
    state: ScheduledQueryState | None = None,
    tags: dict[str, str] | None = None,
) -> CreateScheduledQueryOutput: ...

delete_account_policy

async def delete_account_policy(
    *,
    policy_name: str,
    policy_type: PolicyType,
) -> None: ...

delete_data_protection_policy

async def delete_data_protection_policy(
    *,
    log_group_identifier: str,
) -> None: ...

delete_delivery

async def delete_delivery(
    *,
    id: str,
) -> None: ...

delete_delivery_destination

async def delete_delivery_destination(
    *,
    name: str,
) -> None: ...

delete_delivery_destination_policy

async def delete_delivery_destination_policy(
    *,
    delivery_destination_name: str,
) -> None: ...

delete_delivery_source

async def delete_delivery_source(
    *,
    name: str,
) -> None: ...

delete_destination

async def delete_destination(
    *,
    destination_name: str,
) -> None: ...

delete_index_policy

async def delete_index_policy(
    *,
    log_group_identifier: str,
) -> DeleteIndexPolicyOutput: ...

delete_integration

async def delete_integration(
    *,
    integration_name: str,
    force: bool | None = None,
) -> DeleteIntegrationOutput: ...

delete_log_anomaly_detector

async def delete_log_anomaly_detector(
    *,
    anomaly_detector_arn: str,
) -> None: ...

delete_log_group

async def delete_log_group(
    *,
    log_group_name: str,
) -> None: ...

delete_log_stream

async def delete_log_stream(
    *,
    log_group_name: str,
    log_stream_name: str,
) -> None: ...

delete_lookup_table

async def delete_lookup_table(
    *,
    lookup_table_arn: str,
) -> None: ...

delete_metric_filter

async def delete_metric_filter(
    *,
    log_group_name: str,
    filter_name: str,
) -> None: ...

delete_query_definition

async def delete_query_definition(
    *,
    query_definition_id: str,
) -> DeleteQueryDefinitionOutput: ...

delete_resource_policy

async def delete_resource_policy(
    *,
    policy_name: str | None = None,
    resource_arn: str | None = None,
    expected_revision_id: str | None = None,
) -> None: ...

delete_retention_policy

async def delete_retention_policy(
    *,
    log_group_name: str,
) -> None: ...

delete_scheduled_query

async def delete_scheduled_query(
    *,
    identifier: str,
) -> DeleteScheduledQueryOutput: ...

delete_subscription_filter

async def delete_subscription_filter(
    *,
    log_group_name: str,
    filter_name: str,
) -> None: ...

delete_syslog_configuration

async def delete_syslog_configuration(
    *,
    log_group_identifier: str,
    vpc_endpoint_id: str | None = None,
) -> None: ...

delete_transformer

async def delete_transformer(
    *,
    log_group_identifier: str,
) -> None: ...

describe_account_policies

async def describe_account_policies(
    *,
    policy_type: PolicyType,
    policy_name: str | None = None,
    account_identifiers: Sequence[str] | None = None,
    next_token: str | None = None,
) -> DescribeAccountPoliciesOutput: ...

describe_configuration_templates

async def describe_configuration_templates(
    *,
    service: str | None = None,
    log_types: Sequence[str] | None = None,
    resource_types: Sequence[str] | None = None,
    delivery_destination_types: Sequence[DeliveryDestinationType] | None = None,
    next_token: str | None = None,
    limit: int | None = None,
) -> DescribeConfigurationTemplatesOutput: ...

Also available as client.paginators.describe_configuration_templates(...), returning an async iterator of the response type above.

describe_deliveries

async def describe_deliveries(
    *,
    next_token: str | None = None,
    limit: int | None = None,
    delivery_source_names: Sequence[str] | None = None,
) -> DescribeDeliveriesOutput: ...

Also available as client.paginators.describe_deliveries(...), returning an async iterator of the response type above.

describe_delivery_destinations

async def describe_delivery_destinations(
    *,
    next_token: str | None = None,
    limit: int | None = None,
    names: Sequence[str] | None = None,
) -> DescribeDeliveryDestinationsOutput: ...

Also available as client.paginators.describe_delivery_destinations(...), returning an async iterator of the response type above.

describe_delivery_sources

async def describe_delivery_sources(
    *,
    next_token: str | None = None,
    limit: int | None = None,
    resource_arns: Sequence[str] | None = None,
) -> DescribeDeliverySourcesOutput: ...

Also available as client.paginators.describe_delivery_sources(...), returning an async iterator of the response type above.

describe_destinations

async def describe_destinations(
    *,
    destination_name_prefix: str | None = None,
    next_token: str | None = None,
    limit: int | None = None,
) -> DescribeDestinationsOutput: ...

Also available as client.paginators.describe_destinations(...), returning an async iterator of the response type above.

describe_export_tasks

async def describe_export_tasks(
    *,
    task_id: str | None = None,
    status_code: ExportTaskStatusCode | None = None,
    next_token: str | None = None,
    limit: int | None = None,
) -> DescribeExportTasksOutput: ...

Also available as client.paginators.describe_export_tasks(...), returning an async iterator of the response type above.

describe_field_indexes

async def describe_field_indexes(
    *,
    log_group_identifiers: Sequence[str],
    index_categories: Sequence[IndexCategory] | None = None,
    next_token: str | None = None,
) -> DescribeFieldIndexesOutput: ...

describe_import_task_batches

async def describe_import_task_batches(
    *,
    import_id: str,
    batch_import_status: Sequence[ImportStatus] | None = None,
    limit: int | None = None,
    next_token: str | None = None,
) -> DescribeImportTaskBatchesOutput: ...

describe_import_tasks

async def describe_import_tasks(
    *,
    import_id: str | None = None,
    import_status: ImportStatus | None = None,
    import_source_arn: str | None = None,
    limit: int | None = None,
    next_token: str | None = None,
) -> DescribeImportTasksOutput: ...

describe_index_policies

async def describe_index_policies(
    *,
    log_group_identifiers: Sequence[str],
    next_token: str | None = None,
) -> DescribeIndexPoliciesOutput: ...

describe_log_groups

async def describe_log_groups(
    *,
    account_identifiers: Sequence[str] | None = None,
    log_group_name_prefix: str | None = None,
    log_group_name_pattern: str | None = None,
    next_token: str | None = None,
    limit: int | None = None,
    include_linked_accounts: bool | None = None,
    log_group_class: LogGroupClass | None = None,
    log_group_identifiers: Sequence[str] | None = None,
) -> DescribeLogGroupsOutput: ...

Also available as client.paginators.describe_log_groups(...), returning an async iterator of the response type above.

describe_log_streams

async def describe_log_streams(
    *,
    log_group_name: str | None = None,
    log_group_identifier: str | None = None,
    log_stream_name_prefix: str | None = None,
    order_by: OrderBy | None = None,
    descending: bool | None = None,
    next_token: str | None = None,
    limit: int | None = None,
) -> DescribeLogStreamsOutput: ...

Also available as client.paginators.describe_log_streams(...), returning an async iterator of the response type above.

describe_lookup_tables

async def describe_lookup_tables(
    *,
    lookup_table_name_prefix: str | None = None,
    max_results: int | None = None,
    next_token: str | None = None,
) -> DescribeLookupTablesOutput: ...

describe_metric_filters

async def describe_metric_filters(
    *,
    log_group_name: str | None = None,
    filter_name_prefix: str | None = None,
    next_token: str | None = None,
    limit: int | None = None,
    metric_name: str | None = None,
    metric_namespace: str | None = None,
) -> DescribeMetricFiltersOutput: ...

Also available as client.paginators.describe_metric_filters(...), returning an async iterator of the response type above.

describe_queries

async def describe_queries(
    *,
    log_group_name: str | None = None,
    status: QueryStatus | None = None,
    max_results: int | None = None,
    next_token: str | None = None,
    query_language: QueryLanguage | None = None,
) -> DescribeQueriesOutput: ...

Also available as client.paginators.describe_queries(...), returning an async iterator of the response type above.

describe_query_definitions

async def describe_query_definitions(
    *,
    query_language: QueryLanguage | None = None,
    query_definition_name_prefix: str | None = None,
    max_results: int | None = None,
    next_token: str | None = None,
) -> DescribeQueryDefinitionsOutput: ...

describe_resource_policies

async def describe_resource_policies(
    *,
    next_token: str | None = None,
    limit: int | None = None,
    resource_arn: str | None = None,
    policy_scope: PolicyScope | None = None,
) -> DescribeResourcePoliciesOutput: ...

Also available as client.paginators.describe_resource_policies(...), returning an async iterator of the response type above.

describe_subscription_filters

async def describe_subscription_filters(
    *,
    log_group_name: str,
    filter_name_prefix: str | None = None,
    next_token: str | None = None,
    limit: int | None = None,
) -> DescribeSubscriptionFiltersOutput: ...

Also available as client.paginators.describe_subscription_filters(...), returning an async iterator of the response type above.

disassociate_kms_key

async def disassociate_kms_key(
    *,
    log_group_name: str | None = None,
    resource_identifier: str | None = None,
) -> None: ...

disassociate_source_from_s3_table_integration

async def disassociate_source_from_s3_table_integration(
    *,
    identifier: str,
) -> DisassociateSourceFromS3TableIntegrationOutput: ...

filter_log_events

async def filter_log_events(
    *,
    log_group_name: str | None = None,
    log_group_identifier: str | None = None,
    log_stream_names: Sequence[str] | None = None,
    log_stream_name_prefix: str | None = None,
    start_time: int | None = None,
    end_time: int | None = None,
    filter_pattern: str | None = None,
    next_token: str | None = None,
    limit: int | None = None,
    start_from_head: bool | None = None,
    interleaved: bool | None = None,
    unmask: bool | None = None,
) -> FilterLogEventsOutput: ...

Also available as client.paginators.filter_log_events(...), returning an async iterator of the response type above.

get_data_protection_policy

async def get_data_protection_policy(
    *,
    log_group_identifier: str,
) -> GetDataProtectionPolicyOutput: ...

get_delivery

async def get_delivery(
    *,
    id: str,
) -> GetDeliveryOutput: ...

get_delivery_destination

async def get_delivery_destination(
    *,
    name: str,
) -> GetDeliveryDestinationOutput: ...

get_delivery_destination_policy

async def get_delivery_destination_policy(
    *,
    delivery_destination_name: str,
) -> GetDeliveryDestinationPolicyOutput: ...

get_delivery_source

async def get_delivery_source(
    *,
    name: str,
) -> GetDeliverySourceOutput: ...

get_integration

async def get_integration(
    *,
    integration_name: str,
) -> GetIntegrationOutput: ...

get_log_anomaly_detector

async def get_log_anomaly_detector(
    *,
    anomaly_detector_arn: str,
) -> GetLogAnomalyDetectorOutput: ...

get_log_events

async def get_log_events(
    *,
    log_stream_name: str,
    log_group_name: str | None = None,
    log_group_identifier: str | None = None,
    start_time: int | None = None,
    end_time: int | None = None,
    next_token: str | None = None,
    limit: int | None = None,
    start_from_head: bool | None = None,
    unmask: bool | None = None,
) -> GetLogEventsOutput: ...

Also available as client.paginators.get_log_events(...), returning an async iterator of the response type above.

get_log_fields

async def get_log_fields(
    *,
    data_source_name: str,
    data_source_type: str,
) -> GetLogFieldsOutput: ...

get_log_group_fields

async def get_log_group_fields(
    *,
    log_group_name: str | None = None,
    time: int | None = None,
    log_group_identifier: str | None = None,
) -> GetLogGroupFieldsOutput: ...

get_log_object

async def get_log_object(
    *,
    log_object_pointer: str,
    unmask: bool | None = None,
) -> GetLogObjectOutput: ...

get_log_record

async def get_log_record(
    *,
    log_record_pointer: str,
    unmask: bool | None = None,
) -> GetLogRecordOutput: ...

get_lookup_table

async def get_lookup_table(
    *,
    lookup_table_arn: str,
) -> GetLookupTableOutput: ...

get_query_results

async def get_query_results(
    *,
    query_id: str,
    next_token: str | None = None,
    max_items: int | None = None,
) -> GetQueryResultsOutput: ...

get_scheduled_query

async def get_scheduled_query(
    *,
    identifier: str,
) -> GetScheduledQueryOutput: ...

get_scheduled_query_history

async def get_scheduled_query_history(
    *,
    identifier: str,
    start_time: int,
    end_time: int,
    execution_statuses: Sequence[ExecutionStatus] | None = None,
    max_results: int | None = None,
    next_token: str | None = None,
) -> GetScheduledQueryHistoryOutput: ...

Also available as client.paginators.get_scheduled_query_history(...), returning an async iterator of the response type above.

get_storage_tier_policy

async def get_storage_tier_policy() -> GetStorageTierPolicyOutput: ...

get_transformer

async def get_transformer(
    *,
    log_group_identifier: str,
) -> GetTransformerOutput: ...

list_aggregate_log_group_summaries

async def list_aggregate_log_group_summaries(
    *,
    group_by: ListAggregateLogGroupSummariesGroupBy,
    account_identifiers: Sequence[str] | None = None,
    include_linked_accounts: bool | None = None,
    log_group_class: LogGroupClass | None = None,
    log_group_name_pattern: str | None = None,
    data_sources: Sequence[DataSourceFilter] | None = None,
    next_token: str | None = None,
    limit: int | None = None,
) -> ListAggregateLogGroupSummariesOutput: ...

Also available as client.paginators.list_aggregate_log_group_summaries(...), returning an async iterator of the response type above.

list_anomalies

async def list_anomalies(
    *,
    anomaly_detector_arn: str | None = None,
    suppression_state: SuppressionState | None = None,
    limit: int | None = None,
    next_token: str | None = None,
) -> ListAnomaliesOutput: ...

Also available as client.paginators.list_anomalies(...), returning an async iterator of the response type above.

list_integrations

async def list_integrations(
    *,
    integration_name_prefix: str | None = None,
    integration_type: IntegrationType | None = None,
    integration_status: IntegrationStatus | None = None,
) -> ListIntegrationsOutput: ...

list_log_anomaly_detectors

async def list_log_anomaly_detectors(
    *,
    filter_log_group_arn: str | None = None,
    limit: int | None = None,
    next_token: str | None = None,
) -> ListLogAnomalyDetectorsOutput: ...

Also available as client.paginators.list_log_anomaly_detectors(...), returning an async iterator of the response type above.

list_log_groups

async def list_log_groups(
    *,
    log_group_name_pattern: str | None = None,
    log_group_class: LogGroupClass | None = None,
    include_linked_accounts: bool | None = None,
    account_identifiers: Sequence[str] | None = None,
    next_token: str | None = None,
    limit: int | None = None,
    data_sources: Sequence[DataSourceFilter] | None = None,
    field_index_names: Sequence[str] | None = None,
    log_group_tags: Sequence[TagFilter] | None = None,
) -> ListLogGroupsOutput: ...

list_log_groups_for_query

async def list_log_groups_for_query(
    *,
    query_id: str,
    next_token: str | None = None,
    max_results: int | None = None,
) -> ListLogGroupsForQueryOutput: ...

Also available as client.paginators.list_log_groups_for_query(...), returning an async iterator of the response type above.

list_scheduled_queries

async def list_scheduled_queries(
    *,
    max_results: int | None = None,
    next_token: str | None = None,
    state: ScheduledQueryState | None = None,
    schedule_type: ScheduleType | None = None,
) -> ListScheduledQueriesOutput: ...

Also available as client.paginators.list_scheduled_queries(...), returning an async iterator of the response type above.

list_sources_for_s3_table_integration

async def list_sources_for_s3_table_integration(
    *,
    integration_arn: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListSourcesForS3TableIntegrationOutput: ...

Also available as client.paginators.list_sources_for_s3_table_integration(...), returning an async iterator of the response type above.

list_syslog_configurations

async def list_syslog_configurations(
    *,
    log_group_identifier: str | None = None,
    vpc_endpoint_id: str | None = None,
    next_token: str | None = None,
    max_results: int | None = None,
) -> ListSyslogConfigurationsOutput: ...

list_tags_for_resource

async def list_tags_for_resource(
    *,
    resource_arn: str,
) -> ListTagsForResourceOutput: ...

list_tags_log_group

async def list_tags_log_group(
    *,
    log_group_name: str,
) -> ListTagsLogGroupOutput: ...

put_account_policy

async def put_account_policy(
    *,
    policy_name: str,
    policy_document: str,
    policy_type: PolicyType,
    scope: Scope | None = None,
    selection_criteria: str | None = None,
) -> PutAccountPolicyOutput: ...

put_bearer_token_authentication

async def put_bearer_token_authentication(
    *,
    log_group_identifier: str,
    bearer_token_authentication_enabled: bool,
) -> None: ...

put_data_protection_policy

async def put_data_protection_policy(
    *,
    log_group_identifier: str,
    policy_document: str,
) -> PutDataProtectionPolicyOutput: ...

put_delivery_destination

async def put_delivery_destination(
    *,
    name: str,
    output_format: OutputFormat | None = None,
    delivery_destination_configuration: DeliveryDestinationConfiguration | None = None,
    delivery_destination_type: DeliveryDestinationType | None = None,
    role_arn: str | None = None,
    tags: dict[str, str] | None = None,
) -> PutDeliveryDestinationOutput: ...

put_delivery_destination_policy

async def put_delivery_destination_policy(
    *,
    delivery_destination_name: str,
    delivery_destination_policy: str,
) -> PutDeliveryDestinationPolicyOutput: ...

put_delivery_source

async def put_delivery_source(
    *,
    name: str,
    resource_arn: str,
    log_type: str,
    tags: dict[str, str] | None = None,
    delivery_source_configuration: dict[str, str] | None = None,
) -> PutDeliverySourceOutput: ...

put_destination

async def put_destination(
    *,
    destination_name: str,
    target_arn: str,
    role_arn: str,
    tags: dict[str, str] | None = None,
) -> PutDestinationOutput: ...

put_destination_policy

async def put_destination_policy(
    *,
    destination_name: str,
    access_policy: str,
    force_update: bool | None = None,
) -> None: ...

put_index_policy

async def put_index_policy(
    *,
    log_group_identifier: str,
    policy_document: str,
) -> PutIndexPolicyOutput: ...

put_integration

async def put_integration(
    *,
    integration_name: str,
    resource_config: ResourceConfig,
    integration_type: IntegrationType,
) -> PutIntegrationOutput: ...

put_log_events

async def put_log_events(
    *,
    log_group_name: str,
    log_stream_name: str,
    log_events: Sequence[InputLogEvent],
    sequence_token: str | None = None,
    entity: Entity | None = None,
) -> PutLogEventsOutput: ...

put_log_group_deletion_protection

async def put_log_group_deletion_protection(
    *,
    log_group_identifier: str,
    deletion_protection_enabled: bool,
) -> None: ...

put_metric_filter

async def put_metric_filter(
    *,
    log_group_name: str,
    filter_name: str,
    filter_pattern: str,
    metric_transformations: Sequence[MetricTransformation],
    apply_on_transformed_logs: bool | None = None,
    field_selection_criteria: str | None = None,
    emit_system_field_dimensions: Sequence[str] | None = None,
) -> None: ...

put_query_definition

async def put_query_definition(
    *,
    name: str,
    query_string: str,
    query_language: QueryLanguage | None = None,
    query_definition_id: str | None = None,
    log_group_names: Sequence[str] | None = None,
    client_token: str | None = None,
    parameters: Sequence[QueryParameter] | None = None,
) -> PutQueryDefinitionOutput: ...

put_resource_policy

async def put_resource_policy(
    *,
    policy_name: str | None = None,
    policy_document: str | None = None,
    resource_arn: str | None = None,
    expected_revision_id: str | None = None,
) -> PutResourcePolicyOutput: ...

put_retention_policy

async def put_retention_policy(
    *,
    log_group_name: str,
    retention_in_days: int,
) -> None: ...

put_storage_tier_policy

async def put_storage_tier_policy(
    *,
    storage_tier: StorageTier,
) -> PutStorageTierPolicyOutput: ...

put_subscription_filter

async def put_subscription_filter(
    *,
    log_group_name: str,
    filter_name: str,
    filter_pattern: str,
    destination_arn: str,
    role_arn: str | None = None,
    distribution: Distribution | None = None,
    apply_on_transformed_logs: bool | None = None,
    field_selection_criteria: str | None = None,
    emit_system_fields: Sequence[str] | None = None,
) -> None: ...

put_syslog_configuration

async def put_syslog_configuration(
    *,
    log_group_identifier: str,
    vpc_endpoint_id: str | None = None,
) -> None: ...

put_transformer

async def put_transformer(
    *,
    log_group_identifier: str,
    transformer_config: Sequence[Processor],
) -> None: ...

start_live_tail

async def start_live_tail(
    *,
    log_group_identifiers: Sequence[str],
    log_stream_names: Sequence[str] | None = None,
    log_stream_name_prefixes: Sequence[str] | None = None,
    log_event_filter_pattern: str | None = None,
) -> StartLiveTailOutput: ...

start_query

async def start_query(
    *,
    start_time: int,
    end_time: int,
    query_string: str,
    query_language: QueryLanguage | None = None,
    log_group_name: str | None = None,
    log_group_names: Sequence[str] | None = None,
    log_group_identifiers: Sequence[str] | None = None,
    limit: int | None = None,
) -> StartQueryOutput: ...

stop_query

async def stop_query(
    *,
    query_id: str,
) -> StopQueryOutput: ...

tag_log_group

async def tag_log_group(
    *,
    log_group_name: str,
    tags: dict[str, str],
) -> None: ...

tag_resource

async def tag_resource(
    *,
    resource_arn: str,
    tags: dict[str, str],
) -> None: ...

test_metric_filter

async def test_metric_filter(
    *,
    filter_pattern: str,
    log_event_messages: Sequence[str],
) -> TestMetricFilterOutput: ...

test_transformer

async def test_transformer(
    *,
    transformer_config: Sequence[Processor],
    log_event_messages: Sequence[str],
) -> TestTransformerOutput: ...

untag_log_group

async def untag_log_group(
    *,
    log_group_name: str,
    tags: Sequence[str],
) -> None: ...

untag_resource

async def untag_resource(
    *,
    resource_arn: str,
    tag_keys: Sequence[str],
) -> None: ...

update_anomaly

async def update_anomaly(
    *,
    anomaly_detector_arn: str,
    anomaly_id: str | None = None,
    pattern_id: str | None = None,
    suppression_type: SuppressionType | None = None,
    suppression_period: SuppressionPeriod | None = None,
    baseline: bool | None = None,
) -> None: ...

update_delivery_configuration

async def update_delivery_configuration(
    *,
    id: str,
    record_fields: Sequence[str] | None = None,
    field_delimiter: str | None = None,
    s3_delivery_configuration: S3DeliveryConfiguration | None = None,
) -> UpdateDeliveryConfigurationOutput: ...

update_log_anomaly_detector

async def update_log_anomaly_detector(
    *,
    anomaly_detector_arn: str,
    enabled: bool,
    evaluation_frequency: EvaluationFrequency | None = None,
    filter_pattern: str | None = None,
    anomaly_visibility_time: int | None = None,
) -> None: ...

update_lookup_table

async def update_lookup_table(
    *,
    lookup_table_arn: str,
    description: str | None = None,
    table_body: str | None = None,
    query_id: str | None = None,
    kms_key_id: str | None = None,
) -> UpdateLookupTableOutput: ...

update_scheduled_query

async def update_scheduled_query(
    *,
    identifier: str,
    query_language: QueryLanguage,
    query_string: str,
    schedule_expression: str,
    execution_role_arn: str,
    description: str | None = None,
    log_group_identifiers: Sequence[str] | None = None,
    timezone: str | None = None,
    start_time_offset: int | None = None,
    end_time_offset: int | None = None,
    destination_configuration: DestinationConfiguration | None = None,
    schedule_start_time: int | None = None,
    schedule_end_time: int | None = None,
    state: ScheduledQueryState | None = None,
) -> UpdateScheduledQueryOutput: ...

Links

• Service guide
• Repository
• Issues
• Releases

Licensed under Apache-2.0.