@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSLogs extends Object implements AWSLogs
AWSLogs
. Convenient method forms pass through to the corresponding overload that
takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AssociateKmsKeyResult |
associateKmsKey(AssociateKmsKeyRequest request)
Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs
query insights results in the account.
|
CancelExportTaskResult |
cancelExportTask(CancelExportTaskRequest request)
Cancels the specified export task.
|
CreateDeliveryResult |
createDelivery(CreateDeliveryRequest request)
Creates a delivery.
|
CreateExportTaskResult |
createExportTask(CreateExportTaskRequest request)
Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket.
|
CreateLogAnomalyDetectorResult |
createLogAnomalyDetector(CreateLogAnomalyDetectorRequest request)
Creates an anomaly detector that regularly scans one or more log groups and look for patterns and
anomalies in the logs.
|
CreateLogGroupResult |
createLogGroup(CreateLogGroupRequest request)
Creates a log group with the specified name.
|
CreateLogStreamResult |
createLogStream(CreateLogStreamRequest request)
Creates a log stream for the specified log group.
|
DeleteAccountPolicyResult |
deleteAccountPolicy(DeleteAccountPolicyRequest request)
Deletes a CloudWatch Logs account policy.
|
DeleteDataProtectionPolicyResult |
deleteDataProtectionPolicy(DeleteDataProtectionPolicyRequest request)
Deletes the data protection policy from the specified log group.
|
DeleteDeliveryResult |
deleteDelivery(DeleteDeliveryRequest request)
Deletes s delivery.
|
DeleteDeliveryDestinationResult |
deleteDeliveryDestination(DeleteDeliveryDestinationRequest request)
Deletes a delivery destination.
|
DeleteDeliveryDestinationPolicyResult |
deleteDeliveryDestinationPolicy(DeleteDeliveryDestinationPolicyRequest request)
Deletes a delivery destination policy.
|
DeleteDeliverySourceResult |
deleteDeliverySource(DeleteDeliverySourceRequest request)
Deletes a delivery source.
|
DeleteDestinationResult |
deleteDestination(DeleteDestinationRequest request)
Deletes the specified destination, and eventually disables all the subscription filters that publish to it.
|
DeleteLogAnomalyDetectorResult |
deleteLogAnomalyDetector(DeleteLogAnomalyDetectorRequest request)
Deletes the specified CloudWatch Logs anomaly detector.
|
DeleteLogGroupResult |
deleteLogGroup(DeleteLogGroupRequest request)
Deletes the specified log group and permanently deletes all the archived log events associated with the log
group.
|
DeleteLogStreamResult |
deleteLogStream(DeleteLogStreamRequest request)
Deletes the specified log stream and permanently deletes all the archived log events associated with the log
stream.
|
DeleteMetricFilterResult |
deleteMetricFilter(DeleteMetricFilterRequest request)
Deletes the specified metric filter.
|
DeleteQueryDefinitionResult |
deleteQueryDefinition(DeleteQueryDefinitionRequest request)
Deletes a saved CloudWatch Logs Insights query definition.
|
DeleteResourcePolicyResult |
deleteResourcePolicy(DeleteResourcePolicyRequest request)
Deletes a resource policy from this account.
|
DeleteRetentionPolicyResult |
deleteRetentionPolicy(DeleteRetentionPolicyRequest request)
Deletes the specified retention policy.
|
DeleteSubscriptionFilterResult |
deleteSubscriptionFilter(DeleteSubscriptionFilterRequest request)
Deletes the specified subscription filter.
|
DescribeAccountPoliciesResult |
describeAccountPolicies(DescribeAccountPoliciesRequest request)
Returns a list of all CloudWatch Logs account policies in the account.
|
DescribeDeliveriesResult |
describeDeliveries(DescribeDeliveriesRequest request)
Retrieves a list of the deliveries that have been created in the account.
|
DescribeDeliveryDestinationsResult |
describeDeliveryDestinations(DescribeDeliveryDestinationsRequest request)
Retrieves a list of the delivery destinations that have been created in the account.
|
DescribeDeliverySourcesResult |
describeDeliverySources(DescribeDeliverySourcesRequest request)
Retrieves a list of the delivery sources that have been created in the account.
|
DescribeDestinationsResult |
describeDestinations()
Simplified method form for invoking the DescribeDestinations operation.
|
DescribeDestinationsResult |
describeDestinations(DescribeDestinationsRequest request)
Lists all your destinations.
|
DescribeExportTasksResult |
describeExportTasks(DescribeExportTasksRequest request)
Lists the specified export tasks.
|
DescribeLogGroupsResult |
describeLogGroups()
Simplified method form for invoking the DescribeLogGroups operation.
|
DescribeLogGroupsResult |
describeLogGroups(DescribeLogGroupsRequest request)
Lists the specified log groups.
|
DescribeLogStreamsResult |
describeLogStreams(DescribeLogStreamsRequest request)
Lists the log streams for the specified log group.
|
DescribeMetricFiltersResult |
describeMetricFilters(DescribeMetricFiltersRequest request)
Lists the specified metric filters.
|
DescribeQueriesResult |
describeQueries(DescribeQueriesRequest request)
Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this
account.
|
DescribeQueryDefinitionsResult |
describeQueryDefinitions(DescribeQueryDefinitionsRequest request)
This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions.
|
DescribeResourcePoliciesResult |
describeResourcePolicies(DescribeResourcePoliciesRequest request)
Lists the resource policies in this account.
|
DescribeSubscriptionFiltersResult |
describeSubscriptionFilters(DescribeSubscriptionFiltersRequest request)
Lists the subscription filters for the specified log group.
|
DisassociateKmsKeyResult |
disassociateKmsKey(DisassociateKmsKeyRequest request)
Disassociates the specified KMS key from the specified log group or from all CloudWatch Logs Insights query
results in the account.
|
FilterLogEventsResult |
filterLogEvents(FilterLogEventsRequest request)
Lists log events from the specified log group.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetDataProtectionPolicyResult |
getDataProtectionPolicy(GetDataProtectionPolicyRequest request)
Returns information about a log group data protection policy.
|
GetDeliveryResult |
getDelivery(GetDeliveryRequest request)
Returns complete information about one logical delivery.
|
GetDeliveryDestinationResult |
getDeliveryDestination(GetDeliveryDestinationRequest request)
Retrieves complete information about one delivery destination.
|
GetDeliveryDestinationPolicyResult |
getDeliveryDestinationPolicy(GetDeliveryDestinationPolicyRequest request)
Retrieves the delivery destination policy assigned to the delivery destination that you specify.
|
GetDeliverySourceResult |
getDeliverySource(GetDeliverySourceRequest request)
Retrieves complete information about one delivery source.
|
GetLogAnomalyDetectorResult |
getLogAnomalyDetector(GetLogAnomalyDetectorRequest request)
Retrieves information about the log anomaly detector that you specify.
|
GetLogEventsResult |
getLogEvents(GetLogEventsRequest request)
Lists log events from the specified log stream.
|
GetLogGroupFieldsResult |
getLogGroupFields(GetLogGroupFieldsRequest request)
Returns a list of the fields that are included in log events in the specified log group.
|
GetLogRecordResult |
getLogRecord(GetLogRecordRequest request)
Retrieves all of the fields and values of a single log event.
|
GetQueryResultsResult |
getQueryResults(GetQueryResultsRequest request)
Returns the results from the specified query.
|
ListAnomaliesResult |
listAnomalies(ListAnomaliesRequest request)
Returns a list of anomalies that log anomaly detectors have found.
|
ListLogAnomalyDetectorsResult |
listLogAnomalyDetectors(ListLogAnomalyDetectorsRequest request)
Retrieves a list of the log anomaly detectors in the account.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Displays the tags associated with a CloudWatch Logs resource.
|
ListTagsLogGroupResult |
listTagsLogGroup(ListTagsLogGroupRequest request)
Deprecated.
|
PutAccountPolicyResult |
putAccountPolicy(PutAccountPolicyRequest request)
Creates an account-level data protection policy or subscription filter policy that applies to all log groups or a
subset of log groups in the account.
|
PutDataProtectionPolicyResult |
putDataProtectionPolicy(PutDataProtectionPolicyRequest request)
Creates a data protection policy for the specified log group.
|
PutDeliveryDestinationResult |
putDeliveryDestination(PutDeliveryDestinationRequest request)
Creates or updates a logical delivery destination.
|
PutDeliveryDestinationPolicyResult |
putDeliveryDestinationPolicy(PutDeliveryDestinationPolicyRequest request)
Creates and assigns an IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a
specified destination in this account.
|
PutDeliverySourceResult |
putDeliverySource(PutDeliverySourceRequest request)
Creates or updates a logical delivery source.
|
PutDestinationResult |
putDestination(PutDestinationRequest request)
Creates or updates a destination.
|
PutDestinationPolicyResult |
putDestinationPolicy(PutDestinationPolicyRequest request)
Creates or updates an access policy associated with an existing destination.
|
PutLogEventsResult |
putLogEvents(PutLogEventsRequest request)
Uploads a batch of log events to the specified log stream.
|
PutMetricFilterResult |
putMetricFilter(PutMetricFilterRequest request)
Creates or updates a metric filter and associates it with the specified log group.
|
PutQueryDefinitionResult |
putQueryDefinition(PutQueryDefinitionRequest request)
Creates or updates a query definition for CloudWatch Logs Insights.
|
PutResourcePolicyResult |
putResourcePolicy(PutResourcePolicyRequest request)
Creates or updates a resource policy allowing other Amazon Web Services services to put log events to this
account, such as Amazon Route 53.
|
PutRetentionPolicyResult |
putRetentionPolicy(PutRetentionPolicyRequest request)
Sets the retention of the specified log group.
|
PutSubscriptionFilterResult |
putSubscriptionFilter(PutSubscriptionFilterRequest request)
Creates or updates a subscription filter and associates it with the specified log group.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://logs.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AWSLogs.setEndpoint(String) , sets the regional endpoint for this client's service
calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartQueryResult |
startQuery(StartQueryRequest request)
Schedules a query of a log group using CloudWatch Logs Insights.
|
StopQueryResult |
stopQuery(StopQueryRequest request)
Stops a CloudWatch Logs Insights query that is in progress.
|
TagLogGroupResult |
tagLogGroup(TagLogGroupRequest request)
Deprecated.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource.
|
TestMetricFilterResult |
testMetricFilter(TestMetricFilterRequest request)
Tests the filter pattern of a metric filter against a sample of log event messages.
|
UntagLogGroupResult |
untagLogGroup(UntagLogGroupRequest request)
Deprecated.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes one or more tags from the specified resource.
|
UpdateAnomalyResult |
updateAnomaly(UpdateAnomalyRequest request)
Use this operation to suppress anomaly detection for a specified anomaly or pattern.
|
UpdateLogAnomalyDetectorResult |
updateLogAnomalyDetector(UpdateLogAnomalyDetectorRequest request)
Updates an existing log anomaly detector.
|
public void setEndpoint(String endpoint)
AWSLogs
Callers can pass in just the endpoint (ex: "logs.us-east-1.amazonaws.com") or a full URL, including the protocol
(ex: "https://logs.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from
this client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint
in interface AWSLogs
endpoint
- The endpoint (ex: "logs.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"https://logs.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate
with.public void setRegion(Region region)
AWSLogs
AWSLogs.setEndpoint(String)
, sets the regional endpoint for this client's service
calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion
in interface AWSLogs
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
public AssociateKmsKeyResult associateKmsKey(AssociateKmsKeyRequest request)
AWSLogs
Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs query insights results in the account.
When you use AssociateKmsKey
, you specify either the logGroupName
parameter or the
resourceIdentifier
parameter. You can't specify both of those parameters in the same operation.
Specify the logGroupName
parameter to cause all log events stored in the log group to be encrypted
with that key. Only the log events ingested after the key is associated are encrypted with that key.
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 key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
Associating a key with a log group does not cause the results of queries of that log group to be encrypted with
that key. To have query results encrypted with a KMS key, you must use an AssociateKmsKey
operation
with the resourceIdentifier
parameter that specifies a query-result
resource.
Specify the resourceIdentifier
parameter with a query-result
resource, to use that key
to encrypt the stored results of all future StartQuery
operations in the account. The response from a GetQueryResults operation will still return the query results in plain text.
Even if you have not associated a key with your query results, the query results are encrypted when stored, using the default CloudWatch Logs method.
If you run a query from a monitoring account that queries logs in a source account, the query results key from the monitoring account, if any, is used.
If you delete the key that is used to encrypt log events or log group query results, then all the associated stored log events or query results that were encrypted with that key will be unencryptable and unusable.
CloudWatch Logs supports only symmetric KMS keys. Do not use an associate an asymmetric KMS key with your log group or query results. 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.
associateKmsKey
in interface AWSLogs
public CancelExportTaskResult cancelExportTask(CancelExportTaskRequest request)
AWSLogs
Cancels the specified export task.
The task must be in the PENDING
or RUNNING
state.
cancelExportTask
in interface AWSLogs
public CreateDeliveryResult createDelivery(CreateDeliveryRequest request)
AWSLogs
Creates a delivery. A delivery is a connection between a logical delivery source and a logical delivery destination that you have already created.
Only some Amazon Web Services services support being configured as a delivery source using this operation. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.
A delivery destination can represent a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Firehose.
To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:
Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource.
Create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination.
If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
Use CreateDelivery
to create a delivery by pairing exactly one delivery source and one
delivery destination.
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
You can't update an existing delivery. You can only create and delete deliveries.
createDelivery
in interface AWSLogs
public CreateExportTaskResult createExportTask(CreateExportTaskRequest request)
AWSLogs
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.
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.
createExportTask
in interface AWSLogs
public CreateLogAnomalyDetectorResult createLogAnomalyDetector(CreateLogAnomalyDetectorRequest request)
AWSLogs
Creates an anomaly detector that regularly scans one or more log groups and look for patterns and anomalies in the logs.
An anomaly detector can help surface issues by automatically discovering anomalies in your log event traffic. An anomaly detector uses machine learning algorithms to scan log events and find patterns. A pattern is a shared text structure that recurs among your log fields. Patterns provide a useful tool for analyzing large sets of logs because a large number of log events can often be compressed into a few patterns.
The anomaly detector uses pattern recognition to find anomalies
, which are unusual log events. It
uses the evaluationFrequency
to compare current log events and patterns with trained baselines.
Fields within a pattern are called tokens. Fields that vary within a pattern, such as a request ID or
timestamp, are referred to as dynamic tokens and represented by <*>
.
The following is an example of a pattern:
[INFO] Request time: <*> ms
This pattern represents log events like [INFO] Request time: 327 ms
and other similar log events
that differ only by the number, in this csse 327. When the pattern is displayed, the different numbers are
replaced by <*>
Any parts of log events that are masked as sensitive data are not scanned for anomalies. For more information about masking sensitive data, see Help protect sensitive log data with masking.
createLogAnomalyDetector
in interface AWSLogs
public CreateLogGroupResult createLogGroup(CreateLogGroupRequest request)
AWSLogs
Creates a log group with the specified name. You can create up to 1,000,000 log groups per Region per account.
You must use the following guidelines when naming a log group:
Log group names must be unique within a Region for an Amazon Web Services account.
Log group names can be between 1 and 512 characters long.
Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), '.' (period), and '#' (number sign)
Log group names can't start with the string aws/
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 key does not exist or the KMS key is
disabled, you receive an InvalidParameterException
error.
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.
createLogGroup
in interface AWSLogs
public CreateLogStreamResult createLogStream(CreateLogStreamRequest request)
AWSLogs
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:
Log stream names must be unique within the log group.
Log stream names can be between 1 and 512 characters long.
Don't use ':' (colon) or '*' (asterisk) characters.
createLogStream
in interface AWSLogs
public DeleteAccountPolicyResult deleteAccountPolicy(DeleteAccountPolicyRequest request)
AWSLogs
Deletes a CloudWatch Logs account policy. This stops the policy from applying to all log groups or a subset of log groups in the account. Log-group level policies will still be in effect.
To use this operation, you must be signed on with the correct permissions depending on the type of policy that you are deleting.
To delete a data protection policy, you must have the logs:DeleteDataProtectionPolicy
and
logs:DeleteAccountPolicy
permissions.
To delete a subscription filter policy, you must have the logs:DeleteSubscriptionFilter
and
logs:DeleteAccountPolicy
permissions.
deleteAccountPolicy
in interface AWSLogs
public DeleteDataProtectionPolicyResult deleteDataProtectionPolicy(DeleteDataProtectionPolicyRequest request)
AWSLogs
Deletes the data protection policy from the specified log group.
For more information about data protection policies, see PutDataProtectionPolicy.
deleteDataProtectionPolicy
in interface AWSLogs
public DeleteDeliveryResult deleteDelivery(DeleteDeliveryRequest request)
AWSLogs
Deletes s delivery. A delivery is a connection between a logical delivery source and a logical delivery destination. Deleting a delivery only deletes the connection between the delivery source and delivery destination. It does not delete the delivery destination or the delivery source.
deleteDelivery
in interface AWSLogs
public DeleteDeliveryDestinationResult deleteDeliveryDestination(DeleteDeliveryDestinationRequest request)
AWSLogs
Deletes a delivery destination. A delivery is a connection between a logical delivery source and a logical delivery destination.
You can't delete a delivery destination if any current deliveries are associated with it. To find whether any
deliveries are associated with this delivery destination, use the DescribeDeliveries operation and check the deliveryDestinationArn
field in the results.
deleteDeliveryDestination
in interface AWSLogs
public DeleteDeliveryDestinationPolicyResult deleteDeliveryDestinationPolicy(DeleteDeliveryDestinationPolicyRequest request)
AWSLogs
Deletes a delivery destination policy. For more information about these policies, see PutDeliveryDestinationPolicy.
deleteDeliveryDestinationPolicy
in interface AWSLogs
public DeleteDeliverySourceResult deleteDeliverySource(DeleteDeliverySourceRequest request)
AWSLogs
Deletes a delivery source. A delivery is a connection between a logical delivery source and a logical delivery destination.
You can't delete a delivery source if any current deliveries are associated with it. To find whether any
deliveries are associated with this delivery source, use the DescribeDeliveries operation and check the deliverySourceName
field in the results.
deleteDeliverySource
in interface AWSLogs
public DeleteDestinationResult deleteDestination(DeleteDestinationRequest request)
AWSLogs
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.
deleteDestination
in interface AWSLogs
public DeleteLogAnomalyDetectorResult deleteLogAnomalyDetector(DeleteLogAnomalyDetectorRequest request)
AWSLogs
Deletes the specified CloudWatch Logs anomaly detector.
deleteLogAnomalyDetector
in interface AWSLogs
public DeleteLogGroupResult deleteLogGroup(DeleteLogGroupRequest request)
AWSLogs
Deletes the specified log group and permanently deletes all the archived log events associated with the log group.
deleteLogGroup
in interface AWSLogs
public DeleteLogStreamResult deleteLogStream(DeleteLogStreamRequest request)
AWSLogs
Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.
deleteLogStream
in interface AWSLogs
public DeleteMetricFilterResult deleteMetricFilter(DeleteMetricFilterRequest request)
AWSLogs
Deletes the specified metric filter.
deleteMetricFilter
in interface AWSLogs
public DeleteQueryDefinitionResult deleteQueryDefinition(DeleteQueryDefinitionRequest request)
AWSLogs
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.
deleteQueryDefinition
in interface AWSLogs
public DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest request)
AWSLogs
Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account.
deleteResourcePolicy
in interface AWSLogs
public DeleteRetentionPolicyResult deleteRetentionPolicy(DeleteRetentionPolicyRequest request)
AWSLogs
Deletes the specified retention policy.
Log events do not expire if they belong to log groups without a retention policy.
deleteRetentionPolicy
in interface AWSLogs
public DeleteSubscriptionFilterResult deleteSubscriptionFilter(DeleteSubscriptionFilterRequest request)
AWSLogs
Deletes the specified subscription filter.
deleteSubscriptionFilter
in interface AWSLogs
public DescribeAccountPoliciesResult describeAccountPolicies(DescribeAccountPoliciesRequest request)
AWSLogs
Returns a list of all CloudWatch Logs account policies in the account.
describeAccountPolicies
in interface AWSLogs
public DescribeDeliveriesResult describeDeliveries(DescribeDeliveriesRequest request)
AWSLogs
Retrieves a list of the deliveries that have been created in the account.
A delivery is a connection between a delivery source and a delivery destination .
A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in Enable logging from Amazon Web Services services.
describeDeliveries
in interface AWSLogs
public DescribeDeliveryDestinationsResult describeDeliveryDestinations(DescribeDeliveryDestinationsRequest request)
AWSLogs
Retrieves a list of the delivery destinations that have been created in the account.
describeDeliveryDestinations
in interface AWSLogs
public DescribeDeliverySourcesResult describeDeliverySources(DescribeDeliverySourcesRequest request)
AWSLogs
Retrieves a list of the delivery sources that have been created in the account.
describeDeliverySources
in interface AWSLogs
public DescribeDestinationsResult describeDestinations(DescribeDestinationsRequest request)
AWSLogs
Lists all your destinations. The results are ASCII-sorted by destination name.
describeDestinations
in interface AWSLogs
public DescribeDestinationsResult describeDestinations()
AWSLogs
describeDestinations
in interface AWSLogs
AWSLogs.describeDestinations(DescribeDestinationsRequest)
public DescribeExportTasksResult describeExportTasks(DescribeExportTasksRequest request)
AWSLogs
Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.
describeExportTasks
in interface AWSLogs
public DescribeLogGroupsResult describeLogGroups(DescribeLogGroupsRequest request)
AWSLogs
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.
describeLogGroups
in interface AWSLogs
public DescribeLogGroupsResult describeLogGroups()
AWSLogs
describeLogGroups
in interface AWSLogs
AWSLogs.describeLogGroups(DescribeLogGroupsRequest)
public DescribeLogStreamsResult describeLogStreams(DescribeLogStreamsRequest request)
AWSLogs
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.
You can specify the log group to search by using either logGroupIdentifier
or
logGroupName
. You must include one of these two parameters, but you can't include both.
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.
describeLogStreams
in interface AWSLogs
public DescribeMetricFiltersResult describeMetricFilters(DescribeMetricFiltersRequest request)
AWSLogs
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.
describeMetricFilters
in interface AWSLogs
public DescribeQueriesResult describeQueries(DescribeQueriesRequest request)
AWSLogs
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.
describeQueries
in interface AWSLogs
public DescribeQueryDefinitionsResult describeQueryDefinitions(DescribeQueryDefinitionsRequest request)
AWSLogs
This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions. You can retrieve query definitions from the current account or from a source account that is linked to the current account.
You can use the queryDefinitionNamePrefix
parameter to limit the results to only the query
definitions that have names that start with a certain string.
describeQueryDefinitions
in interface AWSLogs
public DescribeResourcePoliciesResult describeResourcePolicies(DescribeResourcePoliciesRequest request)
AWSLogs
Lists the resource policies in this account.
describeResourcePolicies
in interface AWSLogs
public DescribeSubscriptionFiltersResult describeSubscriptionFilters(DescribeSubscriptionFiltersRequest request)
AWSLogs
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.
describeSubscriptionFilters
in interface AWSLogs
public DisassociateKmsKeyResult disassociateKmsKey(DisassociateKmsKeyRequest request)
AWSLogs
Disassociates the specified KMS key from the specified log group or from all CloudWatch Logs Insights query results in the account.
When you use DisassociateKmsKey
, you specify either the logGroupName
parameter or the
resourceIdentifier
parameter. You can't specify both of those parameters in the same operation.
Specify the logGroupName
parameter to stop using the KMS key to encrypt future log events ingested
and stored in the log group. Instead, they will be encrypted with the default CloudWatch Logs method. The log
events that were ingested while the key was associated with the log group are still encrypted with that key.
Therefore, CloudWatch Logs will need permissions for the key whenever that data is accessed.
Specify the resourceIdentifier
parameter with the query-result
resource to stop using
the KMS key to encrypt the results of all future StartQuery
operations in the account. They will instead be encrypted with the default CloudWatch Logs method. The results
from queries that ran while the key was associated with the account are still encrypted with that key. Therefore,
CloudWatch Logs will need permissions for the key whenever that data is accessed.
It can take up to 5 minutes for this operation to take effect.
disassociateKmsKey
in interface AWSLogs
public FilterLogEventsResult filterLogEvents(FilterLogEventsRequest request)
AWSLogs
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.
You can specify the log group to search by using either logGroupIdentifier
or
logGroupName
. You must include one of these two parameters, but you can't include both.
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.
filterLogEvents
in interface AWSLogs
public GetDataProtectionPolicyResult getDataProtectionPolicy(GetDataProtectionPolicyRequest request)
AWSLogs
Returns information about a log group data protection policy.
getDataProtectionPolicy
in interface AWSLogs
public GetDeliveryResult getDelivery(GetDeliveryRequest request)
AWSLogs
Returns complete information about one logical delivery. A delivery is a connection between a delivery source and a delivery destination .
A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in Enable logging from Amazon Web Services services.
You need to specify the delivery id
in this operation. You can find the IDs of the deliveries in
your account with the DescribeDeliveries operation.
getDelivery
in interface AWSLogs
public GetDeliveryDestinationResult getDeliveryDestination(GetDeliveryDestinationRequest request)
AWSLogs
Retrieves complete information about one delivery destination.
getDeliveryDestination
in interface AWSLogs
public GetDeliveryDestinationPolicyResult getDeliveryDestinationPolicy(GetDeliveryDestinationPolicyRequest request)
AWSLogs
Retrieves the delivery destination policy assigned to the delivery destination that you specify. For more information about delivery destinations and their policies, see PutDeliveryDestinationPolicy.
getDeliveryDestinationPolicy
in interface AWSLogs
public GetDeliverySourceResult getDeliverySource(GetDeliverySourceRequest request)
AWSLogs
Retrieves complete information about one delivery source.
getDeliverySource
in interface AWSLogs
public GetLogAnomalyDetectorResult getLogAnomalyDetector(GetLogAnomalyDetectorRequest request)
AWSLogs
Retrieves information about the log anomaly detector that you specify.
getLogAnomalyDetector
in interface AWSLogs
public GetLogEventsResult getLogEvents(GetLogEventsRequest request)
AWSLogs
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.
You can specify the log group to search by using either logGroupIdentifier
or
logGroupName
. You must include one of these two parameters, but you can't include both.
getLogEvents
in interface AWSLogs
public GetLogGroupFieldsResult getLogGroupFields(GetLogGroupFieldsRequest request)
AWSLogs
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.
You can specify the log group to search by using either logGroupIdentifier
or
logGroupName
. You must specify one of these parameters, but you can't specify both.
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.
getLogGroupFields
in interface AWSLogs
public GetLogRecordResult getLogRecord(GetLogRecordRequest request)
AWSLogs
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
.
getLogRecord
in interface AWSLogs
public GetQueryResultsResult getQueryResults(GetQueryResultsRequest request)
AWSLogs
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.
GetQueryResults
does not start running a query. To run a query, use StartQuery.
For more information about how long results of previous queries are available, see CloudWatch Logs
quotas.
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.
getQueryResults
in interface AWSLogs
public ListAnomaliesResult listAnomalies(ListAnomaliesRequest request)
AWSLogs
Returns a list of anomalies that log anomaly detectors have found. For details about the structure format of each anomaly object that is returned, see the example in this section.
listAnomalies
in interface AWSLogs
public ListLogAnomalyDetectorsResult listLogAnomalyDetectors(ListLogAnomalyDetectorsRequest request)
AWSLogs
Retrieves a list of the log anomaly detectors in the account.
listLogAnomalyDetectors
in interface AWSLogs
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSLogs
Displays the tags associated with a CloudWatch Logs resource. Currently, log groups and destinations support tagging.
listTagsForResource
in interface AWSLogs
@Deprecated public ListTagsLogGroupResult listTagsLogGroup(ListTagsLogGroupRequest request)
AWSLogs
The ListTagsLogGroup operation is on the path to deprecation. We recommend that you use ListTagsForResource instead.
Lists the tags for the specified log group.
listTagsLogGroup
in interface AWSLogs
public PutAccountPolicyResult putAccountPolicy(PutAccountPolicyRequest request)
AWSLogs
Creates an account-level data protection policy or subscription filter policy that applies to all log groups or a subset of log groups in the account.
Data protection policy
A data protection policy can help safeguard sensitive data that's ingested by your log groups by auditing and masking the sensitive log data. Each account can have only one account-level data protection policy.
Sensitive data is detected and masked when it is ingested into a log group. When you set a data protection policy, log events ingested into the log groups before that time are not masked.
If you use PutAccountPolicy
to create a data protection policy for your whole account, it applies to
both existing log groups and all log groups that are created later in this account. The account-level policy is
applied to existing log groups with eventual consistency. It might take up to 5 minutes before sensitive data in
existing log groups begins to be 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.
To use the PutAccountPolicy
operation for a data protection policy, you must be signed on with the
logs:PutDataProtectionPolicy
and logs:PutAccountPolicy
permissions.
The PutAccountPolicy
operation applies to all log groups in the account. You can use PutDataProtectionPolicy to create a data protection policy that applies to just one log group. If a log
group has its own data protection policy and the account also has an account-level data protection policy, then
the two policies are cumulative. Any sensitive term specified in either policy is masked.
Subscription filter policy
A subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other Amazon Web Services services. Account-level subscription filter policies apply to both existing log groups and log groups that are created later in this account. Supported destinations are Kinesis Data Streams, Firehose, and Lambda. 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:
An Kinesis Data Streams data stream in the same account as the subscription policy, for same-account delivery.
An Firehose data stream in the same account as the subscription policy, for same-account delivery.
A Lambda function in the same account as the subscription policy, for same-account delivery.
A logical destination in a different account created with PutDestination, for cross-account delivery. Kinesis Data Streams and Firehose are supported as logical destinations.
Each account can have one account-level subscription filter policy. If you are updating an existing filter, you
must specify the correct name in PolicyName
. To perform a PutAccountPolicy
subscription
filter operation for any destination except a Lambda function, you must also have the iam:PassRole
permission.
putAccountPolicy
in interface AWSLogs
public PutDataProtectionPolicyResult putDataProtectionPolicy(PutDataProtectionPolicyRequest request)
AWSLogs
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.
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.
The PutDataProtectionPolicy
operation applies to only the specified log group. You can also use
PutAccountPolicy to create an account-level data protection policy that applies to all log groups in the
account, including both existing log groups and log groups that are created level. If a log group has its own
data protection policy and the account also has an account-level data protection policy, then the two policies
are cumulative. Any sensitive term specified in either policy is masked.
putDataProtectionPolicy
in interface AWSLogs
public PutDeliveryDestinationResult putDeliveryDestination(PutDeliveryDestinationRequest request)
AWSLogs
Creates or updates a logical delivery destination. A delivery destination is an Amazon Web Services resource that represents an Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, and Firehose are supported as logs delivery destinations.
To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:
Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource.
Use PutDeliveryDestination
to create a delivery destination, which is a logical object that
represents the actual delivery destination.
If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
Use CreateDelivery
to create a delivery by pairing exactly one delivery source and one
delivery destination. For more information, see CreateDelivery.
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
Only some Amazon Web Services services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.
If you use this operation to update an existing delivery destination, all the current delivery destination parameters are overwritten with the new parameter values that you specify.
putDeliveryDestination
in interface AWSLogs
public PutDeliveryDestinationPolicyResult putDeliveryDestinationPolicy(PutDeliveryDestinationPolicyRequest request)
AWSLogs
Creates and assigns an IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account. To configure the delivery of logs from an Amazon Web Services service in another account to a logs delivery destination in the current account, you must do the following:
Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource.
Create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination.
Use this operation in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
Create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery.
Only some Amazon Web Services services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.
The contents of the policy must include two statements. One statement enables general logs delivery, and the other allows delivery to the chosen destination. See the examples for the needed policies.
putDeliveryDestinationPolicy
in interface AWSLogs
public PutDeliverySourceResult putDeliverySource(PutDeliverySourceRequest request)
AWSLogs
Creates or updates a logical delivery source. A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose.
To configure logs delivery between a delivery destination and an Amazon Web Services service that is supported as a delivery source, you must do the following:
Use PutDeliverySource
to create a delivery source, which is a logical object that represents the
resource that is actually sending the logs.
Use PutDeliveryDestination
to create a delivery destination, which is a logical object that
represents the actual delivery destination. For more information, see PutDeliveryDestination.
If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
Use CreateDelivery
to create a delivery by pairing exactly one delivery source and one
delivery destination. For more information, see CreateDelivery.
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
Only some Amazon Web Services services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.
If you use this operation to update an existing delivery source, all the current delivery source parameters are overwritten with the new parameter values that you specify.
putDeliverySource
in interface AWSLogs
public PutDestinationResult putDestination(PutDestinationRequest request)
AWSLogs
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.
putDestination
in interface AWSLogs
public PutDestinationPolicyResult putDestinationPolicy(PutDestinationPolicyRequest request)
AWSLogs
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.
putDestinationPolicy
in interface AWSLogs
public PutLogEventsResult putLogEvents(PutLogEventsRequest request)
AWSLogs
Uploads a batch of log events to the specified log stream.
The sequence token is now ignored in PutLogEvents
actions. PutLogEvents
actions are
always accepted and never return InvalidSequenceTokenException
or
DataAlreadyAcceptedException
even if the sequence token is not valid. You can use parallel
PutLogEvents
actions on the same log stream.
The batch of events must satisfy the following constraints:
The maximum batch size is 1,048,576 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.
None of the log events in the batch can be more than 2 hours in the future.
None of the log events in the batch can be more than 14 days in the past. Also, none of the log events can be from earlier than the retention period of the log group.
The log events in the batch must be in chronological order by their timestamp. The timestamp is the time that the
event occurred, expressed as the number of milliseconds after 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
.)
A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.
Each log event can be no larger than 256 KB.
The maximum number of log events in a batch is 10,000.
The quota of five requests per second per log stream has been removed. Instead, PutLogEvents
actions
are throttled based on a per-second per-account quota. You can request an increase to the per-second throttling
quota by using the Service Quotas service.
If a call to PutLogEvents
returns "UnrecognizedClientException" the most likely cause is a non-valid
Amazon Web Services access key ID or secret key.
putLogEvents
in interface AWSLogs
public PutMetricFilterResult putMetricFilter(PutMetricFilterRequest request)
AWSLogs
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.
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 might disable a metric filter if it generates 1,000 different name/value pairs for your specified dimensions within one hour.
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.
putMetricFilter
in interface AWSLogs
public PutQueryDefinitionResult putQueryDefinition(PutQueryDefinitionRequest request)
AWSLogs
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.
putQueryDefinition
in interface AWSLogs
public PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest request)
AWSLogs
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.
putResourcePolicy
in interface AWSLogs
public PutRetentionPolicyResult putRetentionPolicy(PutRetentionPolicyRequest request)
AWSLogs
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.
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.
When log events reach their retention setting they are marked for deletion. After they are marked for deletion,
they do not add to your archival storage costs anymore, even if they are not actually deleted until later. These
log events marked for deletion are also not included when you use an API to retrieve the storedBytes
value to see how many bytes a log group is storing.
putRetentionPolicy
in interface AWSLogs
public PutSubscriptionFilterResult putSubscriptionFilter(PutSubscriptionFilterRequest request)
AWSLogs
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:
An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery.
A logical destination created with PutDestination that belongs to a different account, for cross-account delivery. We currently support Kinesis Data Streams and Firehose as logical destinations.
An Amazon Kinesis Data Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.
An Lambda function that belongs to the same account as the subscription filter, for same-account delivery.
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 for any destination except a Lambda function, you must
also have the iam:PassRole
permission.
putSubscriptionFilter
in interface AWSLogs
public StartQueryResult startQuery(StartQueryRequest request)
AWSLogs
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.
After you run a query using StartQuery
, the query results are stored by CloudWatch Logs. You can use
GetQueryResults to retrieve the results of a query, using the queryId
that
StartQuery
returns.
If you have associated a KMS key with the query results in this account, then StartQuery uses that key to encrypt the results when it stores them. If no key is associated with query results, the query results are encrypted with the default CloudWatch Logs encryption method.
Queries time out after 60 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 30 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards.
startQuery
in interface AWSLogs
public StopQueryResult stopQuery(StopQueryRequest request)
AWSLogs
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.
stopQuery
in interface AWSLogs
@Deprecated public TagLogGroupResult tagLogGroup(TagLogGroupRequest request)
AWSLogs
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.
tagLogGroup
in interface AWSLogs
public TagResourceResult tagResource(TagResourceRequest request)
AWSLogs
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.
tagResource
in interface AWSLogs
public TestMetricFilterResult testMetricFilter(TestMetricFilterRequest request)
AWSLogs
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.
testMetricFilter
in interface AWSLogs
@Deprecated public UntagLogGroupResult untagLogGroup(UntagLogGroupRequest request)
AWSLogs
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.
untagLogGroup
in interface AWSLogs
public UntagResourceResult untagResource(UntagResourceRequest request)
AWSLogs
Removes one or more tags from the specified resource.
untagResource
in interface AWSLogs
public UpdateAnomalyResult updateAnomaly(UpdateAnomalyRequest request)
AWSLogs
Use this operation to suppress anomaly detection for a specified anomaly or pattern. If you suppress an anomaly, CloudWatch Logs won’t report new occurrences of that anomaly and won't update that anomaly with new data. If you suppress a pattern, CloudWatch Logs won’t report any anomalies related to that pattern.
You must specify either anomalyId
or patternId
, but you can't specify both parameters
in the same operation.
If you have previously used this operation to suppress detection of a pattern or anomaly, you can use it again to
cause CloudWatch Logs to end the suppression. To do this, use this operation and specify the anomaly or pattern
to stop suppressing, and omit the suppressionType
and suppressionPeriod
parameters.
updateAnomaly
in interface AWSLogs
public UpdateLogAnomalyDetectorResult updateLogAnomalyDetector(UpdateLogAnomalyDetectorRequest request)
AWSLogs
Updates an existing log anomaly detector.
updateLogAnomalyDetector
in interface AWSLogs
public void shutdown()
AWSLogs
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSLogs
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AWSLogs
request
- The originally executed request.