Table of Contents
CloudWatchLogs.Client¶A low-level client representing Amazon CloudWatch Logs
You can use Amazon CloudWatch Logs to monitor, store, and access your log files from EC2 instances, CloudTrail, and other sources. You can then retrieve the associated log data from CloudWatch Logs using the CloudWatch console. Alternatively, you can use CloudWatch Logs commands in the Amazon Web Services CLI, CloudWatch Logs API, or CloudWatch Logs SDK.
You can use CloudWatch Logs to:
import boto3
client = boto3.client('logs')
These are the available methods:
associate_kms_key()can_paginate()cancel_export_task()close()create_export_task()create_log_group()create_log_stream()delete_data_protection_policy()delete_destination()delete_log_group()delete_log_stream()delete_metric_filter()delete_query_definition()delete_resource_policy()delete_retention_policy()delete_subscription_filter()describe_destinations()describe_export_tasks()describe_log_groups()describe_log_streams()describe_metric_filters()describe_queries()describe_query_definitions()describe_resource_policies()describe_subscription_filters()disassociate_kms_key()filter_log_events()get_data_protection_policy()get_log_events()get_log_group_fields()get_log_record()get_paginator()get_query_results()get_waiter()list_tags_for_resource()list_tags_log_group()put_data_protection_policy()put_destination()put_destination_policy()put_log_events()put_metric_filter()put_query_definition()put_resource_policy()put_retention_policy()put_subscription_filter()start_query()stop_query()tag_log_group()tag_resource()test_metric_filter()untag_log_group()untag_resource()associate_kms_key(**kwargs)¶Associates the specified KMS key with the specified log group.
Associating a KMS key with a log group overrides any existing associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS keyis still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
Warning
CloudWatch Logs supports only symmetric KMS keys. Do not use an associate an asymmetric KMS key with your log group. For more information, see Using Symmetric and Asymmetric Keys.
It can take up to 5 minutes for this operation to take effect.
If you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled, you receive an InvalidParameterException error.
See also: AWS API Documentation
Request Syntax
response = client.associate_kms_key(
logGroupName='string',
kmsKeyId='string'
)
[REQUIRED]
The name of the log group.
[REQUIRED]
The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. This must be a symmetric KMS key. For more information, see Amazon Resource Names and Using Symmetric and Asymmetric Keys.
None
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.OperationAbortedExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.cancel_export_task(**kwargs)¶Cancels the specified export task.
The task must be in the PENDING or RUNNING state.
See also: AWS API Documentation
Request Syntax
response = client.cancel_export_task(
taskId='string'
)
[REQUIRED]
The ID of the export task.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.InvalidOperationExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptionclose()¶Closes underlying endpoint connections.
create_export_task(**kwargs)¶Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket. When you perform a CreateExportTask operation, you must use credentials that have permission to write to the S3 bucket that you specify as the destination.
Exporting log data to S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported.
Exporting to S3 buckets that are encrypted with AES-256 is supported.
This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active ( RUNNING or PENDING ) export task at a time. To cancel an export task, use CancelExportTask.
You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate log data for each export task, specify a prefix to be used as the Amazon S3 key prefix for all exported objects.
Note
Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log field data by using Linux utilities.
See also: AWS API Documentation
Request Syntax
response = client.create_export_task(
taskName='string',
logGroupName='string',
logStreamNamePrefix='string',
fromTime=123,
to=123,
destination='string',
destinationPrefix='string'
)
[REQUIRED]
The name of the log group.
[REQUIRED]
The start time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC . Events with a timestamp earlier than this time are not exported.
[REQUIRED]
The end time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC . Events with a timestamp later than this time are not exported.
You must specify a time that is not earlier than when this log group was created.
[REQUIRED]
The name of S3 bucket for the exported log data. The bucket must be in the same Amazon Web Services Region.
exportedlogs .dict
Response Syntax
{
'taskId': 'string'
}
Response Structure
(dict) --
taskId (string) --
The ID of the export task.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.LimitExceededExceptionCloudWatchLogs.Client.exceptions.OperationAbortedExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.ResourceAlreadyExistsExceptioncreate_log_group(**kwargs)¶Creates a log group with the specified name. You can create up to 20,000 log groups per account.
You must use the following guidelines when naming a log group:
When you create a log group, by default the log events in the log group do not expire. To set a retention policy so that events expire and are deleted after a specified time, use PutRetentionPolicy.
If you associate an KMS key with the log group, ingested data is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
If you attempt to associate a KMS key with the log group but the KMS keydoes not exist or the KMS key is disabled, you receive an InvalidParameterException error.
Warning
CloudWatch Logs supports only symmetric KMS keys. Do not associate an asymmetric KMS key with your log group. For more information, see Using Symmetric and Asymmetric Keys.
See also: AWS API Documentation
Request Syntax
response = client.create_log_group(
logGroupName='string',
kmsKeyId='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The name of the log group.
The key-value pairs to use for the tags.
CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the aws:Resource/key-name or aws:TagKeys condition keys. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.
None
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ResourceAlreadyExistsExceptionCloudWatchLogs.Client.exceptions.LimitExceededExceptionCloudWatchLogs.Client.exceptions.OperationAbortedExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptioncreate_log_stream(**kwargs)¶Creates a log stream for the specified log group. A log stream is a sequence of log events that originate from a single source, such as an application instance or a resource that is being monitored.
There is no limit on the number of log streams that you can create for a log group. There is a limit of 50 TPS on CreateLogStream operations, after which transactions are throttled.
You must use the following guidelines when naming a log stream:
See also: AWS API Documentation
Request Syntax
response = client.create_log_stream(
logGroupName='string',
logStreamName='string'
)
[REQUIRED]
The name of the log group.
[REQUIRED]
The name of the log stream.
None
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ResourceAlreadyExistsExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptiondelete_data_protection_policy(**kwargs)¶Deletes the data protection policy from the specified log group.
For more information about data protection policies, see PutDataProtectionPolicy.
See also: AWS API Documentation
Request Syntax
response = client.delete_data_protection_policy(
logGroupIdentifier='string'
)
[REQUIRED]
The name or ARN of the log group that you want to delete the data protection policy for.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.OperationAbortedExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptiondelete_destination(**kwargs)¶Deletes the specified destination, and eventually disables all the subscription filters that publish to it. This operation does not delete the physical resource encapsulated by the destination.
See also: AWS API Documentation
Request Syntax
response = client.delete_destination(
destinationName='string'
)
[REQUIRED]
The name of the destination.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.OperationAbortedExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptiondelete_log_group(**kwargs)¶Deletes the specified log group and permanently deletes all the archived log events associated with the log group.
See also: AWS API Documentation
Request Syntax
response = client.delete_log_group(
logGroupName='string'
)
[REQUIRED]
The name of the log group.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.OperationAbortedExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptiondelete_log_stream(**kwargs)¶Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.
See also: AWS API Documentation
Request Syntax
response = client.delete_log_stream(
logGroupName='string',
logStreamName='string'
)
[REQUIRED]
The name of the log group.
[REQUIRED]
The name of the log stream.
None
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.OperationAbortedExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptiondelete_metric_filter(**kwargs)¶Deletes the specified metric filter.
See also: AWS API Documentation
Request Syntax
response = client.delete_metric_filter(
logGroupName='string',
filterName='string'
)
[REQUIRED]
The name of the log group.
[REQUIRED]
The name of the metric filter.
None
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.OperationAbortedExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptiondelete_query_definition(**kwargs)¶Deletes a saved CloudWatch Logs Insights query definition. A query definition contains details about a saved CloudWatch Logs Insights query.
Each DeleteQueryDefinition operation can delete one query definition.
You must have the logs:DeleteQueryDefinition permission to be able to perform this operation.
See also: AWS API Documentation
Request Syntax
response = client.delete_query_definition(
queryDefinitionId='string'
)
[REQUIRED]
The ID of the query definition that you want to delete. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query definitions.
{
'success': True|False
}
Response Structure
A value of TRUE indicates that the operation succeeded. FALSE indicates that the operation failed.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptiondelete_resource_policy(**kwargs)¶Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account.
See also: AWS API Documentation
Request Syntax
response = client.delete_resource_policy(
policyName='string'
)
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptiondelete_retention_policy(**kwargs)¶Deletes the specified retention policy.
Log events do not expire if they belong to log groups without a retention policy.
See also: AWS API Documentation
Request Syntax
response = client.delete_retention_policy(
logGroupName='string'
)
[REQUIRED]
The name of the log group.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.OperationAbortedExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptiondelete_subscription_filter(**kwargs)¶Deletes the specified subscription filter.
See also: AWS API Documentation
Request Syntax
response = client.delete_subscription_filter(
logGroupName='string',
filterName='string'
)
[REQUIRED]
The name of the log group.
[REQUIRED]
The name of the subscription filter.
None
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.OperationAbortedExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptiondescribe_destinations(**kwargs)¶Lists all your destinations. The results are ASCII-sorted by destination name.
See also: AWS API Documentation
Request Syntax
response = client.describe_destinations(
DestinationNamePrefix='string',
nextToken='string',
limit=123
)
dict
Response Syntax
{
'destinations': [
{
'destinationName': 'string',
'targetArn': 'string',
'roleArn': 'string',
'accessPolicy': 'string',
'arn': 'string',
'creationTime': 123
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
destinations (list) --
The destinations.
(dict) --
Represents a cross-account destination that receives subscription log events.
destinationName (string) --
The name of the destination.
targetArn (string) --
The Amazon Resource Name (ARN) of the physical target where the log events are delivered (for example, a Kinesis stream).
roleArn (string) --
A role for impersonation, used when delivering log events to the target.
accessPolicy (string) --
An IAM policy document that governs which Amazon Web Services accounts can create subscription filters against this destination.
arn (string) --
The ARN of this destination.
creationTime (integer) --
The creation time of the destination, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
nextToken (string) --
The token for the next set of items to return. The token expires after 24 hours.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptiondescribe_export_tasks(**kwargs)¶Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.
See also: AWS API Documentation
Request Syntax
response = client.describe_export_tasks(
taskId='string',
statusCode='CANCELLED'|'COMPLETED'|'FAILED'|'PENDING'|'PENDING_CANCEL'|'RUNNING',
nextToken='string',
limit=123
)
dict
Response Syntax
{
'exportTasks': [
{
'taskId': 'string',
'taskName': 'string',
'logGroupName': 'string',
'from': 123,
'to': 123,
'destination': 'string',
'destinationPrefix': 'string',
'status': {
'code': 'CANCELLED'|'COMPLETED'|'FAILED'|'PENDING'|'PENDING_CANCEL'|'RUNNING',
'message': 'string'
},
'executionInfo': {
'creationTime': 123,
'completionTime': 123
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
exportTasks (list) --
The export tasks.
(dict) --
Represents an export task.
taskId (string) --
The ID of the export task.
taskName (string) --
The name of the export task.
logGroupName (string) --
The name of the log group from which logs data was exported.
from (integer) --
The start time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC . Events with a timestamp before this time are not exported.
to (integer) --
The end time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC . Events with a timestamp later than this time are not exported.
destination (string) --
The name of the S3 bucket to which the log data was exported.
destinationPrefix (string) --
The prefix that was used as the start of Amazon S3 key for every object exported.
status (dict) --
The status of the export task.
code (string) --
The status code of the export task.
message (string) --
The status message related to the status code.
executionInfo (dict) --
Execution information about the export task.
creationTime (integer) --
The creation time of the export task, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC .
completionTime (integer) --
The completion time of the export task, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC .
nextToken (string) --
The token for the next set of items to return. The token expires after 24 hours.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptiondescribe_log_groups(**kwargs)¶Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.
CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups action by using the aws:ResourceTag/key-name condition key. Other CloudWatch Logs actions do support the use of the aws:ResourceTag/key-name condition key to control access. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
See also: AWS API Documentation
Request Syntax
response = client.describe_log_groups(
accountIdentifiers=[
'string',
],
logGroupNamePrefix='string',
logGroupNamePattern='string',
nextToken='string',
limit=123,
includeLinkedAccounts=True|False
)
When includeLinkedAccounts is set to True , use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.
The prefix to match.
Note
logGroupNamePrefix and logGroupNamePattern are mutually exclusive. Only one of these parameters can be passed.
If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search. For example, if you specify Foo , log groups named FooBar , aws/Foo , and GroupFoo would match, but foo , F/o/o and Froo would not match.
Note
logGroupNamePattern and logGroupNamePrefix are mutually exclusive. Only one of these parameters can be passed.
If you are using a monitoring account, set this to True to have the operation return log groups in the accounts listed in accountIdentifiers .
If this parameter is set to true and accountIdentifiers contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.
Note
If you specify includeLinkedAccounts in your request, then metricFilterCount , retentionInDays , and storedBytes are not included in the response.
dict
Response Syntax
{
'logGroups': [
{
'logGroupName': 'string',
'creationTime': 123,
'retentionInDays': 123,
'metricFilterCount': 123,
'arn': 'string',
'storedBytes': 123,
'kmsKeyId': 'string',
'dataProtectionStatus': 'ACTIVATED'|'DELETED'|'ARCHIVED'|'DISABLED'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
logGroups (list) --
The log groups.
If the retentionInDays value is not included for a log group, then that log group's events do not expire.
(dict) --
Represents a log group.
logGroupName (string) --
The name of the log group.
creationTime (integer) --
The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
retentionInDays (integer) --
The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 2192, 2557, 2922, 3288, and 3653.
To set a log group so that its log events do not expire, use DeleteRetentionPolicy.
metricFilterCount (integer) --
The number of metric filters.
arn (string) --
The Amazon Resource Name (ARN) of the log group.
storedBytes (integer) --
The number of bytes stored.
kmsKeyId (string) --
The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data.
dataProtectionStatus (string) --
Displays whether this log group has a protection policy, or whether it had one in the past. For more information, see PutDataProtectionPolicy.
nextToken (string) --
The token for the next set of items to return. The token expires after 24 hours.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptiondescribe_log_streams(**kwargs)¶Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.
This operation has a limit of five transactions per second, after which transactions are throttled.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
See also: AWS API Documentation
Request Syntax
response = client.describe_log_streams(
logGroupName='string',
logGroupIdentifier='string',
logStreamNamePrefix='string',
orderBy='LogStreamName'|'LastEventTime',
descending=True|False,
nextToken='string',
limit=123
)
[REQUIRED]
The name of the log group.
Note
If you specify values for both logGroupName and logGroupIdentifier , the action returns an InvalidParameterException error.
Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.
If you specify values for both logGroupName and logGroupIdentifier , the action returns an InvalidParameterException error.
The prefix to match.
If orderBy is LastEventTime , you cannot specify this parameter.
If the value is LogStreamName , the results are ordered by log stream name. If the value is LastEventTime , the results are ordered by the event time. The default value is LogStreamName .
If you order the results by event time, you cannot specify the logStreamNamePrefix parameter.
lastEventTimestamprepresents the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds afterJan 1, 1970 00:00:00 UTC.lastEventTimestampupdates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but in rare situations might take longer.
dict
Response Syntax
{
'logStreams': [
{
'logStreamName': 'string',
'creationTime': 123,
'firstEventTimestamp': 123,
'lastEventTimestamp': 123,
'lastIngestionTime': 123,
'uploadSequenceToken': 'string',
'arn': 'string',
'storedBytes': 123
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
logStreams (list) --
The log streams.
(dict) --
Represents a log stream, which is a sequence of log events from a single emitter of logs.
logStreamName (string) --
The name of the log stream.
creationTime (integer) --
The creation time of the stream, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC .
firstEventTimestamp (integer) --
The time of the first event, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC .
lastEventTimestamp (integer) --
The time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC . The lastEventTime value updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but in rare situations might take longer.
lastIngestionTime (integer) --
The ingestion time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC .
uploadSequenceToken (string) --
The sequence token.
arn (string) --
The Amazon Resource Name (ARN) of the log stream.
storedBytes (integer) --
The number of bytes stored.
Important: As of June 17, 2019, this parameter is no longer supported for log streams, and is always reported as zero. This change applies only to log streams. The
storedBytesparameter for log groups is not affected.
nextToken (string) --
The token for the next set of items to return. The token expires after 24 hours.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptiondescribe_metric_filters(**kwargs)¶Lists the specified metric filters. You can list all of the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.
See also: AWS API Documentation
Request Syntax
response = client.describe_metric_filters(
logGroupName='string',
filterNamePrefix='string',
nextToken='string',
limit=123,
metricName='string',
metricNamespace='string'
)
logGroupName parameter in your request.metricNamespace parameter.metricName parameter.dict
Response Syntax
{
'metricFilters': [
{
'filterName': 'string',
'filterPattern': 'string',
'metricTransformations': [
{
'metricName': 'string',
'metricNamespace': 'string',
'metricValue': 'string',
'defaultValue': 123.0,
'dimensions': {
'string': 'string'
},
'unit': 'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Count'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'|'None'
},
],
'creationTime': 123,
'logGroupName': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
metricFilters (list) --
The metric filters.
(dict) --
Metric filters express how CloudWatch Logs would extract metric observations from ingested log events and transform them into metric data in a CloudWatch metric.
filterName (string) --
The name of the metric filter.
filterPattern (string) --
A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event can contain timestamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.
metricTransformations (list) --
The metric transformations.
(dict) --
Indicates how to transform ingested log events to metric data in a CloudWatch metric.
metricName (string) --
The name of the CloudWatch metric.
metricNamespace (string) --
A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see Namespaces.
metricValue (string) --
The value to publish to the CloudWatch metric when a filter pattern matches a log event.
defaultValue (float) --
(Optional) The value to emit when a filter pattern does not match a log event. This value can be null.
dimensions (dict) --
The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions.
Warning
Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.
CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges.
You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.
unit (string) --
The unit to assign to the metric. If you omit this, the unit is set as None .
creationTime (integer) --
The creation time of the metric filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC .
logGroupName (string) --
The name of the log group.
nextToken (string) --
The token for the next set of items to return. The token expires after 24 hours.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptiondescribe_queries(**kwargs)¶Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this account. You can request all queries or limit it to queries of a specific log group or queries with a certain status.
See also: AWS API Documentation
Request Syntax
response = client.describe_queries(
logGroupName='string',
status='Scheduled'|'Running'|'Complete'|'Failed'|'Cancelled'|'Timeout'|'Unknown',
maxResults=123,
nextToken='string'
)
Cancelled , Complete , Failed , Running , and Scheduled .dict
Response Syntax
{
'queries': [
{
'queryId': 'string',
'queryString': 'string',
'status': 'Scheduled'|'Running'|'Complete'|'Failed'|'Cancelled'|'Timeout'|'Unknown',
'createTime': 123,
'logGroupName': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
queries (list) --
The list of queries that match the request.
(dict) --
Information about one CloudWatch Logs Insights query that matches the request in a DescribeQueries operation.
queryId (string) --
The unique ID number of this query.
queryString (string) --
The query string used in this query.
status (string) --
The status of this query. Possible values are Cancelled , Complete , Failed , Running , Scheduled , and Unknown .
createTime (integer) --
The date and time that this query was created.
logGroupName (string) --
The name of the log group scanned by this query.
nextToken (string) --
The token for the next set of items to return. The token expires after 24 hours.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptiondescribe_query_definitions(**kwargs)¶This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions.
You can use the queryDefinitionNamePrefix parameter to limit the results to only the query definitions that have names that start with a certain string.
See also: AWS API Documentation
Request Syntax
response = client.describe_query_definitions(
queryDefinitionNamePrefix='string',
maxResults=123,
nextToken='string'
)
dict
Response Syntax
{
'queryDefinitions': [
{
'queryDefinitionId': 'string',
'name': 'string',
'queryString': 'string',
'lastModified': 123,
'logGroupNames': [
'string',
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
queryDefinitions (list) --
The list of query definitions that match your request.
(dict) --
This structure contains details about a saved CloudWatch Logs Insights query definition.
queryDefinitionId (string) --
The unique ID of the query definition.
name (string) --
The name of the query definition.
queryString (string) --
The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax.
lastModified (integer) --
The date that the query definition was most recently modified.
logGroupNames (list) --
If this query definition contains a list of log groups that it is limited to, that list appears here.
nextToken (string) --
The token for the next set of items to return. The token expires after 24 hours.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptiondescribe_resource_policies(**kwargs)¶Lists the resource policies in this account.
See also: AWS API Documentation
Request Syntax
response = client.describe_resource_policies(
nextToken='string',
limit=123
)
dict
Response Syntax
{
'resourcePolicies': [
{
'policyName': 'string',
'policyDocument': 'string',
'lastUpdatedTime': 123
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
resourcePolicies (list) --
The resource policies that exist in this account.
(dict) --
A policy enabling one or more entities to put logs to a log group in this account.
policyName (string) --
The name of the resource policy.
policyDocument (string) --
The details of the policy.
lastUpdatedTime (integer) --
Timestamp showing when this policy was last updated, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC .
nextToken (string) --
The token for the next set of items to return. The token expires after 24 hours.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptiondescribe_subscription_filters(**kwargs)¶Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix. The results are ASCII-sorted by filter name.
See also: AWS API Documentation
Request Syntax
response = client.describe_subscription_filters(
logGroupName='string',
filterNamePrefix='string',
nextToken='string',
limit=123
)
[REQUIRED]
The name of the log group.
dict
Response Syntax
{
'subscriptionFilters': [
{
'filterName': 'string',
'logGroupName': 'string',
'filterPattern': 'string',
'destinationArn': 'string',
'roleArn': 'string',
'distribution': 'Random'|'ByLogStream',
'creationTime': 123
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
subscriptionFilters (list) --
The subscription filters.
(dict) --
Represents a subscription filter.
filterName (string) --
The name of the subscription filter.
logGroupName (string) --
The name of the log group.
filterPattern (string) --
A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event can contain timestamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.
destinationArn (string) --
The Amazon Resource Name (ARN) of the destination.
roleArn (string) --
distribution (string) --
The method used to distribute log data to the destination, which can be either random or grouped by log stream.
creationTime (integer) --
The creation time of the subscription filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC .
nextToken (string) --
The token for the next set of items to return. The token expires after 24 hours.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptiondisassociate_kms_key(**kwargs)¶Disassociates the associated KMS key from the specified log group.
After the KMS key is disassociated from the log group, CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and CloudWatch Logs requires permissions for the KMS key whenever the encrypted data is requested.
Note that it can take up to 5 minutes for this operation to take effect.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_kms_key(
logGroupName='string'
)
[REQUIRED]
The name of the log group.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.OperationAbortedExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptionfilter_log_events(**kwargs)¶Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.
You must have the logs;FilterLogEvents permission to perform this operation.
By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events) or all the events found within the specified time range. If the results include a token, that means there are more log events available. You can get additional results by specifying the token in a subsequent call. This operation can return empty results while there are more log events available through the token.
The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch Logs, and the ID of the PutLogEvents request.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
See also: AWS API Documentation
Request Syntax
response = client.filter_log_events(
logGroupName='string',
logGroupIdentifier='string',
logStreamNames=[
'string',
],
logStreamNamePrefix='string',
startTime=123,
endTime=123,
filterPattern='string',
nextToken='string',
limit=123,
interleaved=True|False,
unmask=True|False
)
[REQUIRED]
The name of the log group to search.
Note
If you specify values for both logGroupName and logGroupIdentifier , the action returns an InvalidParameterException error.
Specify either the name or ARN of the log group to view log events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.
If you specify values for both logGroupName and logGroupIdentifier , the action returns an InvalidParameterException error.
Filters the results to only logs from the log streams in this list.
If you specify a value for both logStreamNamePrefix and logStreamNames , the action returns an InvalidParameterException error.
Filters the results to include only events from log streams that have names starting with this prefix.
If you specify a value for both logStreamNamePrefix and logStreamNames , but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames , the action returns an InvalidParameterException error.
Jan 1, 1970 00:00:00 UTC . Events with a timestamp before this time are not returned.Jan 1, 1970 00:00:00 UTC . Events with a timestamp later than this time are not returned.The filter pattern to use. For more information, see Filter and Pattern Syntax.
If not provided, all the events are matched.
If the value is true, the operation attempts to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on.
Important As of June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.
Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false .
To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.
dict
Response Syntax
{
'events': [
{
'logStreamName': 'string',
'timestamp': 123,
'message': 'string',
'ingestionTime': 123,
'eventId': 'string'
},
],
'searchedLogStreams': [
{
'logStreamName': 'string',
'searchedCompletely': True|False
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
events (list) --
The matched events.
(dict) --
Represents a matched event.
logStreamName (string) --
The name of the log stream to which this event belongs.
timestamp (integer) --
The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC .
message (string) --
The data contained in the log event.
ingestionTime (integer) --
The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC .
eventId (string) --
The ID of the event.
searchedLogStreams (list) --
Important As of May 15, 2020, this parameter is no longer supported. This parameter returns an empty list.
Indicates which log streams have been searched and whether each has been searched completely.
(dict) --
Represents the search status of a log stream.
logStreamName (string) --
The name of the log stream.
searchedCompletely (boolean) --
Indicates whether all the events in this log stream were searched.
nextToken (string) --
The token to use when requesting the next set of items. The token expires after 24 hours.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptionget_data_protection_policy(**kwargs)¶Returns information about a log group data protection policy.
See also: AWS API Documentation
Request Syntax
response = client.get_data_protection_policy(
logGroupIdentifier='string'
)
[REQUIRED]
The name or ARN of the log group that contains the data protection policy that you want to see.
{
'logGroupIdentifier': 'string',
'policyDocument': 'string',
'lastUpdatedTime': 123
}
Response Structure
The log group name or ARN that you specified in your request.
The data protection policy document for this log group.
The date and time that this policy was most recently updated.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.OperationAbortedExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptionget_log_events(**kwargs)¶Lists log events from the specified log stream. You can list all of the log events or filter using a time range.
By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call. This operation can return empty results while there are more log events available through the token.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
See also: AWS API Documentation
Request Syntax
response = client.get_log_events(
logGroupName='string',
logGroupIdentifier='string',
logStreamName='string',
startTime=123,
endTime=123,
nextToken='string',
limit=123,
startFromHead=True|False,
unmask=True|False
)
[REQUIRED]
The name of the log group.
Note
If you specify values for both logGroupName and logGroupIdentifier , the action returns an InvalidParameterException error.
Specify either the name or ARN of the log group to view events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.
If you specify values for both logGroupName and logGroupIdentifier , the action returns an InvalidParameterException error.
[REQUIRED]
The name of the log stream.
Jan 1, 1970 00:00:00 UTC . Events with a timestamp equal to this time or later than this time are included. Events with a timestamp earlier than this time are not included.Jan 1, 1970 00:00:00 UTC . Events with a timestamp equal to or later than this time are not included.If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.
If you are using a previous nextForwardToken value as the nextToken in this operation, you must specify true for startFromHead .
Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false .
To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.
dict
Response Syntax
{
'events': [
{
'timestamp': 123,
'message': 'string',
'ingestionTime': 123
},
],
'nextForwardToken': 'string',
'nextBackwardToken': 'string'
}
Response Structure
(dict) --
events (list) --
The events.
(dict) --
Represents a log event.
timestamp (integer) --
The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC .
message (string) --
The data contained in the log event.
ingestionTime (integer) --
The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC .
nextForwardToken (string) --
The token for the next set of items in the forward direction. The token expires after 24 hours. If you have reached the end of the stream, it returns the same token you passed in.
nextBackwardToken (string) --
The token for the next set of items in the backward direction. The token expires after 24 hours. This token is not null. If you have reached the end of the stream, it returns the same token you passed in.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptionget_log_group_fields(**kwargs)¶Returns a list of the fields that are included in log events in the specified log group. Includes the percentage of log events that contain each field. The search is limited to a time period that you specify.
In the results, fields that start with @ are fields generated by CloudWatch Logs. For example, @timestamp is the timestamp of each log event. For more information about the fields that are generated by CloudWatch logs, see Supported Logs and Discovered Fields.
The response results are sorted by the frequency percentage, starting with the highest percentage.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
See also: AWS API Documentation
Request Syntax
response = client.get_log_group_fields(
logGroupName='string',
time=123,
logGroupIdentifier='string'
)
[REQUIRED]
The name of the log group to search.
If you specify values for both logGroupName and logGroupIdentifier , the action returns an InvalidParameterException error.
The time to set as the center of the query. If you specify time , the 15 minutes before this time are queries. If you omit time , the 8 minutes before and 8 minutes after this time are searched.
The time value is specified as epoch time, which is the number of seconds since January 1, 1970, 00:00:00 UTC .
Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must specify the ARN.
If you specify values for both logGroupName and logGroupIdentifier , the action returns an InvalidParameterException error.
dict
Response Syntax
{
'logGroupFields': [
{
'name': 'string',
'percent': 123
},
]
}
Response Structure
(dict) --
logGroupFields (list) --
The array of fields found in the query. Each object in the array contains the name of the field, along with the percentage of time it appeared in the log events that were queried.
(dict) --
The fields contained in log events found by a GetLogGroupFields operation, along with the percentage of queried log events in which each field appears.
name (string) --
The name of a log field.
percent (integer) --
The percentage of log events queried that contained the field.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.LimitExceededExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptionget_log_record(**kwargs)¶Retrieves all of the fields and values of a single log event. All fields are retrieved, even if the original query that produced the logRecordPointer retrieved only a subset of fields. Fields are returned as field name/field value pairs.
The full unparsed log event is returned within @message .
See also: AWS API Documentation
Request Syntax
response = client.get_log_record(
logRecordPointer='string',
unmask=True|False
)
[REQUIRED]
The pointer corresponding to the log event record you want to retrieve. You get this from the response of a GetQueryResults operation. In that response, the value of the @ptr field for a log event is the value to use as logRecordPointer to retrieve that complete log event record.
Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false .
To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.
dict
Response Syntax
{
'logRecord': {
'string': 'string'
}
}
Response Structure
(dict) --
logRecord (dict) --
The requested log event, as a JSON string.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.LimitExceededExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_query_results(**kwargs)¶Returns the results from the specified query.
Only the fields requested in the query are returned, along with a @ptr field, which is the identifier for the log record. You can use the value of @ptr in a GetLogRecord operation to get the full log record.
GetQueryResultsdoes not start running a query. To run a query, use StartQuery.
If the value of the Status field in the output is Running , this operation returns only partial results. If you see a value of Scheduled or Running for the status, you can retry the operation later to see the final results.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start queries in linked source accounts. For more information, see CloudWatch cross-account observability.
See also: AWS API Documentation
Request Syntax
response = client.get_query_results(
queryId='string'
)
[REQUIRED]
The ID number of the query.
{
'results': [
[
{
'field': 'string',
'value': 'string'
},
],
],
'statistics': {
'recordsMatched': 123.0,
'recordsScanned': 123.0,
'bytesScanned': 123.0
},
'status': 'Scheduled'|'Running'|'Complete'|'Failed'|'Cancelled'|'Timeout'|'Unknown'
}
Response Structure
The log events that matched the query criteria during the most recent time it ran.
The results value is an array of arrays. Each log event is one object in the top-level array. Each of these log event objects is an array of field / value pairs.
Contains one field from one log event returned by a CloudWatch Logs Insights query, along with the value of that field.
For more information about the fields that are generated by CloudWatch logs, see Supported Logs and Discovered Fields.
The log event field.
The value of this field.
Includes the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the log events that were scanned. These values reflect the full raw results of the query.
The number of log events that matched the query string.
The total number of log events scanned during the query.
The total number of bytes in the log events scanned during the query.
The status of the most recent running of the query. Possible values are Cancelled , Complete , Failed , Running , Scheduled , Timeout , and Unknown .
Queries time out after 15 minutes of runtime. To avoid having your queries time out, reduce the time range being searched or partition your query into a number of queries.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
Displays the tags associated with a CloudWatch Logs resource. Currently, log groups and destinations support tagging.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
The ARN of the resource that you want to view tags for.
The ARN format of a log group is arn:aws:logs:Region:account-id:log-group:log-group-name
The ARN format of a destination is arn:aws:logs:Region:account-id:destination:destination-name
For more information about ARN format, see CloudWatch Logs resources and operations.
{
'tags': {
'string': 'string'
}
}
Response Structure
The list of tags associated with the requested resource.>
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptionWarning
The ListTagsLogGroup operation is on the path to deprecation. We recommend that you use ListTagsForResource instead.
Lists the tags for the specified log group.
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_log_group(
logGroupName='string'
)
[REQUIRED]
The name of the log group.
{
'tags': {
'string': 'string'
}
}
Response Structure
The tags for the log group.
Exceptions
CloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptionput_data_protection_policy(**kwargs)¶Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data.
Warning
Sensitive data is detected and masked when it is ingested into the log group. When you set a data protection policy, log events ingested into the log group before that time are not masked.
By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the logs:Unmask permission can use a GetLogEvents or FilterLogEvents operation with the unmask parameter set to true to view the unmasked log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with the unmask query command.
For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.
See also: AWS API Documentation
Request Syntax
response = client.put_data_protection_policy(
logGroupIdentifier='string',
policyDocument='string'
)
[REQUIRED]
Specify either the log group name or log group ARN.
[REQUIRED]
Specify the data protection policy, in JSON.
This policy must include two JSON blocks:
DataIdentifer array and an Operation property with an Audit action. The DataIdentifer array lists the types of sensitive data that you want to mask. For more information about the available options, see Types of data that you can mask. The Operation property with an Audit action is required to find the sensitive data terms. This Audit action must contain a FindingsDestination object. You can optionally use that FindingsDestination object to list one or more destinations to send audit findings to. If you specify destinations such as log groups, Kinesis Data Firehose streams, and S3 buckets, they must already exist.DataIdentifer array and an Operation property with an Deidentify action. The DataIdentifer array must exactly match the DataIdentifer array in the first block of the policy. The Operation property with the Deidentify action is what actually masks the data, and it must contain the "MaskConfig": {} object. The "MaskConfig": {} object must be empty.For an example data protection policy, see the Examples section on this page.
Warning
The contents of two DataIdentifer arrays must match exactly.
dict
Response Syntax
{
'logGroupIdentifier': 'string',
'policyDocument': 'string',
'lastUpdatedTime': 123
}
Response Structure
(dict) --
logGroupIdentifier (string) --
The log group name or ARN that you specified in your request.
policyDocument (string) --
The data protection policy used for this log group.
lastUpdatedTime (integer) --
The date and time that this policy was most recently updated.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.LimitExceededExceptionCloudWatchLogs.Client.exceptions.OperationAbortedExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptionput_destination(**kwargs)¶Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions.
A destination encapsulates a physical resource (such as an Amazon Kinesis stream). With a destination, you can subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents.
Through an access policy, a destination controls what is written to it. By default, PutDestination does not set any access policy with the destination, which means a cross-account user cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination .
To perform a PutDestination operation, you must also have the iam:PassRole permission.
See also: AWS API Documentation
Request Syntax
response = client.put_destination(
destinationName='string',
targetArn='string',
roleArn='string',
tags={
'string': 'string'
}
)
[REQUIRED]
A name for the destination.
[REQUIRED]
The ARN of an Amazon Kinesis stream to which to deliver matching log events.
[REQUIRED]
The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon Kinesis PutRecord operation on the destination stream.
An optional list of key-value pairs to associate with the resource.
For more information about tagging, see Tagging Amazon Web Services resources
dict
Response Syntax
{
'destination': {
'destinationName': 'string',
'targetArn': 'string',
'roleArn': 'string',
'accessPolicy': 'string',
'arn': 'string',
'creationTime': 123
}
}
Response Structure
(dict) --
destination (dict) --
The destination.
destinationName (string) --
The name of the destination.
targetArn (string) --
The Amazon Resource Name (ARN) of the physical target where the log events are delivered (for example, a Kinesis stream).
roleArn (string) --
A role for impersonation, used when delivering log events to the target.
accessPolicy (string) --
An IAM policy document that governs which Amazon Web Services accounts can create subscription filters against this destination.
arn (string) --
The ARN of this destination.
creationTime (integer) --
The creation time of the destination, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.OperationAbortedExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptionput_destination_policy(**kwargs)¶Creates or updates an access policy associated with an existing destination. An access policy is an IAM policy document that is used to authorize claims to register a subscription filter against a given destination.
If multiple Amazon Web Services accounts are sending logs to this destination, each sender account must be listed separately in the policy. The policy does not support specifying * as the Principal or the use of the aws:PrincipalOrgId global key.
See also: AWS API Documentation
Request Syntax
response = client.put_destination_policy(
destinationName='string',
accessPolicy='string',
forceUpdate=True|False
)
[REQUIRED]
A name for an existing destination.
[REQUIRED]
An IAM policy document that authorizes cross-account users to deliver their log events to the associated destination. This can be up to 5120 bytes.
Specify true if you are updating an existing destination policy to grant permission to an organization ID instead of granting permission to individual AWS accounts. Before you update a destination policy this way, you must first update the subscription filters in the accounts that send logs to this destination. If you do not, the subscription filters might stop working. By specifying true for forceUpdate , you are affirming that you have already updated the subscription filters. For more information, see Updating an existing cross-account subscription
If you omit this parameter, the default of false is used.
None
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.OperationAbortedExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptionput_log_events(**kwargs)¶Uploads a batch of log events to the specified log stream.
You must include the sequence token obtained from the response of the previous call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token in the expectedSequenceToken field from InvalidSequenceTokenException . If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken , both calls might be successful or one might be rejected.
The batch of events must satisfy the following constraints:
Jan 1, 1970 00:00:00 UTC . (In Amazon Web Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss . For example, 2017-09-15T13:45:30 .)If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is a non-valid Amazon Web Services access key ID or secret key.
See also: AWS API Documentation
Request Syntax
response = client.put_log_events(
logGroupName='string',
logStreamName='string',
logEvents=[
{
'timestamp': 123,
'message': 'string'
},
],
sequenceToken='string'
)
[REQUIRED]
The name of the log group.
[REQUIRED]
The name of the log stream.
[REQUIRED]
The log events.
Represents a log event, which is a record of activity that was recorded by the application or resource being monitored.
The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC .
The raw event message.
PutLogEvents call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token using DescribeLogStreams. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken , both calls might be successful or one might be rejected.dict
Response Syntax
{
'nextSequenceToken': 'string',
'rejectedLogEventsInfo': {
'tooNewLogEventStartIndex': 123,
'tooOldLogEventEndIndex': 123,
'expiredLogEventEndIndex': 123
}
}
Response Structure
(dict) --
nextSequenceToken (string) --
The next sequence token.
rejectedLogEventsInfo (dict) --
The rejected events.
tooNewLogEventStartIndex (integer) --
The log events that are too new.
tooOldLogEventEndIndex (integer) --
The log events that are dated too far in the past.
expiredLogEventEndIndex (integer) --
The expired log events.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.InvalidSequenceTokenExceptionCloudWatchLogs.Client.exceptions.DataAlreadyAcceptedExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptionCloudWatchLogs.Client.exceptions.UnrecognizedClientExceptionput_metric_filter(**kwargs)¶Creates or updates a metric filter and associates it with the specified log group. With metric filters, you can configure rules to extract metric data from log events ingested through PutLogEvents.
The maximum number of metric filters that can be associated with a log group is 100.
When you create a metric filter, you can also optionally assign a unit and dimensions to the metric that is created.
Warning
Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.
CloudWatch Logs disables a metric filter if it generates 1,000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges.
You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.
See also: AWS API Documentation
Request Syntax
response = client.put_metric_filter(
logGroupName='string',
filterName='string',
filterPattern='string',
metricTransformations=[
{
'metricName': 'string',
'metricNamespace': 'string',
'metricValue': 'string',
'defaultValue': 123.0,
'dimensions': {
'string': 'string'
},
'unit': 'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Count'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'|'None'
},
]
)
[REQUIRED]
The name of the log group.
[REQUIRED]
A name for the metric filter.
[REQUIRED]
A filter pattern for extracting metric data out of ingested log events.
[REQUIRED]
A collection of information that defines how metric data gets emitted.
Indicates how to transform ingested log events to metric data in a CloudWatch metric.
The name of the CloudWatch metric.
A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see Namespaces.
The value to publish to the CloudWatch metric when a filter pattern matches a log event.
(Optional) The value to emit when a filter pattern does not match a log event. This value can be null.
The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions.
Warning
Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.
CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges.
You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.
The unit to assign to the metric. If you omit this, the unit is set as None .
None
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.OperationAbortedExceptionCloudWatchLogs.Client.exceptions.LimitExceededExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptionput_query_definition(**kwargs)¶Creates or updates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with CloudWatch Logs Insights.
To update a query definition, specify its queryDefinitionId in your request. The values of name , queryString , and logGroupNames are changed to the values that you specify in your update operation. No current values are retained from the current query definition. For example, imagine updating a current query definition that includes log groups. If you don't specify the logGroupNames parameter in your update operation, the query definition changes to contain no log groups.
You must have the logs:PutQueryDefinition permission to be able to perform this operation.
See also: AWS API Documentation
Request Syntax
response = client.put_query_definition(
name='string',
queryDefinitionId='string',
logGroupNames=[
'string',
],
queryString='string'
)
[REQUIRED]
A name for the query definition. If you are saving numerous query definitions, we recommend that you name them. This way, you can find the ones you want by using the first part of the name as a filter in the queryDefinitionNamePrefix parameter of DescribeQueryDefinitions.
If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query definitions.
If you are creating a query definition, do not specify this parameter. CloudWatch generates a unique ID for the new query definition and include it in the response to this operation.
Use this parameter to include specific log groups as part of your query definition.
If you are updating a query definition and you omit this parameter, then the updated definition will contain no log groups.
[REQUIRED]
The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax.
dict
Response Syntax
{
'queryDefinitionId': 'string'
}
Response Structure
(dict) --
queryDefinitionId (string) --
The ID of the query definition.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.LimitExceededExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptionput_resource_policy(**kwargs)¶Creates or updates a resource policy allowing other Amazon Web Services services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
response = client.put_resource_policy(
policyName='string',
policyDocument='string'
)
Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string. This parameter is required.
The following example creates a resource policy enabling the Route 53 service to put DNS query logs in to the specified log group. Replace "logArn" with the ARN of your CloudWatch Logs resource, such as a log group or log stream.
CloudWatch Logs also supports aws:SourceArn and aws:SourceAccount condition context keys.
In the example resource policy, you would replace the value of SourceArn with the resource making the call from Route 53 to CloudWatch Logs. You would also replace the value of SourceAccount with the Amazon Web Services account ID making that call.
{ "Version": "2012-10-17", "Statement": [ { "Sid": "Route53LogsToCloudWatchLogs", "Effect": "Allow", "Principal": { "Service": [ "route53.amazonaws.com" ] }, "Action": "logs:PutLogEvents", "Resource": "logArn", "Condition": { "ArnLike": { "aws:SourceArn": "myRoute53ResourceArn" }, "StringEquals": { "aws:SourceAccount": "myAwsAccountId" } } } ] }
dict
Response Syntax
{
'resourcePolicy': {
'policyName': 'string',
'policyDocument': 'string',
'lastUpdatedTime': 123
}
}
Response Structure
(dict) --
resourcePolicy (dict) --
The new policy.
policyName (string) --
The name of the resource policy.
policyDocument (string) --
The details of the policy.
lastUpdatedTime (integer) --
Timestamp showing when this policy was last updated, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC .
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.LimitExceededExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptionput_retention_policy(**kwargs)¶Sets the retention of the specified log group. With a retention policy, you can configure the number of days for which to retain log events in the specified log group.
Note
CloudWatch Logs doesn’t immediately delete log events when they reach their retention setting. It typically takes up to 72 hours after that before log events are deleted, but in rare situations might take longer.
To illustrate, imagine that you change a log group to have a longer retention setting when it contains log events that are past the expiration date, but haven’t been deleted. Those log events will take up to 72 hours to be deleted after the new retention date is reached. To make sure that log data is deleted permanently, keep a log group at its lower retention setting until 72 hours after the previous retention period ends. Alternatively, wait to change the retention setting until you confirm that the earlier log events are deleted.
See also: AWS API Documentation
Request Syntax
response = client.put_retention_policy(
logGroupName='string',
retentionInDays=123
)
[REQUIRED]
The name of the log group.
[REQUIRED]
The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 2192, 2557, 2922, 3288, and 3653.
To set a log group so that its log events do not expire, use DeleteRetentionPolicy.
None
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.OperationAbortedExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptionput_subscription_filter(**kwargs)¶Creates or updates a subscription filter and associates it with the specified log group. With subscription filters, you can subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.
The following destinations are supported for subscription filters:
Each log group can have up to two subscription filters associated with it. If you are updating an existing filter, you must specify the correct name in filterName .
To perform a PutSubscriptionFilter operation, you must also have the iam:PassRole permission.
See also: AWS API Documentation
Request Syntax
response = client.put_subscription_filter(
logGroupName='string',
filterName='string',
filterPattern='string',
destinationArn='string',
roleArn='string',
distribution='Random'|'ByLogStream'
)
[REQUIRED]
The name of the log group.
[REQUIRED]
A name for the subscription filter. If you are updating an existing filter, you must specify the correct name in filterName . To find the name of the filter currently associated with a log group, use DescribeSubscriptionFilters.
[REQUIRED]
A filter pattern for subscribing to a filtered stream of log events.
[REQUIRED]
The ARN of the destination to deliver matching log events to. Currently, the supported destinations are:
None
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.OperationAbortedExceptionCloudWatchLogs.Client.exceptions.LimitExceededExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptionstart_query(**kwargs)¶Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query and the query string to use.
For more information, see CloudWatch Logs Insights Query Syntax.
Queries time out after 15 minutes of runtime. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start a query in a linked source account. For more information, see CloudWatch cross-account observability. For a cross-account StartQuery operation, the query definition must be defined in the monitoring account.
You can have up to 20 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards.
See also: AWS API Documentation
Request Syntax
response = client.start_query(
logGroupName='string',
logGroupNames=[
'string',
],
logGroupIdentifiers=[
'string',
],
startTime=123,
endTime=123,
queryString='string',
limit=123
)
The log group on which to perform the query.
Note
A StartQuery operation must include exactly one of the following parameters: logGroupName , logGroupNames or logGroupIdentifiers .
The list of log groups to be queried. You can include up to 50 log groups.
Note
A StartQuery operation must include exactly one of the following parameters: logGroupName , logGroupNames or logGroupIdentifiers .
The list of log groups to query. You can include up to 50 log groups.
You can specify them by the log group name or ARN. If a log group that you're querying is in a source account and you're using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account.
If you specify an ARN, the ARN can't end with an asterisk (*).
A StartQuery operation must include exactly one of the following parameters: logGroupName , logGroupNames or logGroupIdentifiers .
[REQUIRED]
The beginning of the time range to query. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC .
[REQUIRED]
The end of the time range to query. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC .
[REQUIRED]
The query string to use. For more information, see CloudWatch Logs Insights Query Syntax.
fields command, only the specified fields and their values are returned. The default is 1000.dict
Response Syntax
{
'queryId': 'string'
}
Response Structure
(dict) --
queryId (string) --
The unique ID of the query.
Exceptions
CloudWatchLogs.Client.exceptions.MalformedQueryExceptionCloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.LimitExceededExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptionstop_query(**kwargs)¶Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns an error indicating that the specified query is not running.
See also: AWS API Documentation
Request Syntax
response = client.stop_query(
queryId='string'
)
[REQUIRED]
The ID number of the query to stop. To find this ID number, use DescribeQueries .
{
'success': True|False
}
Response Structure
This is true if the query was stopped by the StopQuery operation.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptiontag_log_group(**kwargs)¶Warning
The TagLogGroup operation is on the path to deprecation. We recommend that you use TagResource instead.
Adds or updates the specified tags for the specified log group.
To list the tags for a log group, use ListTagsForResource. To remove tags, use UntagResource.
For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide .
CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the aws:Resource/key-name or aws:TagKeys condition keys. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response = client.tag_log_group(
logGroupName='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The name of the log group.
[REQUIRED]
The key-value pairs to use for the tags.
None
Exceptions
CloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.InvalidParameterExceptiontag_resource(**kwargs)¶Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource. Currently, the only CloudWatch Logs resources that can be tagged are log groups and destinations.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a CloudWatch Logs resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The ARN of the resource that you're adding tags to.
The ARN format of a log group is arn:aws:logs:Region:account-id:log-group:log-group-name
The ARN format of a destination is arn:aws:logs:Region:account-id:destination:destination-name
For more information about ARN format, see CloudWatch Logs resources and operations.
[REQUIRED]
The list of key-value pairs to associate with the resource.
None
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptionCloudWatchLogs.Client.exceptions.TooManyTagsExceptiontest_metric_filter(**kwargs)¶Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern.
See also: AWS API Documentation
Request Syntax
response = client.test_metric_filter(
filterPattern='string',
logEventMessages=[
'string',
]
)
[REQUIRED]
A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event can contain timestamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.
[REQUIRED]
The log event messages to test.
dict
Response Syntax
{
'matches': [
{
'eventNumber': 123,
'eventMessage': 'string',
'extractedValues': {
'string': 'string'
}
},
]
}
Response Structure
(dict) --
matches (list) --
The matched events.
(dict) --
Represents a matched event.
eventNumber (integer) --
The event number.
eventMessage (string) --
The raw event data.
extractedValues (dict) --
The values extracted from the event data by the filter.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptionuntag_log_group(**kwargs)¶Warning
The UntagLogGroup operation is on the path to deprecation. We recommend that you use UntagResource instead.
Removes the specified tags from the specified log group.
To list the tags for a log group, use ListTagsForResource. To add tags, use TagResource.
CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the aws:Resource/key-name or aws:TagKeys condition keys.
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response = client.untag_log_group(
logGroupName='string',
tags=[
'string',
]
)
[REQUIRED]
The name of the log group.
[REQUIRED]
The tag keys. The corresponding tags are removed from the log group.
None
Exceptions
CloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionuntag_resource(**kwargs)¶Removes one or more tags from the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The ARN of the CloudWatch Logs resource that you're removing tags from.
The ARN format of a log group is arn:aws:logs:Region:account-id:log-group:log-group-name
The ARN format of a destination is arn:aws:logs:Region:account-id:destination:destination-name
For more information about ARN format, see CloudWatch Logs resources and operations.
[REQUIRED]
The list of tag keys to remove from the resource.
None
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterExceptionCloudWatchLogs.Client.exceptions.ResourceNotFoundExceptionCloudWatchLogs.Client.exceptions.ServiceUnavailableExceptionThe available paginators are:
CloudWatchLogs.Paginator.DescribeDestinationsCloudWatchLogs.Paginator.DescribeExportTasksCloudWatchLogs.Paginator.DescribeLogGroupsCloudWatchLogs.Paginator.DescribeLogStreamsCloudWatchLogs.Paginator.DescribeMetricFiltersCloudWatchLogs.Paginator.DescribeQueriesCloudWatchLogs.Paginator.DescribeResourcePoliciesCloudWatchLogs.Paginator.DescribeSubscriptionFiltersCloudWatchLogs.Paginator.FilterLogEventsCloudWatchLogs.Paginator.DescribeDestinations¶paginator = client.get_paginator('describe_destinations')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CloudWatchLogs.Client.describe_destinations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DestinationNamePrefix='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'destinations': [
{
'destinationName': 'string',
'targetArn': 'string',
'roleArn': 'string',
'accessPolicy': 'string',
'arn': 'string',
'creationTime': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
destinations (list) --
The destinations.
(dict) --
Represents a cross-account destination that receives subscription log events.
destinationName (string) --
The name of the destination.
targetArn (string) --
The Amazon Resource Name (ARN) of the physical target where the log events are delivered (for example, a Kinesis stream).
roleArn (string) --
A role for impersonation, used when delivering log events to the target.
accessPolicy (string) --
An IAM policy document that governs which Amazon Web Services accounts can create subscription filters against this destination.
arn (string) --
The ARN of this destination.
creationTime (integer) --
The creation time of the destination, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
NextToken (string) --
A token to resume pagination.
CloudWatchLogs.Paginator.DescribeExportTasks¶paginator = client.get_paginator('describe_export_tasks')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CloudWatchLogs.Client.describe_export_tasks().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
taskId='string',
statusCode='CANCELLED'|'COMPLETED'|'FAILED'|'PENDING'|'PENDING_CANCEL'|'RUNNING',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'exportTasks': [
{
'taskId': 'string',
'taskName': 'string',
'logGroupName': 'string',
'from': 123,
'to': 123,
'destination': 'string',
'destinationPrefix': 'string',
'status': {
'code': 'CANCELLED'|'COMPLETED'|'FAILED'|'PENDING'|'PENDING_CANCEL'|'RUNNING',
'message': 'string'
},
'executionInfo': {
'creationTime': 123,
'completionTime': 123
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
exportTasks (list) --
The export tasks.
(dict) --
Represents an export task.
taskId (string) --
The ID of the export task.
taskName (string) --
The name of the export task.
logGroupName (string) --
The name of the log group from which logs data was exported.
from (integer) --
The start time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC . Events with a timestamp before this time are not exported.
to (integer) --
The end time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC . Events with a timestamp later than this time are not exported.
destination (string) --
The name of the S3 bucket to which the log data was exported.
destinationPrefix (string) --
The prefix that was used as the start of Amazon S3 key for every object exported.
status (dict) --
The status of the export task.
code (string) --
The status code of the export task.
message (string) --
The status message related to the status code.
executionInfo (dict) --
Execution information about the export task.
creationTime (integer) --
The creation time of the export task, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC .
completionTime (integer) --
The completion time of the export task, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC .
NextToken (string) --
A token to resume pagination.
CloudWatchLogs.Paginator.DescribeLogGroups¶paginator = client.get_paginator('describe_log_groups')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CloudWatchLogs.Client.describe_log_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
accountIdentifiers=[
'string',
],
logGroupNamePrefix='string',
logGroupNamePattern='string',
includeLinkedAccounts=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
When includeLinkedAccounts is set to True , use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.
The prefix to match.
Note
logGroupNamePrefix and logGroupNamePattern are mutually exclusive. Only one of these parameters can be passed.
If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search. For example, if you specify Foo , log groups named FooBar , aws/Foo , and GroupFoo would match, but foo , F/o/o and Froo would not match.
Note
logGroupNamePattern and logGroupNamePrefix are mutually exclusive. Only one of these parameters can be passed.
If you are using a monitoring account, set this to True to have the operation return log groups in the accounts listed in accountIdentifiers .
If this parameter is set to true and accountIdentifiers contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.
Note
If you specify includeLinkedAccounts in your request, then metricFilterCount , retentionInDays , and storedBytes are not included in the response.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'logGroups': [
{
'logGroupName': 'string',
'creationTime': 123,
'retentionInDays': 123,
'metricFilterCount': 123,
'arn': 'string',
'storedBytes': 123,
'kmsKeyId': 'string',
'dataProtectionStatus': 'ACTIVATED'|'DELETED'|'ARCHIVED'|'DISABLED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
logGroups (list) --
The log groups.
If the retentionInDays value is not included for a log group, then that log group's events do not expire.
(dict) --
Represents a log group.
logGroupName (string) --
The name of the log group.
creationTime (integer) --
The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
retentionInDays (integer) --
The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 2192, 2557, 2922, 3288, and 3653.
To set a log group so that its log events do not expire, use DeleteRetentionPolicy.
metricFilterCount (integer) --
The number of metric filters.
arn (string) --
The Amazon Resource Name (ARN) of the log group.
storedBytes (integer) --
The number of bytes stored.
kmsKeyId (string) --
The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data.
dataProtectionStatus (string) --
Displays whether this log group has a protection policy, or whether it had one in the past. For more information, see PutDataProtectionPolicy.
NextToken (string) --
A token to resume pagination.
CloudWatchLogs.Paginator.DescribeLogStreams¶paginator = client.get_paginator('describe_log_streams')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CloudWatchLogs.Client.describe_log_streams().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
logGroupName='string',
logGroupIdentifier='string',
logStreamNamePrefix='string',
orderBy='LogStreamName'|'LastEventTime',
descending=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the log group.
Note
If you specify values for both logGroupName and logGroupIdentifier , the action returns an InvalidParameterException error.
Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.
If you specify values for both logGroupName and logGroupIdentifier , the action returns an InvalidParameterException error.
The prefix to match.
If orderBy is LastEventTime , you cannot specify this parameter.
If the value is LogStreamName , the results are ordered by log stream name. If the value is LastEventTime , the results are ordered by the event time. The default value is LogStreamName .
If you order the results by event time, you cannot specify the logStreamNamePrefix parameter.
lastEventTimestamprepresents the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds afterJan 1, 1970 00:00:00 UTC.lastEventTimestampupdates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but in rare situations might take longer.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'logStreams': [
{
'logStreamName': 'string',
'creationTime': 123,
'firstEventTimestamp': 123,
'lastEventTimestamp': 123,
'lastIngestionTime': 123,
'uploadSequenceToken': 'string',
'arn': 'string',
'storedBytes': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
logStreams (list) --
The log streams.
(dict) --
Represents a log stream, which is a sequence of log events from a single emitter of logs.
logStreamName (string) --
The name of the log stream.
creationTime (integer) --
The creation time of the stream, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC .
firstEventTimestamp (integer) --
The time of the first event, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC .
lastEventTimestamp (integer) --
The time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC . The lastEventTime value updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but in rare situations might take longer.
lastIngestionTime (integer) --
The ingestion time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC .
uploadSequenceToken (string) --
The sequence token.
arn (string) --
The Amazon Resource Name (ARN) of the log stream.
storedBytes (integer) --
The number of bytes stored.
Important: As of June 17, 2019, this parameter is no longer supported for log streams, and is always reported as zero. This change applies only to log streams. The
storedBytesparameter for log groups is not affected.
NextToken (string) --
A token to resume pagination.
CloudWatchLogs.Paginator.DescribeMetricFilters¶paginator = client.get_paginator('describe_metric_filters')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CloudWatchLogs.Client.describe_metric_filters().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
logGroupName='string',
filterNamePrefix='string',
metricName='string',
metricNamespace='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
logGroupName parameter in your request.metricNamespace parameter.metricName parameter.A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'metricFilters': [
{
'filterName': 'string',
'filterPattern': 'string',
'metricTransformations': [
{
'metricName': 'string',
'metricNamespace': 'string',
'metricValue': 'string',
'defaultValue': 123.0,
'dimensions': {
'string': 'string'
},
'unit': 'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Count'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'|'None'
},
],
'creationTime': 123,
'logGroupName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
metricFilters (list) --
The metric filters.
(dict) --
Metric filters express how CloudWatch Logs would extract metric observations from ingested log events and transform them into metric data in a CloudWatch metric.
filterName (string) --
The name of the metric filter.
filterPattern (string) --
A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event can contain timestamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.
metricTransformations (list) --
The metric transformations.
(dict) --
Indicates how to transform ingested log events to metric data in a CloudWatch metric.
metricName (string) --
The name of the CloudWatch metric.
metricNamespace (string) --
A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see Namespaces.
metricValue (string) --
The value to publish to the CloudWatch metric when a filter pattern matches a log event.
defaultValue (float) --
(Optional) The value to emit when a filter pattern does not match a log event. This value can be null.
dimensions (dict) --
The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions.
Warning
Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.
CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges.
You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.
unit (string) --
The unit to assign to the metric. If you omit this, the unit is set as None .
creationTime (integer) --
The creation time of the metric filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC .
logGroupName (string) --
The name of the log group.
NextToken (string) --
A token to resume pagination.
CloudWatchLogs.Paginator.DescribeQueries¶paginator = client.get_paginator('describe_queries')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CloudWatchLogs.Client.describe_queries().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
logGroupName='string',
status='Scheduled'|'Running'|'Complete'|'Failed'|'Cancelled'|'Timeout'|'Unknown',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Cancelled , Complete , Failed , Running , and Scheduled .A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'queries': [
{
'queryId': 'string',
'queryString': 'string',
'status': 'Scheduled'|'Running'|'Complete'|'Failed'|'Cancelled'|'Timeout'|'Unknown',
'createTime': 123,
'logGroupName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
queries (list) --
The list of queries that match the request.
(dict) --
Information about one CloudWatch Logs Insights query that matches the request in a DescribeQueries operation.
queryId (string) --
The unique ID number of this query.
queryString (string) --
The query string used in this query.
status (string) --
The status of this query. Possible values are Cancelled , Complete , Failed , Running , Scheduled , and Unknown .
createTime (integer) --
The date and time that this query was created.
logGroupName (string) --
The name of the log group scanned by this query.
NextToken (string) --
A token to resume pagination.
CloudWatchLogs.Paginator.DescribeResourcePolicies¶paginator = client.get_paginator('describe_resource_policies')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CloudWatchLogs.Client.describe_resource_policies().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'resourcePolicies': [
{
'policyName': 'string',
'policyDocument': 'string',
'lastUpdatedTime': 123
},
],
'NextToken': 'string'
}
Response Structure
The resource policies that exist in this account.
A policy enabling one or more entities to put logs to a log group in this account.
The name of the resource policy.
The details of the policy.
Timestamp showing when this policy was last updated, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC .
A token to resume pagination.
CloudWatchLogs.Paginator.DescribeSubscriptionFilters¶paginator = client.get_paginator('describe_subscription_filters')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CloudWatchLogs.Client.describe_subscription_filters().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
logGroupName='string',
filterNamePrefix='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the log group.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'subscriptionFilters': [
{
'filterName': 'string',
'logGroupName': 'string',
'filterPattern': 'string',
'destinationArn': 'string',
'roleArn': 'string',
'distribution': 'Random'|'ByLogStream',
'creationTime': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
subscriptionFilters (list) --
The subscription filters.
(dict) --
Represents a subscription filter.
filterName (string) --
The name of the subscription filter.
logGroupName (string) --
The name of the log group.
filterPattern (string) --
A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event can contain timestamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.
destinationArn (string) --
The Amazon Resource Name (ARN) of the destination.
roleArn (string) --
distribution (string) --
The method used to distribute log data to the destination, which can be either random or grouped by log stream.
creationTime (integer) --
The creation time of the subscription filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC .
NextToken (string) --
A token to resume pagination.
CloudWatchLogs.Paginator.FilterLogEvents¶paginator = client.get_paginator('filter_log_events')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CloudWatchLogs.Client.filter_log_events().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
logGroupName='string',
logGroupIdentifier='string',
logStreamNames=[
'string',
],
logStreamNamePrefix='string',
startTime=123,
endTime=123,
filterPattern='string',
interleaved=True|False,
unmask=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the log group to search.
Note
If you specify values for both logGroupName and logGroupIdentifier , the action returns an InvalidParameterException error.
Specify either the name or ARN of the log group to view log events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.
If you specify values for both logGroupName and logGroupIdentifier , the action returns an InvalidParameterException error.
Filters the results to only logs from the log streams in this list.
If you specify a value for both logStreamNamePrefix and logStreamNames , the action returns an InvalidParameterException error.
Filters the results to include only events from log streams that have names starting with this prefix.
If you specify a value for both logStreamNamePrefix and logStreamNames , but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames , the action returns an InvalidParameterException error.
Jan 1, 1970 00:00:00 UTC . Events with a timestamp before this time are not returned.Jan 1, 1970 00:00:00 UTC . Events with a timestamp later than this time are not returned.The filter pattern to use. For more information, see Filter and Pattern Syntax.
If not provided, all the events are matched.
If the value is true, the operation attempts to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on.
Important As of June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.
Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false .
To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'events': [
{
'logStreamName': 'string',
'timestamp': 123,
'message': 'string',
'ingestionTime': 123,
'eventId': 'string'
},
],
'searchedLogStreams': [
{
'logStreamName': 'string',
'searchedCompletely': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
events (list) --
The matched events.
(dict) --
Represents a matched event.
logStreamName (string) --
The name of the log stream to which this event belongs.
timestamp (integer) --
The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC .
message (string) --
The data contained in the log event.
ingestionTime (integer) --
The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC .
eventId (string) --
The ID of the event.
searchedLogStreams (list) --
Important As of May 15, 2020, this parameter is no longer supported. This parameter returns an empty list.
Indicates which log streams have been searched and whether each has been searched completely.
(dict) --
Represents the search status of a log stream.
logStreamName (string) --
The name of the log stream.
searchedCompletely (boolean) --
Indicates whether all the events in this log stream were searched.
NextToken (string) --
A token to resume pagination.